class StyleTest
Provides a general test style plugin.
Attributes
#[ViewsStyle(id: "test_style", title: new TranslatableMarkup("Test style plugin"), help: new TranslatableMarkup("Provides a generic style test plugin."), theme: "views_view_style_test", register_theme: FALSE, display_types: [
"normal",
"test",
])]
  Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\views\Plugin\views\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\views\Plugin\views\style\StylePluginBase extends \Drupal\views\Plugin\views\PluginBase- class \Drupal\views_test_data\Plugin\views\style\StyleTest extends \Drupal\views\Plugin\views\style\StylePluginBase
 
 
- class \Drupal\views\Plugin\views\style\StylePluginBase extends \Drupal\views\Plugin\views\PluginBase
 
- class \Drupal\views\Plugin\views\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of StyleTest
Related topics
1 file declares its use of StyleTest
- StyleTest.php in core/modules/ views/ tests/ src/ Kernel/ Plugin/ StyleTest.php 
3 string references to 'StyleTest'
- StyleTest::calculateDependencies in core/modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ style/ StyleTest.php 
- Calculates dependencies for the configured plugin.
- ViewEntityDependenciesTest::testGetDependencies in core/modules/ views/ tests/ src/ Kernel/ Entity/ ViewEntityDependenciesTest.php 
- Tests the getDependencies method.
- views.view.test_plugin_dependencies.yml in core/modules/ views/ tests/ modules/ views_test_config/ test_views/ views.view.test_plugin_dependencies.yml 
- core/modules/views/tests/modules/views_test_config/test_views/views.view.test_plugin_dependencies.yml
File
- 
              core/modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ style/ StyleTest.php, line 17 
Namespace
Drupal\views_test_data\Plugin\views\styleView source
class StyleTest extends StylePluginBase {
  
  /**
   * A string which will be output when the view is rendered.
   *
   * @var string
   */
  public $output;
  
