class CropEntityProvider in Crop API 8

Defines the annotation object for crop integration with storage entities.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\crop\Annotation\CropEntityProvider

See also

hook_crop_entity_provider_info_alter()

2 classes are annotated with CropEntityProvider

File in src/Plugin/Crop/EntityProvider/File.php

File crop integration.

Media in src/Plugin/Crop/EntityProvider/Media.php

Media crop integration.

File

src/Annotation/CropEntityProvider.php, line 14

Namespace

Drupal\crop\Annotation

class CropEntityProvider extends Plugin {

  /**
   * Entity type plugin provides.
   *
   * @var string
   */
  public $entity_type;

  /**
   * The human-readable name of the crop entity provider.
   *
   * Will usually match entity type name.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * A brief description of the crop entity provider.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * {@inheritdoc}
   */
  public function getId() {
    return $this->definition['entity_type'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CropEntityProvider::$description	public	property	A brief description of the crop entity provider.
CropEntityProvider::$entity_type	public	property	Entity type plugin provides.
CropEntityProvider::$label	public	property	The human-readable name of the crop entity provider.
CropEntityProvider::getId	public	function	Gets the unique ID for this annotated class. Overrides Plugin::getId
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::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