class ViewsAccess

Defines a views access plugins type attribute for plugin discovery.

Attributes

#[\Attribute(\Attribute::TARGET_CLASS)]

Hierarchy

Expanded class hierarchy of ViewsAccess

See also

\Drupal\views\Plugin\views\access\AccessPluginBase

Related topics

Views access plugins
Plugins to handle access checking for views.
5 files declare their use of ViewsAccess
CacheableMetadataCalculationTest.php in core/modules/views/tests/modules/views_test_cacheable_metadata_calculation/src/Plugin/views/access/CacheableMetadataCalculationTest.php
None.php in core/modules/views/src/Plugin/views/access/None.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

View on git.drupalcode.org

core/modules/views/src/Attribute/ViewsAccess.php, line 15

Namespace

Drupal\views\Attribute
View source 
class ViewsAccess extends Plugin {
  
  /**
   * Constructs a ViewsAccess attribute.
   *
   * @param string $id
   *   The plugin ID.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $title
   *   The plugin title used in the views UI.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $short_title
   *   (optional) The short title used in the views UI.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $help
   *   (optional) A short help string; this is displayed in the views UI.
   * @param string[]|null $display_types
   *   (optional) The types of the display this plugin can be used with.
   *   For example the Feed display defines the type 'feed', so only rss style
   *   and row plugins can be used in the views UI.
   * @param string[] $base
   *   (optional) The base tables on which this access plugin can be used.
   *   If no base table is specified the plugin can be used with all tables.
   * @param bool $no_ui
   *   (optional) Whether the plugin should be not selectable in the UI.
   *   If set to TRUE, you can still use it via the API in config files.
   *   Defaults to FALSE.
   * @param class-string|null $deriver
   *   (optional) The deriver class.
   */
  public function __construct(public readonly string $id, public readonly TranslatableMarkup $title, public readonly ?TranslatableMarkup $short_title = NULL, public readonly ?TranslatableMarkup $help = NULL, public readonly ?array $display_types = NULL, public readonly array $base = [], public readonly bool $no_ui = FALSE, public readonly ?string $deriver = NULL) {
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
AttributeBase::$class protected property The class used for this attribute class.
AttributeBase::$provider protected property The provider of the attribute class.
AttributeBase::get public function Gets the value of an attribute. Overrides AttributeInterface::get 6
AttributeBase::getClass public function Gets the class of the attribute class. Overrides AttributeInterface::getClass 1
AttributeBase::getId public function Gets the unique ID for this attribute class. Overrides AttributeInterface::getId
AttributeBase::getProvider public function Gets the name of the provider of the attribute class. Overrides AttributeInterface::getProvider
AttributeBase::setClass public function Sets the class of the attributed class. Overrides AttributeInterface::setClass 1
AttributeBase::setProvider public function Sets the name of the provider of the attribute class. Overrides AttributeInterface::setProvider
ViewsAccess::__construct public function Constructs a ViewsAccess attribute. Overrides Plugin::__construct

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