class AccessPluginBase
Same name in other branches
- 9 core/modules/views/src/Plugin/views/access/AccessPluginBase.php \Drupal\views\Plugin\views\access\AccessPluginBase
- 8.9.x core/modules/views/src/Plugin/views/access/AccessPluginBase.php \Drupal\views\Plugin\views\access\AccessPluginBase
- 11.x core/modules/views/src/Plugin/views/access/AccessPluginBase.php \Drupal\views\Plugin\views\access\AccessPluginBase
The base plugin to handle access control.
Access plugins are responsible for controlling a user's access to the view. Views includes plugins for checking user roles and individual permissions.
To define an access control plugin, extend this base class. Your access plugin should have an annotation that includes the plugin's metadata, for example: @Plugin( id = "deny_all", title = @Translation("No Access"), help = @Translation("Will not be accessible.") ) The definition should include the following keys:
- id: The unique identifier of your access plugin.
- title: The human-readable name for your access plugin.
- help: A short help message for your plugin.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\access\AccessPluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of AccessPluginBase
See also
\Drupal\views\Plugin\ViewsPluginManager
Related topics
5 files declare their use of AccessPluginBase
- CacheableMetadataCalculationTest.php in core/
modules/ views/ tests/ modules/ views_test_cacheable_metadata_calculation/ src/ Plugin/ views/ access/ CacheableMetadataCalculationTest.php - DisplayKernelTest.php in core/
modules/ views/ tests/ src/ Kernel/ Plugin/ DisplayKernelTest.php - Permission.php in core/
modules/ user/ src/ Plugin/ views/ access/ Permission.php - Role.php in core/
modules/ user/ src/ Plugin/ views/ access/ Role.php - StaticTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ access/ StaticTest.php
File
-
core/
modules/ views/ src/ Plugin/ views/ access/ AccessPluginBase.php, line 46
Namespace
Drupal\views\Plugin\views\accessView source
abstract class AccessPluginBase extends PluginBase {
/**
* {@inheritdoc}
*/
public function summaryTitle() {
return $this->t('Unknown');
}
/**
* Determine if the current user has access or not.
*
* @param \Drupal\Core\Session\AccountInterface $account
* The user who wants to access this view.
*
* @return bool
* Returns whether the user has access to the view.
*/
public abstract function access(AccountInterface $account);
/**
* Allows access plugins to alter the route definition of a view.
*
* Likely the access plugin will add new requirements, so its custom access
* checker can be applied.
*
* @param \Symfony\Component\Routing\Route $route
* The route to change.
*/
public abstract function alterRouteDefinition(Route $route);
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
AccessPluginBase::access | abstract public | function | Determine if the current user has access or not. | 5 | ||
AccessPluginBase::alterRouteDefinition | abstract public | function | Allows access plugins to alter the route definition of a view. | 5 | ||
AccessPluginBase::summaryTitle | public | function | Overrides PluginBase::summaryTitle | 3 | ||
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' 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::$position | public | property | The handler position. | |||
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::buildOptionsForm | public | function | Overrides ViewsPluginInterface::buildOptionsForm | 16 | ||
PluginBase::calculateDependencies | public | function | Overrides DependentPluginInterface::calculateDependencies | 14 | ||
PluginBase::create | public static | function | Overrides ContainerFactoryPluginInterface::create | 60 | ||
PluginBase::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | 18 | ||
PluginBase::destroy | public | function | 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 | Overrides ViewsPluginInterface::filterByDefinedOptions | |||
PluginBase::getAvailableGlobalTokens | public | function | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |||
PluginBase::getProvider | public | function | Overrides ViewsPluginInterface::getProvider | |||
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | ||
PluginBase::globalTokenForm | public | function | Overrides ViewsPluginInterface::globalTokenForm | |||
PluginBase::globalTokenReplace | public | function | 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 | Overrides ViewsPluginInterface::init | 6 | ||
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | |||
PluginBase::pluginTitle | public | function | Overrides ViewsPluginInterface::pluginTitle | |||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |||
PluginBase::preRenderFlattenData | public static | function | Overrides ViewsPluginInterface::preRenderFlattenData | |||
PluginBase::query | public | function | 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::submitOptionsForm | public | function | Overrides ViewsPluginInterface::submitOptionsForm | 16 | ||
PluginBase::themeFunctions | public | function | Overrides ViewsPluginInterface::themeFunctions | 1 | ||
PluginBase::trustedCallbacks | public static | function | Overrides TrustedCallbackInterface::trustedCallbacks | 6 | ||
PluginBase::unpackOptions | public | function | Overrides ViewsPluginInterface::unpackOptions | |||
PluginBase::usesOptions | public | function | Overrides ViewsPluginInterface::usesOptions | 8 | ||
PluginBase::validate | public | function | Overrides ViewsPluginInterface::validate | 6 | ||
PluginBase::validateOptionsForm | public | function | Overrides ViewsPluginInterface::validateOptionsForm | 15 | ||
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. | 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 | Deprecated | 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.