class ArgumentDefaultTest

Defines a argument default test plugin.

Plugin annotation


@Plugin(
  id = "argument_default_test",
  title = @Translation("Argument default test")
)

Hierarchy

Expanded class hierarchy of ArgumentDefaultTest

1 file declares its use of ArgumentDefaultTest
ArgumentDefaultTest.php in drupal/core/modules/views/lib/Drupal/views/Tests/Plugin/ArgumentDefaultTest.php
Definition of Drupal\views\Tests\Plugin\ArgumentDefaultTest.

File

drupal/core/modules/views/tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/argument_default/ArgumentDefaultTest.php, line 22
Definition of Drupal\views_test_data\Plugin\views\argument_default\ArgumentDefaultTest.

Namespace

Drupal\views_test_data\Plugin\views\argument_default
View source
class ArgumentDefaultTest extends ArgumentDefaultPluginBase {

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

  /**
   * {@inheritdoc}
   */
  public function getArgument() {
    return $this->options['value'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArgumentDefaultPluginBase::$argument protected property The argument handler instance associated with this plugin.
ArgumentDefaultPluginBase::access public function Determine if the administrator has the privileges to use this plugin 1
ArgumentDefaultPluginBase::buildOptionsForm public function Provide the default form for setting options. Overrides PluginBase::buildOptionsForm 5
ArgumentDefaultPluginBase::checkAccess protected function If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input.
ArgumentDefaultPluginBase::setArgument public function Sets the parent argument this plugin is associated with.
ArgumentDefaultPluginBase::submitOptionsForm public function Provide the default form form for submitting options Overrides PluginBase::submitOptionsForm 1
ArgumentDefaultPluginBase::validateOptionsForm public function Provide the default form form for validating options Overrides PluginBase::validateOptionsForm
ArgumentDefaultTest::defineOptions protected function Overrides Drupal\views\Plugin\views\argument_default\ArgumentDefaultPluginBase::defineOptions(). Overrides ArgumentDefaultPluginBase::defineOptions
ArgumentDefaultTest::getArgument public function Return the default argument. Overrides ArgumentDefaultPluginBase::getArgument
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::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
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::query public function Add anything to the query that we might need to. 13
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