class MetadataGenerator in Drupal 10
Same name and namespace in other branches
- 8 core/modules/quickedit/src/MetadataGenerator.php \Drupal\quickedit\MetadataGenerator
- 9 core/modules/quickedit/src/MetadataGenerator.php \Drupal\quickedit\MetadataGenerator
Generates in-place editing metadata for an entity field.
Hierarchy
- class \Drupal\quickedit\MetadataGenerator implements \Drupal\quickedit\MetadataGeneratorInterface
Expanded class hierarchy of MetadataGenerator
1 file declares its use of MetadataGenerator
- MetadataGeneratorTest.php in core/
modules/ quickedit/ tests/ src/ Kernel/ MetadataGeneratorTest.php
1 string reference to 'MetadataGenerator'
- quickedit.services.yml in core/
modules/ quickedit/ quickedit.services.yml - core/modules/quickedit/quickedit.services.yml
1 service uses MetadataGenerator
- quickedit.metadata.generator in core/
modules/ quickedit/ quickedit.services.yml - Drupal\quickedit\MetadataGenerator
File
- core/
modules/ quickedit/ src/ MetadataGenerator.php, line 15
Namespace
Drupal\quickeditView source
class MetadataGenerator implements MetadataGeneratorInterface {
/**
* An object that checks if a user has access to edit a given entity field.
*
* @var \Drupal\quickedit\Access\QuickEditEntityFieldAccessCheckInterface
*/
protected $accessChecker;
/**
* An object that determines which editor to attach to a given field.
*
* @var \Drupal\quickedit\EditorSelectorInterface
*/
protected $editorSelector;
/**
* The manager for editor plugins.
*
* @var \Drupal\Component\Plugin\PluginManagerInterface
*/
protected $editorManager;
/**
* Constructs a new MetadataGenerator.
*
* @param \Drupal\quickedit\Access\QuickEditEntityFieldAccessCheckInterface $access_checker
* An object that checks if a user has access to edit a given field.
* @param \Drupal\quickedit\EditorSelectorInterface $editor_selector
* An object that determines which editor to attach to a given field.
* @param \Drupal\Component\Plugin\PluginManagerInterface $editor_manager
* The manager for editor plugins.
*/
public function __construct(QuickEditEntityFieldAccessCheckInterface $access_checker, EditorSelectorInterface $editor_selector, PluginManagerInterface $editor_manager) {
$this->accessChecker = $access_checker;
$this->editorSelector = $editor_selector;
$this->editorManager = $editor_manager;
}
/**
* {@inheritdoc}
*/
public function generateEntityMetadata(EntityInterface $entity) {
return [
'label' => $entity
->access('view label') ? $entity
->label() : new TranslatableMarkup('@label @id', [
'@label' => $entity
->getEntityType()
->getSingularLabel(),
'@id' => $entity
->id(),
]),
];
}
/**
* {@inheritdoc}
*/
public function generateFieldMetadata(FieldItemListInterface $items, $view_mode) {
$entity = $items
->getEntity();
$field_name = $items
->getFieldDefinition()
->getName();
// Early-return if user does not have access.
$access = $this->accessChecker
->accessEditEntityField($entity, $field_name);
if (!$access
->isAllowed()) {
return [
'access' => FALSE,
];
}
// Early-return if no editor is available.
$formatter_id = EntityViewDisplay::collectRenderDisplay($entity, $view_mode)
->getRenderer($field_name)
->getPluginId();
$editor_id = $this->editorSelector
->getEditor($formatter_id, $items);
if (!isset($editor_id)) {
return [
'access' => FALSE,
];
}
// Gather metadata, allow the editor to add additional metadata of its own.
$label = $items
->getFieldDefinition()
->getLabel();
$editor = $this->editorManager
->createInstance($editor_id);
$metadata = [
'label' => $label,
'access' => TRUE,
'editor' => $editor_id,
];
$custom_metadata = $editor
->getMetadata($items);
if (count($custom_metadata)) {
$metadata['custom'] = $custom_metadata;
}
return $metadata;
}
}