class ColorsScheme in Colors 8

Defines a Colors Scheme annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\colors\Annotation\ColorsScheme

5 classes are annotated with ColorsScheme

NodeScheme in src/Plugin/colors/type/NodeScheme.php

Provides colors for node types.

UserCurrentScheme in src/Plugin/colors/type/UserCurrentScheme.php

Provides colors for the current user.

UserRoleScheme in src/Plugin/colors/type/UserRoleScheme.php

Provides colors for user roles.

UserScheme in src/Plugin/colors/type/UserScheme.php

Provides colors for individual users.

VocabularyScheme in src/Plugin/colors/type/VocabularyScheme.php

Provides colors for taxonomy terms.

File

src/Annotation/ColorsScheme.php, line 12

Namespace

Drupal\colors\Annotation

class ColorsScheme extends Plugin {

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

  /**
   * The name of the module that defines this plugin.
   *
   * @var string
   */
  public $module;

  /**
   * The plugin name.
   *
   * @var string
   */
  public $title;

  /**
   * The parent category for the plugin.
   *
   * @var string (optional)
   */
  public $parent = '';

  /**
   * The default child of a parent category.
   *
   * @var boolean (optional)
   */
  public $default = FALSE;

  /**
   * The human-readable name of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation (optional)
   *
   * @ingroup plugin_translatable
   */
  public $label = '';

  /**
   * A short description of the mail plugin.
   *
   * @var \Drupal\Core\Annotation\Translation (optional)
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * The name of a callback function.
   *
   * @var string (optional)
   */
  public $callback = '';

  /**
   * The name of a callback function to retrieve multiple data.
   *
   * @var string (optional)
   */
  public $multiple = '';

  /**
   * A default weight for the scheme.
   *
   * @var int (optional)
   */
  public $weight = 0;

}

Members

Name	Modifiers	Type	Description	Overrides
ColorsScheme::$callback	public	property	The name of a callback function.
ColorsScheme::$default	public	property	The default child of a parent category.
ColorsScheme::$description	public	property	A short description of the mail plugin.
ColorsScheme::$id	public	property	The plugin ID.
ColorsScheme::$label	public	property	The human-readable name of the plugin.
ColorsScheme::$module	public	property	The name of the module that defines this plugin.
ColorsScheme::$multiple	public	property	The name of a callback function to retrieve multiple data.
ColorsScheme::$parent	public	property	The parent category for the plugin.
ColorsScheme::$title	public	property	The plugin name.
ColorsScheme::$weight	public	property	A default weight for the scheme.
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