class CommerceEntityTrait in Commerce Core 8.2

Defines the entity trait plugin annotation object.

Plugin namespace: Plugin\Commerce\EntityTrait.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\commerce\Annotation\CommerceEntityTrait

See also

Plugin API

2 classes are annotated with CommerceEntityTrait

First in tests/modules/commerce_test/src/Plugin/Commerce/EntityTrait/First.php

Provides the first entity trait.

Second in tests/modules/commerce_test/src/Plugin/Commerce/EntityTrait/Second.php

Provides the second entity trait.

File

src/Annotation/CommerceEntityTrait.php, line 16

Namespace

Drupal\commerce\Annotation

class CommerceEntityTrait extends Plugin {

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

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

  /**
   * The content entity types that can have this trait.
   *
   * The bundle entities of the content entity type will reference the trait,
   * and receive any fields it defines.
   *
   * When empty, defaults to all content entity types.
   *
   * @var array
   */
  public $entity_types;

}

Members

Name	Modifiers	Type	Description	Overrides
CommerceEntityTrait::$entity_types	public	property	The content entity types that can have this trait.
CommerceEntityTrait::$id	public	property	The plugin ID.
CommerceEntityTrait::$label	public	property	The plugin label.
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