You are here

class EntityHandler in CMS Content Sync 8

Same name and namespace in other branches
  1. 2.1.x src/Annotation/EntityHandler.php \Drupal\cms_content_sync\Annotation\EntityHandler
  2. 2.0.x src/Annotation/EntityHandler.php \Drupal\cms_content_sync\Annotation\EntityHandler

Defines a EntityHandler annotation object.

They handle how entity synchronizations are configured and how they eventually behave on pull and push.

Additional annotation keys for handlers can be defined in hook_cms_content_sync_entity_handler_info_alter().

Hierarchy

Expanded class hierarchy of EntityHandler

See also

\Drupal\Core\Field\HandlerPluginManager

\Drupal\Core\Field\HandlerInterface

8 classes are annotated with EntityHandler
DefaultConfigEntityHandler in src/Plugin/cms_content_sync/entity_handler/DefaultConfigEntityHandler.php
Class DefaultConfigEntityHandler, providing a minimalistic implementation for any config entity type.
DefaultContentEntityHandler in src/Plugin/cms_content_sync/entity_handler/DefaultContentEntityHandler.php
Class DefaultContentEntityHandler, providing a minimalistic implementation for any content entity type.
DefaultCropHandler in src/Plugin/cms_content_sync/entity_handler/DefaultCropHandler.php
Class DefaultCropHandler, providing a minimalistic implementation for the crop entity type.
DefaultFieldCollectionItemHandler in src/Plugin/cms_content_sync/entity_handler/DefaultFieldCollectionItemHandler.php
Class DefaultFieldCollectionItemHandler.
DefaultMediaHandler in src/Plugin/cms_content_sync/entity_handler/DefaultMediaHandler.php
Class DefaultMediaHandler, providing a minimalistic implementation for the media entity type.

... See full list

File

src/Annotation/EntityHandler.php, line 23

Namespace

Drupal\cms_content_sync\Annotation
View source
class EntityHandler extends Plugin {

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

  /**
   * The human-readable name of the handler type.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The name of the handler class.
   *
   * This is not provided manually, it will be added by the discovery mechanism.
   *
   * @var string
   */
  public $class;

  /**
   * The weight.
   *
   * An integer to determine the weight of this handler relative to other
   * handlers in the Field UI when selecting a handler for a given field.
   *
   * @var intoptional
   */
  public $weight;

}

Members

Namesort descending Modifiers Type Description Overrides
EntityHandler::$class public property The name of the handler class.
EntityHandler::$id public property The plugin ID.
EntityHandler::$label public property The human-readable name of the handler type.
EntityHandler::$weight public property The weight.
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