Same name in other branches
  1. 8.x-2.x src/Annotation/FieldState.php \Drupal\field_states_ui\Annotation\FieldState

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\field_states_ui\Annotation\FieldState extends \Drupal\Component\Annotation\Plugin

Expanded class hierarchy of 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
View source 
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

Title Modifiers Object type Summary
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.