Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

DependentAccessInterface.php

Namespace

Drupal\block_content\Access

File

core/modules/block_content/src/Access/DependentAccessInterface.php

View source
<?php

namespace Drupal\block_content\Access;


/**
 * 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:
 * @code
 * $accessible->getAccessDependency()->access($op, $account, TRUE);
 * @endcode
 *
 * @internal
 */
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();

}

Interfaces

Title Deprecated Summary
DependentAccessInterface Interface for AccessibleInterface objects that have an access dependency.

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal