class FieldState in Field States UI 8

Defines a field state annotation object.

Plugin Namespace: Plugin\FieldState.

For a working example, see \Drupal\field_states_ui\Plugin\FieldState\Visible

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\field_states_ui\Annotation\FieldState

See also

\Drupal\field_states_ui\FieldStateInterface

\Drupal\field_states_ui\FieldStateBase

\Drupal\field_states_ui\FieldStateManager

Plugin API

10 classes are annotated with FieldState

Checked in src/Plugin/FieldState/Checked.php

Controls checkbox field widget checked state in relation to other fields.

Collapsed in src/Plugin/FieldState/Collapsed.php

Controls details field widget collapsed state in relation to other fields.

Disabled in src/Plugin/FieldState/Disabled.php

Controls field widget disabled state in relation to other fields dynamically.

Enabled in src/Plugin/FieldState/Enabled.php

Controls field widget enabled state in relation to other fields dynamically.

Expanded in src/Plugin/FieldState/Expanded.php

Controls details field widget expanded state in relation to other fields.

... See full list

File

src/Annotation/FieldState.php, line 22

Namespace

Drupal\field_states_ui\Annotation

class FieldState extends Plugin {

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

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

  /**
   * Optional: a brief description of the field state.
   *
   * This will be shown when adding or configuring this field state.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

}

Members

Name	Modifiers	Type	Description	Overrides
FieldState::$description	public	property	Optional: a brief description of the field state.
FieldState::$id	public	property	The plugin ID.
FieldState::$label	public	property	The human-readable name of the field state.
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