  /**
   * {@inheritdoc}
   */
  protected $usesRowPlugin = TRUE;
  
  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['test_option'] = [
      'default' => '',
    ];
    return $options;
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['test_option'] = [
      '#title' => 'Test option',
      '#type' => 'textfield',
      '#description' => 'This is a textfield for test_option.',
      '#default_value' => $this->options['test_option'],
    ];
  }
  
  /**
   * 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
   *   The output of the plugin.
   */
  public function getOutput() {
    return $this->output;
  }
  
  /**
   * {@inheritdoc}
   */
  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->view->rowPlugin
          ->render($row) . "\n";
      }
    }
    return $output;
  }
  
  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [
      'content' => [
        'StyleTest',
      ],
    ];
  }
}Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | |||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
| PluginBase::$definition | public | property | Plugins' 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::$position | public | property | The handler position. | |||
| PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | ||
| PluginBase::$view | public | property | The top object of a view. | 1 | ||
| PluginBase::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | 165 | ||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
| PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | |||
| PluginBase::filterByDefinedOptions | public | function | Filter out stored options depending on the defined options. | Overrides ViewsPluginInterface::filterByDefinedOptions | ||
| PluginBase::getAvailableGlobalTokens | public | function | Returns an array of available token replacements. | Overrides ViewsPluginInterface::getAvailableGlobalTokens | ||
| 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 | 2 | |
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
| PluginBase::getProvider | public | function | Returns the plugin provider. | Overrides ViewsPluginInterface::getProvider | ||
| PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | ||
| PluginBase::globalTokenForm | public | function | Adds elements for available core tokens to a form. | Overrides ViewsPluginInterface::globalTokenForm | ||
| PluginBase::globalTokenReplace | public | function | Returns a string with any core tokens replaced. | Overrides ViewsPluginInterface::globalTokenReplace | ||
| PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | ||||
| PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | ||||
| PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
| PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | |||
| PluginBase::pluginTitle | public | function | Return the human readable name of the display. | Overrides ViewsPluginInterface::pluginTitle | ||
| PluginBase::preRenderAddFieldsetMarkup | public static | function | Moves form elements into fieldsets for presentation purposes. | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | ||
| PluginBase::preRenderFlattenData | public static | function | Flattens the structure of form elements. | Overrides ViewsPluginInterface::preRenderFlattenData | ||
| PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | |||
| PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | |||
| PluginBase::submitOptionsForm | public | function | Handle any special handling on the validate form. | Overrides ViewsPluginInterface::submitOptionsForm | 16 | |
| PluginBase::summaryTitle | public | function | Returns the summary of the settings in the display. | Overrides ViewsPluginInterface::summaryTitle | 6 | |
| PluginBase::themeFunctions | public | function | Provide a full list of possible theme templates used by this style. | Overrides ViewsPluginInterface::themeFunctions | 1 | |
| PluginBase::unpackOptions | public | function | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | ||
| PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 | |
| PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | ||
| PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | ||||
| PluginBase::__construct | public | function | Constructs a PluginBase object. | Overrides PluginBase::__construct | 22 | |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 | ||
| StylePluginBase::$defaultFieldLabels | protected | property | Should field labels be enabled by default. | 1 | ||
| StylePluginBase::$groupingTheme | protected | property | The theme function used to render the grouping set. | |||
| StylePluginBase::$rendered_fields | protected | property | Stores the rendered field values, keyed by the row index and field name. | |||
| StylePluginBase::$render_tokens | public | property | Keyed array by placeholder a cached per row tokens to render. | |||
| StylePluginBase::$rowTokens | protected | property | Store all available tokens row rows. | |||
| StylePluginBase::$usesFields | protected | property | Does the style plugin for itself support to add fields to its output. | 3 | ||
| StylePluginBase::$usesGrouping | protected | property | Does the style plugin support grouping of rows. | 3 | ||
| StylePluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | Overrides PluginBase::$usesOptions | ||
| StylePluginBase::$usesRowClass | protected | property | Does the style plugin support custom css class for the rows. | 3 | ||
| StylePluginBase::buildSort | public | function | Determines if the style handler should interfere with sorts. | 1 | ||
| StylePluginBase::buildSortPost | public | function | Allows the view builder to build a second set of sorts. | 1 | ||
| StylePluginBase::defaultFieldLabels | public | function | Return TRUE if this style enables field labels by default. | 1 | ||
| StylePluginBase::destroy | public | function | Clears a plugin. | Overrides PluginBase::destroy | ||
| StylePluginBase::elementPreRenderRow | public | function | Render API callback: Performs view row field rendering. | |||
| StylePluginBase::evenEmpty | public | function | Determines if the style plugin is rendered even if the view is empty. | 2 | ||
| StylePluginBase::getField | public | function | Gets a rendered field. | |||
| StylePluginBase::getFieldValue | public | function | Get the raw field value. | |||
| StylePluginBase::getRowClass | public | function | Return the token replaced row class for the specified row. | |||
| StylePluginBase::init | public | function | Overrides \Drupal\views\Plugin\views\PluginBase::init(). | Overrides PluginBase::init | ||
| StylePluginBase::preRender | public | 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::renderFields | protected | function | Renders all of the fields for a given style and store them on the object. | |||
| StylePluginBase::renderGrouping | public | function | Group records as needed for rendering. | |||
| StylePluginBase::renderGroupingSets | public | function | Render the grouping sets. | |||
| StylePluginBase::renderRowGroup | protected | function | Renders a group of rows of the grouped view. | |||
| StylePluginBase::tokenizeValue | public | function | Take a value and apply token replacement logic to it. | |||
| StylePluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides PluginBase::trustedCallbacks | ||
| StylePluginBase::usesFields | public | function | Return TRUE if this style also uses fields. | 3 | ||
| StylePluginBase::usesGrouping | public | function | Returns the usesGrouping property. | 3 | ||
| StylePluginBase::usesRowClass | public | function | Returns the usesRowClass property. | 3 | ||
| StylePluginBase::usesRowPlugin | public | function | Returns the usesRowPlugin property. | 11 | ||
| StylePluginBase::usesTokens | public | 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::wizardSubmit | public | 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::$usesRowPlugin | protected | property | Whether or not this style uses a row plugin. | Overrides StylePluginBase::$usesRowPlugin | ||
| StyleTest::buildOptionsForm | public | function | Provide a form to edit options for this plugin. | Overrides StylePluginBase::buildOptionsForm | ||
| StyleTest::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides PluginBase::calculateDependencies | ||
| StyleTest::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides StylePluginBase::defineOptions | ||
| StyleTest::getOutput | public | function | Returns the output property. | |||
| StyleTest::render | public | function | Render the display in this style. | Overrides StylePluginBase::render | ||
| StyleTest::setOutput | public | function | Sets the output property. | |||
| StyleTest::setUsesRowPlugin | public | function | Sets the usesRowPlugin property. | |||
| TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
| TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
