class FieldTypeExport in Entity Export CSV 8

Defines a Field type export item annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\entity_export_csv\Annotation\FieldTypeExport

See also

\Drupal\entity_export_csv\Plugin\FieldTypeExportManager

Plugin API

10 classes are annotated with FieldTypeExport

AddressExport in src/Plugin/FieldTypeExport/AddressExport.php

Defines an Address field type export plugin.

DateRangeExport in src/Plugin/FieldTypeExport/DateRangeExport.php

Defines a Date range field type export plugin.

DateTimeExport in src/Plugin/FieldTypeExport/DateTimeExport.php

Defines a Datetime field type export plugin.

DefaultExport in src/Plugin/FieldTypeExport/DefaultExport.php

Defines a default field type export plugin.

EntityReferenceExport in src/Plugin/FieldTypeExport/EntityReferenceExport.php

Defines an Entity Reference field type export plugin.

... See full list

File

src/Annotation/FieldTypeExport.php, line 15

Namespace

Drupal\entity_export_csv\Annotation

class FieldTypeExport extends Plugin {

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

  /**
   * The label of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The weight of the plugin.
   *
   * @var int
   */
  public $weight = 0;

  /**
   * The plugin description.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The field types on which the plugin apply.
   *
   * @var array
   */
  public $field_type = [];

  /**
   * The entity type ids on which the plugin apply.
   *
   * @var array
   */
  public $entity_type = [];

  /**
   * The bundles on which the plugin apply.
   *
   * @var array
   */
  public $bundle = [];

  /**
   * The field name on which the plugin apply.
   *
   * @var array
   */
  public $field_name = [];

  /**
   * The first exclusive plugin found win and is the only one available.
   *
   * @var bool
   */
  public $exclusive = FALSE;

}

Members

Name	Modifiers	Type	Description	Overrides
FieldTypeExport::$bundle	public	property	The bundles on which the plugin apply.
FieldTypeExport::$description	public	property	The plugin description.
FieldTypeExport::$entity_type	public	property	The entity type ids on which the plugin apply.
FieldTypeExport::$exclusive	public	property	The first exclusive plugin found win and is the only one available.
FieldTypeExport::$field_name	public	property	The field name on which the plugin apply.
FieldTypeExport::$field_type	public	property	The field types on which the plugin apply.
FieldTypeExport::$id	public	property	The plugin ID.
FieldTypeExport::$label	public	property	The label of the plugin.
FieldTypeExport::$weight	public	property	The weight of the plugin.
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