class RoleAccessConsumer in Role Access Control 8

Defines AccessProvider Anotation object.

Base AccessProvider supplies default AccessProvider structure for use with Search API Reference objects.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\rac\RoleAccessConsumer implements RoleAccessConsumerInterface

See also

\Drupal\rac\RoleAccessConsumerInterface

3 files declare their use of RoleAccessConsumer

FieldCollectionAccessRoleAccessConsumer.php in contrib/rac_fca/src/Plugin/rac/RoleAccessConsumer/FieldCollectionAccessRoleAccessConsumer.php

NodeRoleAccessConsumer.php in contrib/rac_na/src/Plugin/rac/RoleAccessConsumer/NodeRoleAccessConsumer.php

ParagraphsAccessRoleAccessConsumer.php in contrib/rac_pa/src/Plugin/rac/RoleAccessConsumer/ParagraphsAccessRoleAccessConsumer.php

3 classes are annotated with RoleAccessConsumer

FieldCollectionAccessRoleAccessConsumer in contrib/rac_fca/src/Plugin/rac/RoleAccessConsumer/FieldCollectionAccessRoleAccessConsumer.php

Defines Entity Types controlled by module.

NodeRoleAccessConsumer in contrib/rac_na/src/Plugin/rac/RoleAccessConsumer/NodeRoleAccessConsumer.php

Defines Entity Types controlled by module.

ParagraphsAccessRoleAccessConsumer in contrib/rac_pa/src/Plugin/rac/RoleAccessConsumer/ParagraphsAccessRoleAccessConsumer.php

Defines Entity Types controlled by module.

File

src/RoleAccessConsumer.php, line 19

Namespace

Drupal\rac

class RoleAccessConsumer extends Plugin implements RoleAccessConsumerInterface {

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

  /**
   * The human-readable name of the formatter type.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * A short description of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * {@inheritdoc}
   */
  public function getSupportedEntityTypes() {
    return [];
  }

}

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
RoleAccessConsumer::$description	public	property	A short description of the plugin.
RoleAccessConsumer::$id	public	property	The plugin ID.
RoleAccessConsumer::$label	public	property	The human-readable name of the formatter type.
RoleAccessConsumer::getSupportedEntityTypes	public	function	Retrieve the entity types for which access is controlled. Overrides RoleAccessConsumerInterface::getSupportedEntityTypes	3