interface MenuInterface

Same name and namespace in other branches
  1. 11.x core/modules/system/src/MenuInterface.php \Drupal\system\MenuInterface
  2. 10 core/modules/system/src/MenuInterface.php \Drupal\system\MenuInterface
  3. 8.9.x core/modules/system/src/MenuInterface.php \Drupal\system\MenuInterface

Provides an interface defining a menu entity.

Hierarchy

Expanded class hierarchy of MenuInterface

All classes that implement MenuInterface

6 files declare their use of MenuInterface
Menu.php in core/modules/system/src/Entity/Menu.php
MenuController.php in core/modules/menu_link_content/src/Controller/MenuController.php
MenuController.php in core/modules/menu_ui/src/Controller/MenuController.php
menu_link_content.module in core/modules/menu_link_content/menu_link_content.module
Allows administrators to create custom menu links.
menu_ui.module in core/modules/menu_ui/menu_ui.module
Allows administrators to customize the site's navigation menus.

... See full list

File

core/modules/system/src/MenuInterface.php, line 10

Namespace

Drupal\system
View on git.drupalcode.org
View source 
interface MenuInterface extends ConfigEntityInterface {
  
  /**
   * Returns the description of the menu.
   *
   * @return string
   *   Description of the menu.
   */
  public function getDescription();
  
  /**
   * Determines if this menu is locked.
   *
   * @return bool
   *   TRUE if the menu is locked, FALSE otherwise.
   */
  public function isLocked();

}

Members

Title Modifiers Object type Summary Overrides
AccessibleInterface::access public function Checks data value access. 1
AccessibleInterface::access public function Checks data value access. 1
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 1
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 1
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 1
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 1
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 1
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 1
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property.
ConfigEntityInterface::disable public function Disables the configuration entity.
ConfigEntityInterface::enable public function Enables the configuration entity.
ConfigEntityInterface::get public function Returns the value of a property.
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies.
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted.
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable.
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process.
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted.
ConfigEntityInterface::set public function Sets the value of a property.
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity.
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled.
ConfigEntityInterface::trustData public function Sets that the data should be trusted.
EntityInterface::bundle public function Gets the bundle of the entity.
EntityInterface::create public static function Constructs a new entity object, without permanently saving it.
EntityInterface::createDuplicate public function Creates a duplicate of the entity.
EntityInterface::delete public function Deletes an entity permanently.
EntityInterface::enforceIsNew public function Enforces an entity to be new.
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches.
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies.
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name.
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity.
EntityInterface::getEntityType public function Gets the entity type definition.
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity.
EntityInterface::getOriginalId public function Gets the original ID.
EntityInterface::getTypedData public function Gets a typed data object for this entity object.
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key.
EntityInterface::id public function Gets the identifier.
EntityInterface::isNew public function Determines whether the entity is new.
EntityInterface::label public function Gets the label of the entity.
EntityInterface::language public function Gets the language of the entity.
EntityInterface::load public static function Loads an entity.
EntityInterface::loadMultiple public static function Loads one or more entities.
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked.
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked.
EntityInterface::postLoad public static function Acts on loaded entities.
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked.
EntityInterface::preCreate public static function Changes the values of an entity before it is created.
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked.
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked.
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity.
EntityInterface::save public function Saves an entity permanently.
EntityInterface::setOriginalId public function Sets the original ID.
EntityInterface::toArray public function Gets an array of all property values.
EntityInterface::toLink public function Generates the HTML for a link to this entity.
EntityInterface::toUrl public function Gets the URL object for the entity.
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity.
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier).
MenuInterface::getDescription public function Returns the description of the menu.
MenuInterface::isLocked public function Determines if this menu is locked.
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata.
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts.
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags.
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age.
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization.
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag.
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 2
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 2
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 2
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 2
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 2
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 2
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 2
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 2
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 2
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.