class ViewsAccess in Drupal 8

Defines a Plugin annotation object for views access plugins.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\views\Annotation\ViewsPluginAnnotationBase implements AnnotationInterface
    • class \Drupal\views\Annotation\ViewsAccess

See also

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

Related topics

Annotations

Annotations for class discovery and metadata description.

Views access plugins

Plugins to handle access checking for views.

5 classes are annotated with ViewsAccess

CacheableMetadataCalculationTest in core/modules/views/tests/modules/views_test_cacheable_metadata_calculation/src/Plugin/views/access/CacheableMetadataCalculationTest.php

Tests plugin that reports when cacheable metadata is being calculated.

None in core/modules/views/src/Plugin/views/access/None.php

Access plugin that provides no access control at all.

Permission in core/modules/user/src/Plugin/views/access/Permission.php

Access plugin that provides permission-based access control.

Role in core/modules/user/src/Plugin/views/access/Role.php

Access plugin that provides role-based access control.

StaticTest in core/modules/views/tests/modules/views_test_data/src/Plugin/views/access/StaticTest.php

Tests a static access plugin.

File

core/modules/views/src/Annotation/ViewsAccess.php, line 14

Namespace

Drupal\views\Annotation

class ViewsAccess extends ViewsPluginAnnotationBase {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The plugin title used in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title = '';

  /**
   * (optional) The short title used in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $short_title = '';

  /**
   * A short help string; this is displayed in the views UI.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $help = '';

  /**
   * 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.
   *
   * @var array
   */
  public $display_types;

  /**
   * 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.
   *
   * @var array
   */
  public $base;

  /**
   * 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.
   *
   * @var bool
   */
  public $no_ui;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
ViewsAccess::$base	public	property	The base tables on which this access plugin can be used.
ViewsAccess::$display_types	public	property	The types of the display this plugin can be used with.
ViewsAccess::$help	public	property	A short help string; this is displayed in the views UI.
ViewsAccess::$id	public	property	The plugin ID.
ViewsAccess::$no_ui	public	property	Whether the plugin should be not selectable in the UI.
ViewsAccess::$short_title	public	property	(optional) The short title used in the views UI.
ViewsAccess::$title	public	property	The plugin title used in the views UI.
ViewsPluginAnnotationBase::$register_theme	public	property	Whether or not to register a theme function automatically.