class Menu
Same name in this branch
- 9 core/modules/system/src/Plugin/migrate/source/Menu.php \Drupal\system\Plugin\migrate\source\Menu
Same name and namespace in other branches
- 11.x core/modules/system/src/Entity/Menu.php \Drupal\system\Entity\Menu
- 11.x core/modules/system/src/Plugin/migrate/source/Menu.php \Drupal\system\Plugin\migrate\source\Menu
- 10 core/modules/system/src/Entity/Menu.php \Drupal\system\Entity\Menu
- 10 core/modules/system/src/Plugin/migrate/source/Menu.php \Drupal\system\Plugin\migrate\source\Menu
- 8.9.x core/modules/system/src/Entity/Menu.php \Drupal\system\Entity\Menu
- 8.9.x core/modules/system/src/Plugin/migrate/source/Menu.php \Drupal\system\Plugin\migrate\source\Menu
Defines the Menu configuration entity class.
Plugin annotation
@ConfigEntityType(
id = "menu",
label = @Translation("Menu"),
label_collection = @Translation("Menus"),
label_singular = @Translation("menu"),
label_plural = @Translation("menus"),
label_count = @PluralTranslation(
singular = "@count menu",
plural = "@count menus",
),
handlers = {
"access" = "Drupal\system\MenuAccessControlHandler",
"storage" = "Drupal\system\MenuStorage",
},
admin_permission = "administer menu",
entity_keys = {
"id" = "id",
"label" = "label"
},
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
17 files declare their use of Menu
- block.module in core/
modules/ block/ block.module - Controls the visual building blocks a page is constructed with.
- BlockXssTest.php in core/
modules/ block/ tests/ src/ Functional/ BlockXssTest.php - MenuAccessControlHandlerTest.php in core/
modules/ system/ tests/ src/ Kernel/ MenuAccessControlHandlerTest.php - MenuCacheTagsTest.php in core/
modules/ menu_ui/ tests/ src/ Functional/ MenuCacheTagsTest.php - MenuLinkContentDeleteFormTest.php in core/
modules/ menu_link_content/ tests/ src/ Functional/ MenuLinkContentDeleteFormTest.php
70 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.
- core.services.yml in core/
core.services.yml - core/core.services.yml
- d6_block.yml in core/
modules/ block/ migrations/ d6_block.yml - core/modules/block/migrations/d6_block.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 39
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')->invalidateAll();
// 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')->invalidateAll();
// 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. | 2 | ||
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 | 11 | ||
ConfigEntityBase::createDuplicate | public | function | Overrides EntityBase::createDuplicate | 1 | ||
ConfigEntityBase::disable | public | function | Overrides ConfigEntityInterface::disable | 1 | ||
ConfigEntityBase::enable | public | function | 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 Entity::isNew(). | Overrides EntityBase::isNew | ||
ConfigEntityBase::isUninstalling | public | function | Overrides ConfigEntityInterface::isUninstalling | |||
ConfigEntityBase::onDependencyRemoval | public | function | Overrides ConfigEntityInterface::onDependencyRemoval | 6 | ||
ConfigEntityBase::preSave | public | function | Overrides EntityBase::preSave | 9 | ||
ConfigEntityBase::set | public | function | Overrides ConfigEntityInterface::set | |||
ConfigEntityBase::setOriginalId | public | function | Overrides EntityBase::setOriginalId | |||
ConfigEntityBase::setStatus | public | function | Overrides ConfigEntityInterface::setStatus | |||
ConfigEntityBase::setThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::setThirdPartySetting | |||
ConfigEntityBase::setUninstalling | public | function | ||||
ConfigEntityBase::sort | public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 5 | ||
ConfigEntityBase::status | public | function | Overrides ConfigEntityInterface::status | 2 | ||
ConfigEntityBase::toArray | public | function | Overrides EntityBase::toArray | 1 | ||
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 | 8 | ||
ConfigEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | 2 | ||
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 | #[\ReturnTypeWillChange] | 1 | ||
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::$typedData | protected | property | A typed data object wrapping this entity. | |||
EntityBase::access | public | function | ||||
EntityBase::bundle | public | function | ||||
EntityBase::create | public static | function | ||||
EntityBase::enforceIsNew | public | function | ||||
EntityBase::entityTypeBundleInfo | protected | function | Gets the entity type bundle info service. | |||
EntityBase::entityTypeManager | protected | function | Gets the entity type manager. | |||
EntityBase::getCacheContexts | public | function | ||||
EntityBase::getCacheMaxAge | public | function | ||||
EntityBase::getCacheTags | public | function | ||||
EntityBase::getConfigDependencyKey | public | function | ||||
EntityBase::getEntityType | public | function | ||||
EntityBase::getEntityTypeId | public | function | ||||
EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | |||
EntityBase::getTypedData | public | function | ||||
EntityBase::getTypedDataClass | private | function | Returns the typed data class name for this entity. | |||
EntityBase::hasLinkTemplate | public | function | ||||
EntityBase::id | public | function | 8 | |||
EntityBase::label | public | function | 5 | |||
EntityBase::language | public | function | ||||
EntityBase::languageManager | protected | function | Gets the language manager. | |||
EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | ||
EntityBase::load | public static | function | ||||
EntityBase::loadMultiple | public static | function | ||||
EntityBase::postCreate | public | function | 2 | |||
EntityBase::postDelete | public static | function | 17 | |||
EntityBase::postLoad | public static | function | 3 | |||
EntityBase::postSave | public | function | 10 | |||
EntityBase::preCreate | public static | function | 7 | |||
EntityBase::referencedEntities | public | function | ||||
EntityBase::toLink | public | function | ||||
EntityBase::uriRelationships | public | function | ||||
EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 1 | ||
EntityBase::uuid | public | function | ||||
EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | |||
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 | Deletes an entity permanently. | Overrides EntityBase::delete | ||
Menu::getDescription | public | function | Returns the description of the menu. | Overrides MenuInterface::getDescription | ||
Menu::isLocked | public | function | Determines if this menu is locked. | Overrides MenuInterface::isLocked | ||
Menu::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides ConfigEntityBase::preDelete | ||
Menu::save | public | function | Saves an entity permanently. | 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. | |||
PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | |||
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.