class FieldHandler in CMS Content Sync 2.1.x
Same name and namespace in other branches
- 8 src/Annotation/FieldHandler.php \Drupal\cms_content_sync\Annotation\FieldHandler
- 2.0.x src/Annotation/FieldHandler.php \Drupal\cms_content_sync\Annotation\FieldHandler
Defines a FieldHandler annotation object.
They handle how field 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
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\cms_content_sync\Annotation\FieldHandler
Expanded class hierarchy of FieldHandler
See also
\Drupal\Core\Field\HandlerPluginManager
\Drupal\Core\Field\HandlerInterface
16 classes are annotated with FieldHandler
- DefaultBricksHandler in src/
Plugin/ cms_content_sync/ field_handler/ DefaultBricksHandler.php - Providing a minimalistic implementation for any field type.
- DefaultEntityReferenceHandler in src/
Plugin/ cms_content_sync/ field_handler/ DefaultEntityReferenceHandler.php - Providing a minimalistic implementation for any field type.
- DefaultFieldCollectionHandler in src/
Plugin/ cms_content_sync/ field_handler/ DefaultFieldCollectionHandler.php - Providing a minimalistic implementation for any field type.
- DefaultFieldHandler in src/
Plugin/ cms_content_sync/ field_handler/ DefaultFieldHandler.php - Providing a minimalistic implementation for any field type.
- DefaultFileHandler in src/
Plugin/ cms_content_sync/ field_handler/ DefaultFileHandler.php - Providing a minimalistic implementation for any field type.
File
- src/
Annotation/ FieldHandler.php, line 23
Namespace
Drupal\cms_content_sync\AnnotationView source
class FieldHandler 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;
/**
* A short description of the handler type.
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $description;
/**
* 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
* handlersin the Field UI when selecting a handler for a given field.
*
* @var intoptional
*/
public $weight;
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
FieldHandler:: |
public | property | The name of the handler class. | |
FieldHandler:: |
public | property | A short description of the handler type. | |
FieldHandler:: |
public | property | The plugin ID. | |
FieldHandler:: |
public | property | The human-readable name of the handler type. | |
FieldHandler:: |
public | property | The weight. | |
Plugin:: |
protected | property | The plugin definition read from the class annotation. | 1 |
Plugin:: |
public | function |
Gets the value of an annotation. Overrides AnnotationInterface:: |
5 |
Plugin:: |
public | function |
Gets the class of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Gets the unique ID for this annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Gets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
1 |
Plugin:: |
protected | function | Parses an annotation into its definition. | |
Plugin:: |
public | function |
Sets the class of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Sets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function | Constructs a Plugin object. | 2 |