Provides a general test style plugin.
@Plugin(
  id = "test_style",
  title = @Translation("Test style plugin"),
  help = @Translation("Provides a generic style test plugin."),
  theme = "views_view_style_test",
  type = "normal"
)
Expanded class hierarchy of StyleTest
class StyleTest extends StylePluginBase {
  /**
   * A string which will be output when the view is rendered.
   *
   * @var string
   */
  public $output;
  /**
   * Overrides Drupal\views\Plugin\views\style\StylePluginBase::defineOptions().
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['test_option'] = array(
      'default' => '',
    );
    return $options;
  }
  /**
   * Overrides Drupal\views\Plugin\views\style\StylePluginBase::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'],
    );
  }
  function usesRowPlugin() {
    return parent::usesRowPlugin();
  }
  /**
   * Sets the usesRowPlugin property.
   *
   * @param bool $status
   *   TRUE if this style plugin should use rows.
   */
  public function setUsesRowPlugin($status) {
    $this->usesRowPlugin = $status;
  }
  /**
   * 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\style\StylePluginBase::render()
   */
  public function render() {
    $output = '';
    if (!$this
      ->usesRowPlugin()) {
      $output = $this
        ->getOutput();
    }
    else {
      foreach ($this->view->result as $index => $row) {
        $this->view->row_index = $index;
        $output .= $this->row_plugin
          ->render($row) . "\n";
      }
    }
    return $output;
  }
}| Name   | Modifiers | Type | Description | Overrides | 
|---|---|---|---|---|
| PluginBase:: | protected | property | Configuration information passed into the plugin. | 1 | 
| PluginBase:: | public | property | Plugins's definition | |
| PluginBase:: | protected | property | The discovery object. | |
| PluginBase:: | public | property | The display object this plugin is for. | |
| PluginBase:: | public | property | Options for this plugin will be held here. | |
| PluginBase:: | protected | property | The plugin_id. | |
| PluginBase:: | public | property | The top object of a view. | 1 | 
| PluginBase:: | public | function | Provide a list of additional theme functions for the theme information page | |
| PluginBase:: | public | function | Returns an array of available token replacements. | |
| PluginBase:: | public | function | Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: | |
| PluginBase:: | public | function | Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: | |
| PluginBase:: | public | function | Adds elements for available core tokens to a form. | |
| PluginBase:: | public | function | Returns a string with any core tokens replaced. | |
| PluginBase:: | public | function | Return the human readable name of the display. | |
| PluginBase:: | protected | function | ||
| PluginBase:: | public | function | Handle any special handling on the validate form. | 10 | 
| PluginBase:: | public | function | Returns the summary of the settings in the display. | 6 | 
| PluginBase:: | public | function | Provide a full list of possible theme templates used by this style. | 1 | 
| PluginBase:: | public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
| PluginBase:: | public | function | Returns the usesOptions property. | 8 | 
| PluginBase:: | public | function | Constructs a Plugin object. Overrides PluginBase:: | |
| StylePluginBase:: | property | Contains the row plugin, if it's initialized and the style itself supports it. | ||
| StylePluginBase:: | property | Store all available tokens row rows. | ||
| StylePluginBase:: | protected | property | Does the style plugin for itself support to add fields to it's output. | 2 | 
| StylePluginBase:: | protected | property | Does the style plugin support grouping of rows. | 1 | 
| StylePluginBase:: | protected | property | Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: | |
| StylePluginBase:: | protected | property | Does the style plugin support custom css class for the rows. | 4 | 
| StylePluginBase:: | protected | property | Does the style plugin allows to use style plugins. | 6 | 
| StylePluginBase:: | function | Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. | 1 | |
| StylePluginBase:: | function | Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. | 1 | |
| StylePluginBase:: | public | function | Clears a plugin. Overrides PluginBase:: | |
| StylePluginBase:: | function | Should the output of the style plugin be rendered even if it's a empty view. | 1 | |
| StylePluginBase:: | function | Get a rendered field. | ||
| StylePluginBase:: | function | Get the raw field value. | ||
| StylePluginBase:: | function | Return the token replaced row class for the specified row. | ||
| StylePluginBase:: | public | function | Initialize a style plugin. | |
| StylePluginBase:: | function | Allow the style to do stuff before each row is rendered. | ||
| StylePluginBase:: | public | function | Add anything to the query that we might need to. Overrides PluginBase:: | 1 | 
| StylePluginBase:: | function | Render all of the fields for a given style and store them on the object. | ||
| StylePluginBase:: | function | Group records as needed for rendering. | ||
| StylePluginBase:: | function | Render the grouping sets. | ||
| StylePluginBase:: | function | Take a value and apply token replacement logic to it. | ||
| StylePluginBase:: | function | Return TRUE if this style also uses fields. | 2 | |
| StylePluginBase:: | function | Returns the usesGrouping property. | 1 | |
| StylePluginBase:: | function | Returns the usesRowClass property. | 4 | |
| StylePluginBase:: | function | Return TRUE if this style uses tokens. | ||
| StylePluginBase:: | public | function | Validate that the plugin is correct and can be saved. Overrides PluginBase:: | |
| StylePluginBase:: | public | function | Validate the options form. Overrides PluginBase:: | |
| StylePluginBase:: | function | Provide a form in the views wizard if this style is selected. | ||
| StylePluginBase:: | function | Alter the options of a display before they are added to the view. | 1 | |
| StyleTest:: | public | property | A string which will be output when the view is rendered. | |
| StyleTest:: | public | function | Overrides Drupal\views\Plugin\views\style\StylePluginBase::buildOptionsForm(). Overrides StylePluginBase:: | |
| StyleTest:: | protected | function | Overrides Drupal\views\Plugin\views\style\StylePluginBase::defineOptions(). Overrides StylePluginBase:: | |
| StyleTest:: | public | function | Returns the output property. | |
| StyleTest:: | public | function | Overrides Drupal\views\Plugin\views\style\StylePluginBase::render() Overrides StylePluginBase:: | |
| StyleTest:: | public | function | Sets the output property. | |
| StyleTest:: | public | function | Sets the usesRowPlugin property. | |
| StyleTest:: | function | Returns the usesRowPlugin property. Overrides StylePluginBase:: |