class ArgumentValidatorPluginBase

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php \Drupal\views\Plugin\views\argument_validator\ArgumentValidatorPluginBase
  2. 10 core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php \Drupal\views\Plugin\views\argument_validator\ArgumentValidatorPluginBase
  3. 11.x core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php \Drupal\views\Plugin\views\argument_validator\ArgumentValidatorPluginBase

Base argument validator plugin to provide basic functionality.

Hierarchy

Expanded class hierarchy of ArgumentValidatorPluginBase

Related topics

1 file declares its use of ArgumentValidatorPluginBase
ArgumentValidatorTest.php in core/modules/views/tests/modules/views_test_data/src/Plugin/views/argument_validator/ArgumentValidatorTest.php

File

core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php, line 34

Namespace

Drupal\views\Plugin\views\argument_validator
View source
abstract class ArgumentValidatorPluginBase extends PluginBase {
    
    /**
     * The argument handler instance associated with this plugin.
     *
     * @var \Drupal\views\Plugin\views\argument\ArgumentPluginBase
     */
    protected $argument;
    
    /**
     * Sets the parent argument this plugin is associated with.
     *
     * @param \Drupal\views\Plugin\views\argument\ArgumentPluginBase $argument
     *   The parent argument to set.
     */
    public function setArgument(ArgumentPluginBase $argument) {
        $this->argument = $argument;
    }
    
    /**
     * Retrieves the options when this is a new access control plugin.
     */
    protected function defineOptions() {
        return [];
    }
    
    /**
     * Provides the default form for setting options.
     */
    public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    }
    
    /**
     * Provides the default form for validating options.
     */
    public function validateOptionsForm(&$form, FormStateInterface $form_state) {
    }
    
    /**
     * Provides the default form for submitting options.
     */
    public function submitOptionsForm(&$form, FormStateInterface $form_state, &$options = []) {
    }
    
    /**
     * Determines if the administrator has the privileges to use this plugin.
     */
    public function access() {
        return TRUE;
    }
    
    /**
     * Blocks user input when the form is shown but we don´t have access.
     *
     * This is only called by child objects if specified in the buildOptionsForm(),
     * so it will not always be used.
     */
    protected function checkAccess(&$form, $option_name) {
        if (!$this->access()) {
            $form[$option_name]['#disabled'] = TRUE;
            $form[$option_name]['#value'] = $form[$this->option_name]['#default_value'];
            $form[$option_name]['#description'] .= ' <strong>' . $this->t('Note: you do not have permission to modify this. If you change the default filter type, this setting will be lost and you will NOT be able to get it back.') . '</strong>';
        }
    }
    
    /**
     * Performs validation for a given argument.
     */
    public function validateArgument($arg) {
        return TRUE;
    }
    
    /**
     * Processes the summary arguments for displaying.
     *
     * Some plugins alter the argument so it uses something else internally.
     * For example the user validation set's the argument to the uid,
     * for a faster query. But there are use cases where you want to use
     * the old value again, for example the summary.
     */
    public function processSummaryArguments(&$args) {
    }
    
    /**
     * Returns a context definition for this argument.
     *
     * @return \Drupal\Core\Plugin\Context\ContextDefinitionInterface|null
     *   A context definition that represents the argument or NULL if that is
     *   not possible.
     */
    public function getContextDefinition() {
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ArgumentValidatorPluginBase::$argument protected property The argument handler instance associated with this plugin.
ArgumentValidatorPluginBase::access public function Determines if the administrator has the privileges to use this plugin.
ArgumentValidatorPluginBase::buildOptionsForm public function Provides the default form for setting options. Overrides PluginBase::buildOptionsForm 1
ArgumentValidatorPluginBase::checkAccess protected function Blocks user input when the form is shown but we donĀ“t have access.
ArgumentValidatorPluginBase::defineOptions protected function Retrieves the options when this is a new access control plugin. Overrides PluginBase::defineOptions 2
ArgumentValidatorPluginBase::getContextDefinition public function Returns a context definition for this argument. 2
ArgumentValidatorPluginBase::processSummaryArguments public function Processes the summary arguments for displaying. 1
ArgumentValidatorPluginBase::setArgument public function Sets the parent argument this plugin is associated with.
ArgumentValidatorPluginBase::submitOptionsForm public function Provides the default form for submitting options. Overrides PluginBase::submitOptionsForm 1
ArgumentValidatorPluginBase::validateArgument public function Performs validation for a given argument. 4
ArgumentValidatorPluginBase::validateOptionsForm public function Provides the default form for validating options. Overrides PluginBase::validateOptionsForm
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
PluginBase::$definition public property Plugins&#039;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::$renderer protected property Stores the render API renderer. 3
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::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 14
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 62
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
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::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::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 8
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::query public function Add anything to the query that we might need to. Overrides ViewsPluginInterface::query 8
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 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::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays
so that defaults don&#039;t get totally blown away.
Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views&#039; tokens in a given string. The resulting string will be
sanitized with Xss::filterAdmin.
1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginBase::__construct public function Constructs a PluginBase object. 19
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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.