<?php

namespace Drupal\custom_forms\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * Defines a custom forms field mapping plugin annotation object.
 *
 * @Annotation
 */
class CustomFormsFieldMapping extends Plugin {

  /**
   * The custom forms field mapping ID.
   *
   * @var string
   */
  public $id;

  /**
   * The custom forms field mapping name.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * A short description of the custom forms field mapping.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * The array of compatible custom forms field types that the mapping can be
   * used with.
   *
   * @var array
   */
  public $compatible_fields = [];

  /**
   * Whether this mapping plugin supports multiple values.
   *
   * @var bool
   */
  public $allow_multiple = FALSE;

  /**
   * Whether the value of the mapping is sensitive and should not be displayed
   * on list outputs.
   *
   * @var boolean
   */
  public $is_sensitive;

}