class RowTest

Provides a general test row plugin.

Plugin annotation


@Plugin(
  id = "test_row",
  title = @Translation("Test row plugin"),
  help = @Translation("Provides a generic row test plugin."),
  theme = "views_view_row_test",
  display_types = {"normal", "test"}
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements PluginInspectionInterface
- class \Drupal\Core\Plugin\ContainerFactoryPluginBase implements ContainerFactoryPluginInterface
  - class \Drupal\views\Plugin\views\PluginBase
    class \Drupal\views\Plugin\views\row\RowPluginBase
    class \Drupal\views_test_data\Plugin\views\row\RowTest

Expanded class hierarchy of RowTest

File

drupal/core/modules/views/tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/row/RowTest.php, line 27: Definition of Drupal\views_test_data\Plugin\views\row\RowTest.

Namespace

Drupal\views_test_data\Plugin\views\row

View source

class RowTest extends RowPluginBase {

  /**
   * A string which will be output when the view is rendered.
   *
   * @var string
   */
  public $output;

  /**
   * Overrides Drupal\views\Plugin\views\row\RowPluginBase::defineOptions().
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['test_option'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Overrides Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['test_option'] = array(
      '#type' => 'textfield',
      '#description' => t('This is a textfield for test_option.'),
      '#default_value' => $this->options['test_option'],
    );
  }

  /**
   * Sets the output property.
   *
   * @param string $output
   *   The string to output by this plugin.
   */
  public function setOutput($output) {
    $this->output = $output;
  }

  /**
   * Returns the output property.
   *
   * @return string
   */
  public function getOutput() {
    return $this->output;
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerFactoryPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
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::$usesOptions	protected	property	Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions	1
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
RowTest::$output	public	property	A string which will be output when the view is rendered.
RowTest::buildOptionsForm	public	function	Overrides Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm(). Overrides RowPluginBase::buildOptionsForm
RowTest::defineOptions	protected	function	Overrides Drupal\views\Plugin\views\row\RowPluginBase::defineOptions(). Overrides RowPluginBase::defineOptions
RowTest::getOutput	public	function	Returns the output property.
RowTest::render	public	function	Overrides Drupal\views\Plugin\views\row\RowPluginBase::render() Overrides RowPluginBase::render
RowTest::setOutput	public	function	Sets the output property.

Main menu

Search Drupal 8.x

API Navigation

class RowTest

Plugin annotation

Hierarchy

Related topics

File

Namespace

Members

Main menu

You are here

Search Drupal 8.x

API Navigation

class RowTest

Plugin annotation

Hierarchy

Related topics

File

Namespace

Members