class ConsentStorage in EU Cookie Compliance (GDPR Compliance) 8

Defines a consent storage annotation object.

Plugin Namespace: Plugin\ConsentStorage.

For a working example, see \Drupal\eu_cookie_compliance\Plugin\ConsentStorage\BasicConsentStorage/registerConsent

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\eu_cookie_compliance\Annotation\ConsentStorage

See also

hook_eu_cookie_compliance_consent_storage_info_alter()

\Drupal\eu_cookie_compliance\Plugin\ConsentStorageInterface

\Drupal\eu_cookie_compliance\Plugin\ConsentStorageBase

\Drupal\eu_cookie_compliance\Plugin\ConsentStorageManager

Plugin API

1 class is annotated with ConsentStorage

BasicConsentStorage in src/Plugin/ConsentStorage/BasicConsentStorage.php

Provides a database storage for cookie consents.

File

src/Annotation/ConsentStorage.php, line 23

Namespace

Drupal\eu_cookie_compliance\Annotation

class ConsentStorage extends Plugin {

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

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

  /**
   * A brief description of the consent storage.
   *
   * This will be shown when adding or configuring this consent storage.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

}

Members

Name	Modifiers	Type	Description	Overrides
ConsentStorage::$description	public	property	A brief description of the consent storage.
ConsentStorage::$id	public	property	The plugin ID.
ConsentStorage::$label	public	property	The human-readable name of the consent storage.
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