class KeyInput in Key 8

Defines a key input annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\key\Annotation\KeyInput

5 classes are annotated with KeyInput

GenerateKeyInput in src/Plugin/KeyInput/GenerateKeyInput.php

Defines a key input that generates a key value.

MutliValueKeyInput in tests/modules/key_test/src/Plugin/KeyInput/MutliValueKeyInput.php

Defines a multi-value key input class.

NoneKeyInput in src/Plugin/KeyInput/NoneKeyInput.php

Defines a key input for providers that don't accept a value.

TextareaFieldKeyInput in src/Plugin/KeyInput/TextareaFieldKeyInput.php

Defines a key input that provides a simple text field.

TextFieldKeyInput in src/Plugin/KeyInput/TextFieldKeyInput.php

Defines a key input that provides a simple text field.

File

src/Annotation/KeyInput.php, line 12

Namespace

Drupal\key\Annotation

class KeyInput extends Plugin {

  /**
   * The plugin ID of the key input.
   *
   * @var string
   */
  public $id;

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

  /**
   * The description of the key input.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

}

Members

Name	Modifiers	Type	Description	Overrides
KeyInput::$description	public	property	The description of the key input.
KeyInput::$id	public	property	The plugin ID of the key input.
KeyInput::$label	public	property	The human-readable name of the key input.
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