class DataEntityRow

Plugin which displays entities as raw data.

Plugin annotation


@Plugin(
  id = "data_entity",
  module = "rest",
  title = @Translation("Entity"),
  help = @Translation("Use entities as row data."),
  display_types = {"data"}
)

Hierarchy

Expanded class hierarchy of DataEntityRow

Related topics

File

drupal/core/modules/rest/lib/Drupal/rest/Plugin/views/row/DataEntityRow.php, line 28
Contains \Drupal\rest\Plugin\views\row\DataEntityRow.

Namespace

Drupal\rest\Plugin\views\row
View source
class DataEntityRow extends RowPluginBase {

  /**
   * Overrides \Drupal\views\Plugin\Plugin::$usesOptions.
   */
  protected $usesOptions = FALSE;

  /**
   * Overrides \Drupal\views\Plugin\views\row\RowPluginBase::render().
   */
  public function render($row) {
    return $row->_entity;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContainerFactoryPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
DataEntityRow::$usesOptions protected property Overrides \Drupal\views\Plugin\Plugin::$usesOptions. Overrides RowPluginBase::$usesOptions
DataEntityRow::render public function Overrides \Drupal\views\Plugin\views\row\RowPluginBase::render(). Overrides RowPluginBase::render
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::init public function Initialize the plugin. 8
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to it's output. 3
RowPluginBase::buildOptionsForm public function Provide a form for setting options. Overrides PluginBase::buildOptionsForm 8
RowPluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides PluginBase::defineOptions 8
RowPluginBase::pre_render function Allow the style to do stuff before each row is rendered. 4
RowPluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query
RowPluginBase::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides PluginBase::submitOptionsForm 1
RowPluginBase::usesFields function Returns the usesFields property. 3
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 1