class ApiToken in API Tokens 8

Defines an API token annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\api_tokens\Annotation\ApiToken

4 classes are annotated with ApiToken

BlockApiToken in api_tokens_example/src/Plugin/ApiToken/BlockApiToken.php

Provides a Block API token.

DateApiToken in api_tokens_example/src/Plugin/ApiToken/DateApiToken.php

Provides a Date API token.

NodeApiToken in api_tokens_example/src/Plugin/ApiToken/NodeApiToken.php

Provides a Node API token.

UserLinkApiToken in api_tokens_example/src/Plugin/ApiToken/UserLinkApiToken.php

Provides a User Link API token.

File

src/Annotation/ApiToken.php, line 12

Namespace

Drupal\api_tokens\Annotation

class ApiToken extends Plugin {

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

  /**
   * The administrative label of the API token.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The administrative description of the API token.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation (optional)
   */
  public $description = '';

}

Members

Name	Modifiers	Type	Description	Overrides
ApiToken::$description	public	property	The administrative description of the API token.
ApiToken::$id	public	property	The API token ID.
ApiToken::$label	public	property	The administrative label of the API token.
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