class MenuLinkContent in Zircon Profile 8
Same name in this branch
- 8 core/modules/menu_link_content/src/Entity/MenuLinkContent.php \Drupal\menu_link_content\Entity\MenuLinkContent
- 8 core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent
Same name and namespace in other branches
- 8.0 core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent
Provides the menu link plugin for content menu links.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Menu\MenuLinkBase implements MenuLinkInterface
- class \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent implements ContainerFactoryPluginInterface
- class \Drupal\Core\Menu\MenuLinkBase implements MenuLinkInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of MenuLinkContent
1 string reference to 'MenuLinkContent'
- menu_link_content.links.menu.yml in core/
modules/ menu_link_content/ menu_link_content.links.menu.yml - core/modules/menu_link_content/menu_link_content.links.menu.yml
File
- core/
modules/ menu_link_content/ src/ Plugin/ Menu/ MenuLinkContent.php, line 20 - Contains \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent.
Namespace
Drupal\menu_link_content\Plugin\MenuView source
class MenuLinkContent extends MenuLinkBase implements ContainerFactoryPluginInterface {
/**
* Entities IDs to load.
*
* It is an array of entity IDs keyed by entity IDs.
*
* @var array
*/
protected static $entityIdsToLoad = array();
/**
* {@inheritdoc}
*/
protected $overrideAllowed = array(
'menu_name' => 1,
'parent' => 1,
'weight' => 1,
'expanded' => 1,
'enabled' => 1,
'title' => 1,
'description' => 1,
'route_name' => 1,
'route_parameters' => 1,
'url' => 1,
'options' => 1,
);
/**
* The menu link content entity connected to this plugin instance.
*
* @var \Drupal\menu_link_content\MenuLinkContentInterface
*/
protected $entity;
/**
* The entity manager.
*
* @var \Drupal\Core\Entity\EntityManagerInterface
*/
protected $entityManager;
/**
* The language manager.
*
* @var \Drupal\Core\Language\LanguageManagerInterface
*/
protected $languageManager;
/**
* Constructs a new MenuLinkContent.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
* The entity manager.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager, LanguageManagerInterface $language_manager) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
if (!empty($this->pluginDefinition['metadata']['entity_id'])) {
$entity_id = $this->pluginDefinition['metadata']['entity_id'];
// Builds a list of entity IDs to take advantage of the more efficient
// EntityStorageInterface::loadMultiple() in getEntity() at render time.
static::$entityIdsToLoad[$entity_id] = $entity_id;
}
$this->entityManager = $entity_manager;
$this->languageManager = $language_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity.manager'), $container
->get('language_manager'));
}
/**
* Loads the entity associated with this menu link.
*
* @return \Drupal\menu_link_content\MenuLinkContentInterface
* The menu link content entity.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* If the entity ID and UUID are both invalid or missing.
*/
protected function getEntity() {
if (empty($this->entity)) {
$entity = NULL;
$storage = $this->entityManager
->getStorage('menu_link_content');
if (!empty($this->pluginDefinition['metadata']['entity_id'])) {
$entity_id = $this->pluginDefinition['metadata']['entity_id'];
// Make sure the current ID is in the list, since each plugin empties
// the list after calling loadMultiple(). Note that the list may include
// multiple IDs added earlier in each plugin's constructor.
static::$entityIdsToLoad[$entity_id] = $entity_id;
$entities = $storage
->loadMultiple(array_values(static::$entityIdsToLoad));
$entity = isset($entities[$entity_id]) ? $entities[$entity_id] : NULL;
static::$entityIdsToLoad = array();
}
if (!$entity) {
// Fallback to the loading by the UUID.
$uuid = $this
->getUuid();
$loaded_entities = $storage
->loadByProperties(array(
'uuid' => $uuid,
));
$entity = reset($loaded_entities);
}
if (!$entity) {
throw new PluginException("Entity not found through the menu link plugin definition and could not fallback on UUID '{$uuid}'");
}
// Clone the entity object to avoid tampering with the static cache.
$this->entity = clone $entity;
$the_entity = $this->entityManager
->getTranslationFromContext($this->entity);
/** @var \Drupal\menu_link_content\MenuLinkContentInterface $the_entity */
$this->entity = $the_entity;
$this->entity
->setInsidePlugin();
}
return $this->entity;
}
/**
* {@inheritdoc}
*/
public function getTitle() {
// We only need to get the title from the actual entity if it may be a
// translation based on the current language context. This can only happen
// if the site is configured to be multilingual.
if ($this->languageManager
->isMultilingual()) {
return $this
->getEntity()
->getTitle();
}
return $this->pluginDefinition['title'];
}
/**
* {@inheritdoc}
*/
public function getDescription() {
// We only need to get the description from the actual entity if it may be a
// translation based on the current language context. This can only happen
// if the site is configured to be multilingual.
if ($this->languageManager
->isMultilingual()) {
return $this
->getEntity()
->getDescription();
}
return $this->pluginDefinition['description'];
}
/**
* {@inheritdoc}
*/
public function getDeleteRoute() {
return $this
->getEntity()
->urlInfo('delete-form');
}
/**
* {@inheritdoc}
*/
public function getEditRoute() {
return $this
->getEntity()
->urlInfo();
}
/**
* {@inheritdoc}
*/
public function getTranslateRoute() {
return $this
->getEntity()
->urlInfo('drupal:content-translation-overview');
}
/**
* Returns the unique ID representing the menu link.
*
* @return string
* The menu link ID.
*/
protected function getUuid() {
$this
->getDerivativeId();
}
/**
* {@inheritdoc}
*/
public function updateLink(array $new_definition_values, $persist) {
// Filter the list of updates to only those that are allowed.
$overrides = array_intersect_key($new_definition_values, $this->overrideAllowed);
// Update the definition.
$this->pluginDefinition = $overrides + $this
->getPluginDefinition();
if ($persist) {
$entity = $this
->getEntity();
foreach ($overrides as $key => $value) {
$entity->{$key}->value = $value;
}
$this->entityManager
->getStorage('menu_link_content')
->save($entity);
}
return $this->pluginDefinition;
}
/**
* {@inheritdoc}
*/
public function isDeletable() {
return TRUE;
}
/**
* {@inheritdoc}
*/
public function isTranslatable() {
return $this
->getEntity()
->isTranslatable();
}
/**
* {@inheritdoc}
*/
public function deleteLink() {
$this
->getEntity()
->delete();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MenuLinkBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
3 |
MenuLinkBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
2 |
MenuLinkBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
2 |
MenuLinkBase:: |
public | function |
Returns the name of a class that can build an editing form for this link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the menu name of the menu link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns any metadata for this link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the options for this link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the plugin ID of the menu link's parent, or an empty string. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the provider (module name) of the menu link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the route name, if available. Overrides MenuLinkInterface:: |
2 |
MenuLinkBase:: |
public | function |
Returns the route parameters, if available. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns a URL object containing either the external path or route. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the weight of the menu link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns whether the menu link is enabled (not hidden). Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns whether the child menu links should always been shown. Overrides MenuLinkInterface:: |
1 |
MenuLinkBase:: |
public | function |
Returns whether this link can be reset. Overrides MenuLinkInterface:: |
1 |
MenuLinkContent:: |
protected | property | The menu link content entity connected to this plugin instance. | |
MenuLinkContent:: |
protected static | property | Entities IDs to load. | |
MenuLinkContent:: |
protected | property | The entity manager. | |
MenuLinkContent:: |
protected | property | The language manager. | |
MenuLinkContent:: |
protected | property |
The list of definition values where an override is allowed. Overrides MenuLinkBase:: |
|
MenuLinkContent:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
MenuLinkContent:: |
public | function |
Deletes a menu link. Overrides MenuLinkBase:: |
|
MenuLinkContent:: |
public | function |
Returns route information for a route to delete the menu link. Overrides MenuLinkBase:: |
|
MenuLinkContent:: |
public | function |
Returns the description of the menu link. Overrides MenuLinkInterface:: |
|
MenuLinkContent:: |
public | function |
Returns route information for a custom edit form for the menu link. Overrides MenuLinkBase:: |
|
MenuLinkContent:: |
protected | function | Loads the entity associated with this menu link. | |
MenuLinkContent:: |
public | function |
Returns the localized title to be shown for this link. Overrides MenuLinkInterface:: |
|
MenuLinkContent:: |
public | function |
Returns route information for a route to translate the menu link. Overrides MenuLinkBase:: |
|
MenuLinkContent:: |
protected | function | Returns the unique ID representing the menu link. | |
MenuLinkContent:: |
public | function |
Returns whether this link can be deleted. Overrides MenuLinkBase:: |
|
MenuLinkContent:: |
public | function |
Returns whether this link can be translated. Overrides MenuLinkBase:: |
|
MenuLinkContent:: |
public | function |
Updates the definition values for a menu link. Overrides MenuLinkInterface:: |
|
MenuLinkContent:: |
public | function |
Constructs a new MenuLinkContent. Overrides PluginBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |