You are here

FieldState.php in Field States UI 8.2

Same filename and directory in other branches
  1. 8 src/Annotation/FieldState.php

File

src/Annotation/FieldState.php
View source
<?php

namespace Drupal\field_states_ui\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * Defines a field state annotation object.
 *
 * Plugin Namespace: Plugin\FieldState.
 *
 * For a working example, see
 * \Drupal\field_states_ui\Plugin\FieldState\Visible
 *
 * @see \Drupal\field_states_ui\FieldStateInterface
 * @see \Drupal\field_states_ui\FieldStateBase
 * @see \Drupal\field_states_ui\FieldStateManager
 * @see plugin_api
 *
 * @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;

}

Classes

Namesort descending Description
FieldState Defines a field state annotation object.