class RowTest

Same name in this branch
  1. 9 core/modules/migrate/tests/src/Unit/RowTest.php \Drupal\Tests\migrate\Unit\RowTest
Same name and namespace in other branches
  1. 11.x core/modules/migrate/tests/src/Kernel/RowTest.php \Drupal\Tests\migrate\Kernel\RowTest
  2. 11.x core/modules/views/tests/modules/views_test_data/src/Plugin/views/row/RowTest.php \Drupal\views_test_data\Plugin\views\row\RowTest
  3. 11.x core/modules/migrate/tests/src/Unit/RowTest.php \Drupal\Tests\migrate\Unit\RowTest

Provides a general test row plugin.

Plugin annotation


@ViewsRow(
  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

Expanded class hierarchy of RowTest

Related topics

1 file declares its use of RowTest
StyleTest.php in core/modules/views/tests/src/Kernel/Plugin/StyleTest.php
3 string references to 'RowTest'
RowTest::calculateDependencies in core/modules/views/tests/modules/views_test_data/src/Plugin/views/row/RowTest.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/row/RowTest.php, line 21

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;
  
  /**
   * {@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' => $this->t('Test option'),
      '#type' => 'textfield',
      '#description' => $this->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;
  }
  
  /**
   * {@inheritdoc}
   */
  public function render($row) {
    return $this->getOutput();
  }
  
  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [
      'content' => [
        'RowTest',
      ],
    ];
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange]
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin.
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.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer.
PluginBase::$view public property The top object of a view.
PluginBase::create public static function 2
PluginBase::create public static function 2
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function
PluginBase::getAvailableGlobalTokens public function
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 1
PluginBase::getPluginDefinition public function 1
PluginBase::getPluginId public function
PluginBase::getProvider public function
PluginBase::getRenderer protected function Returns the render API renderer.
PluginBase::globalTokenForm public function
PluginBase::globalTokenReplace public function
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function
PluginBase::isConfigurable 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
PluginBase::preRenderAddFieldsetMarkup public static function
PluginBase::preRenderFlattenData public static function
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::summaryTitle public function
PluginBase::themeFunctions public function
PluginBase::trustedCallbacks public static function
PluginBase::unpackOptions public function
PluginBase::usesOptions public function 1
PluginBase::usesOptions public function 1
PluginBase::validate public function
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginBase::__construct public function Constructs a PluginBase object.
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to its output.
RowPluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
RowPluginBase::preRender public function Allow the style to do stuff before each row is rendered.
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. Overrides PluginBase::submitOptionsForm
RowPluginBase::usesFields public function Returns the usesFields property.
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
RowTest::$output public property A string which will be output when the view is rendered.
RowTest::buildOptionsForm public function Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
RowTest::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
RowTest::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides RowPluginBase::defineOptions
RowTest::getOutput public function Returns the output property.
RowTest::render public function Renders a row object. Overrides RowPluginBase::render
RowTest::setOutput public function Sets the output property.
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.