View source
<?php
namespace Drupal\menu_link_content\Entity;
use Drupal\Core\Entity\EditorialContentEntityBase;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\link\LinkItemInterface;
use Drupal\menu_link_content\MenuLinkContentInterface;
class MenuLinkContent extends EditorialContentEntityBase implements MenuLinkContentInterface {
protected $insidePlugin = FALSE;
public function setInsidePlugin() {
$this->insidePlugin = TRUE;
}
public function getTitle() {
return $this
->get('title')->value;
}
public function getUrlObject() {
return $this->link
->first()
->getUrl();
}
public function getMenuName() {
return $this
->get('menu_name')->value;
}
public function getDescription() {
return $this
->get('description')->value;
}
public function getPluginId() {
return 'menu_link_content:' . $this
->uuid();
}
public function isEnabled() {
return (bool) $this
->get('enabled')->value;
}
public function isExpanded() {
return (bool) $this
->get('expanded')->value;
}
public function getParentId() {
return (string) $this
->get('parent')->value;
}
public function getWeight() {
return (int) $this
->get('weight')->value;
}
public function getPluginDefinition() {
$definition = [];
$definition['class'] = 'Drupal\\menu_link_content\\Plugin\\Menu\\MenuLinkContent';
$definition['menu_name'] = $this
->getMenuName();
if ($url_object = $this
->getUrlObject()) {
$definition['url'] = NULL;
$definition['route_name'] = NULL;
$definition['route_parameters'] = [];
if (!$url_object
->isRouted()) {
$definition['url'] = $url_object
->getUri();
}
else {
$definition['route_name'] = $url_object
->getRouteName();
$definition['route_parameters'] = $url_object
->getRouteParameters();
}
$definition['options'] = $url_object
->getOptions();
}
$definition['title'] = $this
->getTitle();
$definition['description'] = $this
->getDescription();
$definition['weight'] = $this
->getWeight();
$definition['id'] = $this
->getPluginId();
$definition['metadata'] = [
'entity_id' => $this
->id(),
];
$definition['form_class'] = '\\Drupal\\menu_link_content\\Form\\MenuLinkContentForm';
$definition['enabled'] = $this
->isEnabled() ? 1 : 0;
$definition['expanded'] = $this
->isExpanded() ? 1 : 0;
$definition['provider'] = 'menu_link_content';
$definition['discovered'] = 0;
$definition['parent'] = $this
->getParentId();
return $definition;
}
public static function preCreate(EntityStorageInterface $storage, array &$values) {
$values += [
'bundle' => 'menu_link_content',
];
}
public function preSave(EntityStorageInterface $storage) {
parent::preSave($storage);
if (parse_url($this->link->uri, PHP_URL_SCHEME) === 'internal') {
$this
->setRequiresRediscovery(TRUE);
}
else {
$this
->setRequiresRediscovery(FALSE);
}
}
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
if (!$this
->isDefaultRevision()) {
return;
}
$menu_link_manager = \Drupal::service('plugin.manager.menu.link');
$definition = $this
->getPluginDefinition();
if ($menu_link_manager
->getDefinition($this
->getPluginId(), FALSE)) {
if (!$this->insidePlugin) {
$menu_link_manager
->updateDefinition($this
->getPluginId(), $definition, FALSE);
}
}
else {
$menu_link_manager
->addDefinition($this
->getPluginId(), $definition);
}
}
public static function preDelete(EntityStorageInterface $storage, array $entities) {
parent::preDelete($storage, $entities);
$menu_link_manager = \Drupal::service('plugin.manager.menu.link');
foreach ($entities as $menu_link) {
$menu_link_manager
->removeDefinition($menu_link
->getPluginId(), FALSE);
$parent_plugin_id = $menu_link
->getParentId();
$children = $storage
->loadByProperties([
'parent' => $menu_link
->getPluginId(),
]);
foreach ($children as $child) {
$child
->set('parent', $parent_plugin_id)
->save();
}
}
}
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields += static::publishedBaseFieldDefinitions($entity_type);
$fields['id']
->setLabel(t('Entity ID'))
->setDescription(t('The entity ID for this menu link content entity.'));
$fields['uuid']
->setDescription(t('The content menu link UUID.'));
$fields['langcode']
->setDescription(t('The menu link language code.'));
$fields['bundle']
->setDescription(t('The content menu link bundle.'))
->setSetting('max_length', EntityTypeInterface::BUNDLE_MAX_LENGTH)
->setSetting('is_ascii', TRUE);
$fields['title'] = BaseFieldDefinition::create('string')
->setLabel(t('Menu link title'))
->setDescription(t('The text to be used for this link in the menu.'))
->setRequired(TRUE)
->setTranslatable(TRUE)
->setRevisionable(TRUE)
->setSetting('max_length', 255)
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'string',
'weight' => -5,
])
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => -5,
])
->setDisplayConfigurable('form', TRUE);
$fields['description'] = BaseFieldDefinition::create('string')
->setLabel(t('Description'))
->setDescription(t('Shown when hovering over the menu link.'))
->setTranslatable(TRUE)
->setRevisionable(TRUE)
->setSetting('max_length', 255)
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'string',
'weight' => 0,
])
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => 0,
]);
$fields['menu_name'] = BaseFieldDefinition::create('string')
->setLabel(t('Menu name'))
->setDescription(t('The menu name. All links with the same menu name (such as "tools") are part of the same menu.'))
->setDefaultValue('tools')
->setSetting('is_ascii', TRUE);
$fields['link'] = BaseFieldDefinition::create('link')
->setLabel(t('Link'))
->setDescription(t('The location this menu link points to.'))
->setRevisionable(TRUE)
->setRequired(TRUE)
->setSettings([
'link_type' => LinkItemInterface::LINK_GENERIC,
'title' => DRUPAL_DISABLED,
])
->setDisplayOptions('form', [
'type' => 'link_default',
'weight' => -2,
]);
$fields['external'] = BaseFieldDefinition::create('boolean')
->setLabel(t('External'))
->setDescription(t('A flag to indicate if the link points to a full URL starting with a protocol, like http:// (1 = external, 0 = internal).'))
->setDefaultValue(FALSE)
->setRevisionable(TRUE);
$fields['rediscover'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Indicates whether the menu link should be rediscovered'))
->setDefaultValue(FALSE);
$fields['weight'] = BaseFieldDefinition::create('integer')
->setLabel(t('Weight'))
->setDescription(t('Link weight among links in the same menu at the same depth. In the menu, the links with high weight will sink and links with a low weight will be positioned nearer the top.'))
->setDefaultValue(0)
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'number_integer',
'weight' => 0,
])
->setDisplayOptions('form', [
'type' => 'number',
'weight' => 20,
]);
$fields['expanded'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Show as expanded'))
->setDescription(t('If selected and this menu link has children, the menu will always appear expanded. This option may be overridden for the entire menu tree when placing a menu block.'))
->setDefaultValue(FALSE)
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'boolean',
'weight' => 0,
])
->setDisplayOptions('form', [
'settings' => [
'display_label' => TRUE,
],
'weight' => 0,
]);
$fields['enabled']
->setLabel(t('Enabled'));
$fields['enabled']
->setDescription(t('A flag for whether the link should be enabled in menus or hidden.'));
$fields['enabled']
->setTranslatable(FALSE);
$fields['enabled']
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'boolean',
'weight' => 0,
]);
$fields['enabled']
->setDisplayOptions('form', [
'settings' => [
'display_label' => TRUE,
],
'weight' => -1,
]);
$fields['parent'] = BaseFieldDefinition::create('string')
->setLabel(t('Parent plugin ID'))
->setDescription(t('The ID of the parent menu link plugin, or empty string when at the top level of the hierarchy.'));
$fields['changed'] = BaseFieldDefinition::create('changed')
->setLabel(t('Changed'))
->setDescription(t('The time that the menu link was last edited.'))
->setTranslatable(TRUE)
->setRevisionable(TRUE);
$fields['revision_log_message']
->setDisplayOptions('form', [
'region' => 'hidden',
]);
return $fields;
}
public function requiresRediscovery() {
return $this
->get('rediscover')->value;
}
public function setRequiresRediscovery($rediscovery) {
$this
->set('rediscover', $rediscovery);
return $this;
}
}