interface DependentAccessInterface in Drupal 10

Interface for AccessibleInterface objects that have an access dependency.

Objects should implement this interface when their access depends on access to another object that implements \Drupal\Core\Access\AccessibleInterface. This interface simply provides the getter method for the access dependency object. Objects that implement this interface are responsible for checking access of the access dependency because the dependency may not take effect in all cases. For instance an entity may only need the access dependency set when it is embedded within another entity and its access should be dependent on access to the entity in which it is embedded.

To check the access to the dependency the object implementing this interface can use code like this:

$accessible
  ->getAccessDependency()
  ->access($op, $account, TRUE);

@internal

Hierarchy

• interface \Drupal\block_content\Access\DependentAccessInterface

1 file declares its use of DependentAccessInterface

BlockContentAccessControlHandler.php in core/modules/block_content/src/BlockContentAccessControlHandler.php

File

core/modules/block_content/src/Access/DependentAccessInterface.php, line 25

Namespace

Drupal\block_content\Access

interface DependentAccessInterface {

  /**
   * Gets the access dependency.
   *
   * @return \Drupal\Core\Access\AccessibleInterface|null
   *   The access dependency or NULL if none has been set.
   */
  public function getAccessDependency();

}

Members

Name	Modifiers	Type	Description	Overrides
DependentAccessInterface::getAccessDependency	public	function	Gets the access dependency.