You are here

Home » API reference » Views (for Drupal 7) 8.3 » StyleTest.php

class StyleTest in Views (for Drupal 7) 8.3

Same name in this branch
  1. 8.3 lib/Drupal/views/Tests/Plugin/StyleTest.php \Drupal\views\Tests\Plugin\StyleTest
  2. 8.3 tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/style/StyleTest.php \Drupal\views_test_data\Plugin\views\style\StyleTest

Provides a general test style plugin.

Plugin annotation


@Plugin(
  id = "test_style",
  title = @Translation("Test style plugin"),
  help = @Translation("Provides a generic style test plugin."),
  theme = "views_view_style_test",
  type = "normal"
)

Hierarchy

Expanded class hierarchy of StyleTest

Related topics

Views style plugins
Style plugins control how a view is rendered. For example, they can choose to display a collection of fields, node_view() output, table output, or any kind of crazy output they want.

File

tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/style/StyleTest.php, line 27
Definition of Drupal\views_test_data\Plugin\views\style\StyleTest.

Namespace

Drupal\views_test_data\Plugin\views\style
View source 
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;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::submitOptionsForm public function Handle any special handling on the validate form. 10
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::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2
StylePluginBase::$row_plugin property Contains the row plugin, if it's initialized and the style itself supports it.
StylePluginBase::$row_tokens property Store all available tokens row rows.
StylePluginBase::$usesFields protected property Does the style plugin for itself support to add fields to it's output. 2
StylePluginBase::$usesGrouping protected property Does the style plugin support grouping of rows. 1
StylePluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
StylePluginBase::$usesRowClass protected property Does the style plugin support custom css class for the rows. 4
StylePluginBase::$usesRowPlugin protected property Does the style plugin allows to use style plugins. 6
StylePluginBase::build_sort 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::build_sort_post 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::destroy public function Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::even_empty function Should the output of the style plugin be rendered even if it's a empty view. 1
StylePluginBase::get_field function Get a rendered field.
StylePluginBase::get_field_value function Get the raw field value.
StylePluginBase::get_row_class function Return the token replaced row class for the specified row.
StylePluginBase::init public function Initialize a style plugin.
StylePluginBase::pre_render function Allow the style to do stuff before each row is rendered.
StylePluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query 1
StylePluginBase::render_fields function Render all of the fields for a given style and store them on the object.
StylePluginBase::render_grouping function Group records as needed for rendering.
StylePluginBase::render_grouping_sets function Render the grouping sets.
StylePluginBase::tokenize_value function Take a value and apply token replacement logic to it.
StylePluginBase::usesFields function Return TRUE if this style also uses fields. 2
StylePluginBase::usesGrouping function Returns the usesGrouping property. 1
StylePluginBase::usesRowClass function Returns the usesRowClass property. 4
StylePluginBase::uses_tokens function Return TRUE if this style uses tokens.
StylePluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizard_form function Provide a form in the views wizard if this style is selected.
StylePluginBase::wizard_submit function Alter the options of a display before they are added to the view. 1
StyleTest::$output public property A string which will be output when the view is rendered.
StyleTest::buildOptionsForm public function Overrides Drupal\views\Plugin\views\style\StylePluginBase::buildOptionsForm(). Overrides StylePluginBase::buildOptionsForm
StyleTest::defineOptions protected function Overrides Drupal\views\Plugin\views\style\StylePluginBase::defineOptions(). Overrides StylePluginBase::defineOptions
StyleTest::getOutput public function Returns the output property.
StyleTest::render public function Overrides Drupal\views\Plugin\views\style\StylePluginBase::render() Overrides StylePluginBase::render
StyleTest::setOutput public function Sets the output property.
StyleTest::setUsesRowPlugin public function Sets the usesRowPlugin property.
StyleTest::usesRowPlugin function Returns the usesRowPlugin property. Overrides StylePluginBase::usesRowPlugin