class Access in Drupal 10

Filter by node_access records.

Plugin annotation

@ViewsFilter("node_access");

Hierarchy

• class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements CacheableDependencyInterface
  • class \Drupal\node\Plugin\views\filter\Access

Related topics

Views filter handler plugins

Plugins that handle views filtering.

4 string references to 'Access'

node.views.schema.yml in core/modules/node/config/schema/node.views.schema.yml

core/modules/node/config/schema/node.views.schema.yml

NodeViewsData::getViewsData in core/modules/node/src/NodeViewsData.php

views.argument_validator.schema.yml in core/modules/views/config/schema/views.argument_validator.schema.yml

core/modules/views/config/schema/views.argument_validator.schema.yml

views.data_types.schema.yml in core/modules/views/config/schema/views.data_types.schema.yml

core/modules/views/config/schema/views.data_types.schema.yml

File

core/modules/node/src/Plugin/views/filter/Access.php, line 15

Namespace

Drupal\node\Plugin\views\filter

class Access extends FilterPluginBase {
  public function adminSummary() {
  }
  protected function operatorForm(&$form, FormStateInterface $form_state) {
  }
  public function canExpose() {
    return FALSE;
  }

  /**
   * See _node_access_where_sql() for a non-views query based implementation.
   */
  public function query() {
    $account = $this->view
      ->getUser();
    if (!$account
      ->hasPermission('bypass node access')) {
      $table = $this
        ->ensureMyTable();
      $grants = $this->query
        ->getConnection()
        ->condition('OR');
      foreach (node_access_grants('view', $account) as $realm => $gids) {
        foreach ($gids as $gid) {
          $grants
            ->condition($this->query
            ->getConnection()
            ->condition('AND')
            ->condition($table . '.gid', $gid)
            ->condition($table . '.realm', $realm));
        }
      }
      $this->query
        ->addWhere('AND', $grants);
      $this->query
        ->addWhere('AND', $table . '.grant_view', 1, '>=');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    $contexts = parent::getCacheContexts();
    $contexts[] = 'user.node_grants:view';
    return $contexts;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Access::adminSummary	public	function	Display the filter on the administrative summary. Overrides FilterPluginBase::adminSummary
Access::canExpose	public	function	Determine if a filter can be exposed. Overrides FilterPluginBase::canExpose
Access::getCacheContexts	public	function	The cache contexts associated with this object. Overrides FilterPluginBase::getCacheContexts
Access::operatorForm	protected	function	Options form subform for setting the operator. Overrides FilterPluginBase::operatorForm
Access::query	public	function	See _node_access_where_sql() for a non-views query based implementation. Overrides FilterPluginBase::query
FilterPluginBase::$alwaysMultiple	protected	property	Disable the possibility to force a single value.	4
FilterPluginBase::$always_required	public	property	Disable the possibility to allow an exposed input to be optional.
FilterPluginBase::$group_info	public	property	Contains the information of the selected item in a grouped filter.
FilterPluginBase::$no_operator	public	property	Disable the possibility to use operators.	1
FilterPluginBase::$operator	public	property	Contains the operator which is used on the query.
FilterPluginBase::$value	public	property	Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::acceptExposedInput	public	function	Determines if the input from a filter should change the generated query.	2
FilterPluginBase::addGroupForm	public	function	Add a new group to the exposed filter groups.
FilterPluginBase::arrayFilterZero	protected static	function	Filter by no empty values, though allow the use of (string) "0".
FilterPluginBase::buildExposedFiltersGroupForm	protected	function	Build the form to let users create the group of exposed filters.
FilterPluginBase::buildExposedForm	public	function	Render our chunk of the exposed filter form when selecting.
FilterPluginBase::buildExposeForm	public	function	Options form subform for exposed filter options.	4
FilterPluginBase::buildGroupForm	public	function	Displays the Build Group form.
FilterPluginBase::buildGroupOptions	protected	function	Provide default options for exposed filters.
FilterPluginBase::buildGroupSubmit	protected	function	Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::buildGroupValidate	protected	function	Validate the build group options form.
FilterPluginBase::buildOptionsForm	public	function	Provide the basic form which calls through to subforms.	2
FilterPluginBase::buildValueWrapper	protected	function	Builds wrapper for value and operator forms.
FilterPluginBase::canBuildGroup	protected	function	Determine if a filter can be converted into a group.
FilterPluginBase::canGroup	public	function	Can this filter be used in OR groups?	1
FilterPluginBase::convertExposedInput	public	function	Transform the input from a grouped filter into a standard filter.
FilterPluginBase::defaultExposeOptions	public	function	Provide default options for exposed filters.	3
FilterPluginBase::defineOptions	protected	function		4
FilterPluginBase::exposedInfo	public	function	Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then.
FilterPluginBase::exposedTranslate	protected	function	Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
FilterPluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	1
FilterPluginBase::groupForm	public	function	Build a form containing a group of operator | values to apply as a single filter.
FilterPluginBase::groupMultipleExposedInput	public	function	Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected.
FilterPluginBase::hasValidGroupedValue	protected	function	Determines if the given grouped filter entry has a valid value.	1
FilterPluginBase::init	public	function	Overrides \Drupal\views\Plugin\views\HandlerBase::init().	2
FilterPluginBase::isAGroup	public	function	Returns TRUE if the exposed filter works like a grouped filter.
FilterPluginBase::multipleExposedInput	public	function	Returns TRUE if users can select multiple groups items of a grouped exposed filter.
FilterPluginBase::operatorOptions	public	function	Provide a list of options for the default operator form.	4
FilterPluginBase::operatorSubmit	public	function	Perform any necessary changes to the form values prior to storage.
FilterPluginBase::operatorValidate	protected	function	Validate the operator form.
FilterPluginBase::prepareFilterSelectOptions	protected	function	Sanitizes the HTML select element's options.
FilterPluginBase::showBuildGroupButton	protected	function	Shortcut to display the build_group/hide button.
FilterPluginBase::showBuildGroupForm	public	function	Shortcut to display the exposed options form.
FilterPluginBase::showExposeButton	public	function	Shortcut to display the expose/hide button.
FilterPluginBase::showOperatorForm	public	function	Shortcut to display the operator form.
FilterPluginBase::showValueForm	protected	function	Shortcut to display the value form.
FilterPluginBase::storeExposedInput	public	function
FilterPluginBase::storeGroupInput	public	function	If set to remember exposed input in the session, store it there.
FilterPluginBase::submitOptionsForm	public	function	Simple submit handler.
FilterPluginBase::trustedCallbacks	public static	function
FilterPluginBase::validate	public	function		2
FilterPluginBase::validateExposeForm	public	function	Validate the options form.
FilterPluginBase::validateIdentifier	protected	function	Validates a filter identifier.
FilterPluginBase::validateOptionsForm	public	function	Simple validate handler.	1
FilterPluginBase::valueForm	protected	function	Options form subform for setting options.	5
FilterPluginBase::valueSubmit	protected	function	Perform any necessary changes to the form values prior to storage.	1
FilterPluginBase::valueValidate	protected	function	Validate the options form.	2