ViewsAccess.php

Same filename in this branch
  1. 10 core/modules/views/src/Annotation/ViewsAccess.php
Same filename and directory in other branches
  1. 9 core/modules/views/src/Annotation/ViewsAccess.php
  2. 8.9.x core/modules/views/src/Annotation/ViewsAccess.php
  3. 11.x core/modules/views/src/Annotation/ViewsAccess.php
  4. 11.x core/modules/views/src/Attribute/ViewsAccess.php

Namespace

Drupal\views\Attribute

File

core/modules/views/src/Attribute/ViewsAccess.php

View source
<?php

namespace Drupal\views\Attribute;

use Drupal\Component\Plugin\Attribute\Plugin;
use Drupal\Core\StringTranslation\TranslatableMarkup;

/**
 * Defines a views access plugins type attribute for plugin discovery.
 *
 * @see \Drupal\views\Plugin\views\access\AccessPluginBase
 *
 * @ingroup views_access_plugins
 */
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) {
  }

}

Classes

Title Deprecated Summary
ViewsAccess Defines a views access plugins type attribute for plugin discovery.

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