class Menu
Defines the Menu configuration entity class.
Attributes
#[ConfigEntityType(id: 'menu', label: new TranslatableMarkup('Menu'), label_collection: new TranslatableMarkup('Menus'), label_singular: new TranslatableMarkup('menu'), label_plural: new TranslatableMarkup('menus'), entity_keys: [
'id' => 'id',
'label' => 'label',
], handlers: [
'access' => MenuAccessControlHandler::class,
'storage' => MenuStorage::class,
], admin_permission: 'administer menu', label_count: [
'singular' => '@count menu',
'plural' => '@count menus',
], config_export: [
'id',
'label',
'description',
'locked',
])]
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
- class \Drupal\system\Entity\Menu implements \Drupal\system\MenuInterface extends \Drupal\Core\Config\Entity\ConfigEntityBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
Expanded class hierarchy of Menu
23 files declare their use of Menu
- BlockHooks.php in core/
modules/ block/ src/ Hook/ BlockHooks.php - BlockXssTest.php in core/
modules/ block/ tests/ src/ Functional/ BlockXssTest.php - MenuAccessControlHandlerTest.php in core/
modules/ system/ tests/ src/ Kernel/ MenuAccessControlHandlerTest.php - MenuBlockTest.php in core/
modules/ menu_ui/ tests/ src/ Kernel/ MenuBlockTest.php - MenuCacheTagsTest.php in core/
modules/ menu_ui/ tests/ src/ Functional/ MenuCacheTagsTest.php
73 string references to 'Menu'
- BlockPluginId::transform in core/
modules/ block/ src/ Plugin/ migrate/ process/ BlockPluginId.php - Set the block plugin id.
- ConfigEntityMapper::getContextualLinkGroup in core/
modules/ config_translation/ src/ ConfigEntityMapper.php - Returns the name of the contextual link group to add contextual links to.
- ConfigExistsConstraintValidatorTest::testValidation in core/
tests/ Drupal/ KernelTests/ Core/ Config/ ConfigExistsConstraintValidatorTest.php - Tests the ConfigExists constraint validator.
- core.services.yml in core/
core.services.yml - core/core.services.yml
- d6_menu.yml in core/
modules/ system/ migrations/ d6_menu.yml - core/modules/system/migrations/d6_menu.yml
File
-
core/
modules/ system/ src/ Entity/ Menu.php, line 16
Namespace
Drupal\system\EntityView source
class Menu extends ConfigEntityBase implements MenuInterface {
/**
* The menu machine name.
*
* @var string
*/
protected $id;
/**
* The human-readable name of the menu entity.
*
* @var string
*/
protected $label;
/**
* The menu description.
*
* @var string
*/
protected $description;
/**
* The locked status of this menu.
*
* @var bool
*/
protected $locked = FALSE;
/**
* {@inheritdoc}
*/
public function getDescription() {
return $this->description;
}
/**
* {@inheritdoc}
*/
public function isLocked() {
return (bool) $this->locked;
}
/**
* {@inheritdoc}
*/
public static function preDelete(EntityStorageInterface $storage, array $entities) {
parent::preDelete($storage, $entities);
/** @var \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager */
$menu_link_manager = \Drupal::service('plugin.manager.menu.link');
foreach ($entities as $menu) {
// Delete all links from the menu.
$menu_link_manager->deleteLinksInMenu($menu->id());
}
}
/**
* {@inheritdoc}
*/
public function save() {
$return = parent::save();
\Drupal::cache('menu')->deleteAll();
// Invalidate the block cache to update menu-based derivatives.
if (\Drupal::moduleHandler()->moduleExists('block')) {
\Drupal::service('plugin.manager.block')->clearCachedDefinitions();
}
return $return;
}
/**
* {@inheritdoc}
*/
public function delete() {
parent::delete();
\Drupal::cache('menu')->deleteAll();
// Invalidate the block cache to update menu-based derivatives.
if (\Drupal::moduleHandler()->moduleExists('block')) {
\Drupal::service('plugin.manager.block')->clearCachedDefinitions();
}
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
|---|---|---|---|---|---|---|
| CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | |||
| CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | |||
| CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | |||
| CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | |||
| ConfigEntityBase::$isUninstalling | private | property | Whether the config is being deleted by the uninstall process. | |||
| ConfigEntityBase::$langcode | protected | property | The language code of the entity's default language. | |||
| ConfigEntityBase::$originalId | protected | property | The original ID of the configuration entity. | |||
| ConfigEntityBase::$status | protected | property | The enabled/disabled status of the configuration entity. | 4 | ||
| ConfigEntityBase::$third_party_settings | protected | property | Third party entity settings. | |||
| ConfigEntityBase::$trustedData | protected | property | Trust supplied data and not use configuration schema on save. | |||
| ConfigEntityBase::$uuid | protected | property | The UUID for this entity. | |||
| ConfigEntityBase::$_core | protected | property | Information maintained by Drupal core about configuration. | |||
| ConfigEntityBase::addDependency | protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |||
| ConfigEntityBase::calculateDependencies | public | function | Overrides ConfigEntityInterface::calculateDependencies | 12 | ||
| ConfigEntityBase::createDuplicate | public | function | Overrides EntityBase::createDuplicate | 1 | ||
| ConfigEntityBase::disable | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Disable'), pluralize: FALSE)] | Overrides ConfigEntityInterface::disable | 1 | |
| ConfigEntityBase::enable | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Enable'), pluralize: FALSE)] | Overrides ConfigEntityInterface::enable | ||
| ConfigEntityBase::get | public | function | Overrides ConfigEntityInterface::get | |||
| ConfigEntityBase::getCacheTagsToInvalidate | public | function | Overrides EntityBase::getCacheTagsToInvalidate | 1 | ||
| ConfigEntityBase::getConfigDependencyName | public | function | Overrides EntityBase::getConfigDependencyName | |||
| ConfigEntityBase::getConfigManager | protected static | function | Gets the configuration manager. | |||
| ConfigEntityBase::getConfigTarget | public | function | Overrides EntityBase::getConfigTarget | |||
| ConfigEntityBase::getDependencies | public | function | Overrides ConfigEntityInterface::getDependencies | |||
| ConfigEntityBase::getOriginalId | public | function | Overrides EntityBase::getOriginalId | |||
| ConfigEntityBase::getThirdPartyProviders | public | function | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | |||
| ConfigEntityBase::getThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::getThirdPartySetting | |||
| ConfigEntityBase::getThirdPartySettings | public | function | Overrides ThirdPartySettingsInterface::getThirdPartySettings | |||
| ConfigEntityBase::getTypedConfig | protected | function | Gets the typed config manager. | |||
| ConfigEntityBase::hasTrustedData | public | function | Overrides ConfigEntityInterface::hasTrustedData | |||
| ConfigEntityBase::invalidateTagsOnDelete | protected static | function | Override to never invalidate the individual entities' cache tags; the config system already invalidates them. |
Overrides EntityBase::invalidateTagsOnDelete | ||
| ConfigEntityBase::invalidateTagsOnSave | protected | function | Override to never invalidate the entity's cache tag; the config system already invalidates it. |
Overrides EntityBase::invalidateTagsOnSave | ||
| ConfigEntityBase::isInstallable | public | function | Overrides ConfigEntityInterface::isInstallable | 2 | ||
| ConfigEntityBase::isNew | public | function | Overrides EntityBase::isNew(). | Overrides EntityBase::isNew | ||
| ConfigEntityBase::isUninstalling | public | function | Overrides ConfigEntityInterface::isUninstalling | |||
| ConfigEntityBase::onDependencyRemoval | public | function | Overrides ConfigEntityInterface::onDependencyRemoval | 8 | ||
| ConfigEntityBase::preSave | public | function | Overrides EntityBase::preSave | 13 | ||
| ConfigEntityBase::set | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set a value'), pluralize: 'setMultiple')] | Overrides ConfigEntityInterface::set | 1 | |
| ConfigEntityBase::setOriginalId | public | function | Overrides EntityBase::setOriginalId | |||
| ConfigEntityBase::setStatus | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set status'), pluralize: FALSE)] | Overrides ConfigEntityInterface::setStatus | ||
| ConfigEntityBase::setThirdPartySetting | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set third-party setting'))] | Overrides ThirdPartySettingsInterface::setThirdPartySetting | ||
| ConfigEntityBase::setUninstalling | public | function | ||||
| ConfigEntityBase::sort | public static | function | Callback for uasort() to sort configuration entities by weight and label. | 6 | ||
| ConfigEntityBase::status | public | function | Overrides ConfigEntityInterface::status | 4 | ||
| ConfigEntityBase::toArray | public | function | Overrides EntityBase::toArray | 3 | ||
| ConfigEntityBase::toUrl | public | function | Overrides EntityBase::toUrl | |||
| ConfigEntityBase::trustData | public | function | Overrides ConfigEntityInterface::trustData | |||
| ConfigEntityBase::unsetThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting | |||
| ConfigEntityBase::__construct | public | function | Overrides EntityBase::__construct | 9 | ||
| ConfigEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | 4 | ||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | |||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | |||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | Aliased as: addDependencyTrait | ||
| EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | |||
| EntityBase::$entityTypeId | protected | property | The entity type. | |||
| EntityBase::$originalEntity | protected | property | The original unchanged entity. | |||
| EntityBase::$typedData | protected | property | A typed data object wrapping this entity. | |||
| EntityBase::access | public | function | Overrides AccessibleInterface::access | 1 | ||
| EntityBase::bundle | public | function | Overrides EntityInterface::bundle | 1 | ||
| EntityBase::create | public static | function | Overrides EntityInterface::create | 2 | ||
| EntityBase::enforceIsNew | public | function | Overrides EntityInterface::enforceIsNew | |||
| EntityBase::entityTypeBundleInfo | protected | function | Gets the entity type bundle info service. | |||
| EntityBase::entityTypeManager | protected | function | Gets the entity type manager. | |||
| EntityBase::getCacheContexts | public | function | Overrides CacheableDependencyTrait::getCacheContexts | |||
| EntityBase::getCacheMaxAge | public | function | Overrides CacheableDependencyTrait::getCacheMaxAge | |||
| EntityBase::getCacheTags | public | function | Overrides CacheableDependencyTrait::getCacheTags | |||
| EntityBase::getConfigDependencyKey | public | function | Overrides EntityInterface::getConfigDependencyKey | |||
| EntityBase::getEntityType | public | function | Overrides EntityInterface::getEntityType | 1 | ||
| EntityBase::getEntityTypeId | public | function | Overrides EntityInterface::getEntityTypeId | |||
| EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | |||
| EntityBase::getOriginal | public | function | Overrides EntityInterface::getOriginal | |||
| EntityBase::getTypedData | public | function | Overrides EntityInterface::getTypedData | |||
| EntityBase::getTypedDataClass | private | function | Returns the typed data class name for this entity. | |||
| EntityBase::hasLinkTemplate | public | function | Overrides EntityInterface::hasLinkTemplate | |||
| EntityBase::id | public | function | Overrides EntityInterface::id | 10 | ||
| EntityBase::label | public | function | Overrides EntityInterface::label | 6 | ||
| EntityBase::language | public | function | Overrides EntityInterface::language | 1 | ||
| EntityBase::languageManager | protected | function | Gets the language manager. | |||
| EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | ||
| EntityBase::load | public static | function | Overrides EntityInterface::load | |||
| EntityBase::loadMultiple | public static | function | Overrides EntityInterface::loadMultiple | |||
| EntityBase::postCreate | public | function | Overrides EntityInterface::postCreate | 5 | ||
| EntityBase::postDelete | public static | function | Overrides EntityInterface::postDelete | 17 | ||
| EntityBase::postLoad | public static | function | Overrides EntityInterface::postLoad | 3 | ||
| EntityBase::postSave | public | function | Overrides EntityInterface::postSave | 13 | ||
| EntityBase::preCreate | public static | function | Overrides EntityInterface::preCreate | 6 | ||
| EntityBase::referencedEntities | public | function | Overrides EntityInterface::referencedEntities | 1 | ||
| EntityBase::setOriginal | public | function | Overrides EntityInterface::setOriginal | |||
| EntityBase::toLink | public | function | Overrides EntityInterface::toLink | |||
| EntityBase::uriRelationships | public | function | Overrides EntityInterface::uriRelationships | |||
| EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 2 | ||
| EntityBase::uuid | public | function | Overrides EntityInterface::uuid | 1 | ||
| EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | |||
| EntityBase::__get | public | function | 1 | |||
| EntityBase::__isset | public | function | 1 | |||
| EntityBase::__set | public | function | 1 | |||
| EntityBase::__unset | public | function | 1 | |||
| Menu::$description | protected | property | The menu description. | |||
| Menu::$id | protected | property | The menu machine name. | |||
| Menu::$label | protected | property | The human-readable name of the menu entity. | |||
| Menu::$locked | protected | property | The locked status of this menu. | |||
| Menu::delete | public | function | Overrides EntityBase::delete | |||
| Menu::getDescription | public | function | Overrides MenuInterface::getDescription | |||
| Menu::isLocked | public | function | Overrides MenuInterface::isLocked | |||
| Menu::preDelete | public static | function | Overrides ConfigEntityBase::preDelete | |||
| Menu::save | public | function | Overrides ConfigEntityBase::save | |||
| PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 | ||
| PluginDependencyTrait::getPluginDependencies | protected | function | Calculates and returns dependencies of a specific plugin instance. | |||
| PluginDependencyTrait::moduleHandler | protected | function | Wraps the module handler. | 1 | ||
| PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | 1 | ||
| RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | |||
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | ||||
| RefinableCacheableDependencyTrait::addCacheTags | public | function | ||||
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | ||||
| SynchronizableEntityTrait::$isSyncing | protected | property | Is entity being created updated or deleted through synchronization process. | |||
| SynchronizableEntityTrait::isSyncing | public | function | ||||
| SynchronizableEntityTrait::setSyncing | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.