interface MenuLinkContentInterface
Same name in other branches
- 8.9.x core/modules/menu_link_content/src/MenuLinkContentInterface.php \Drupal\menu_link_content\MenuLinkContentInterface
- 10 core/modules/menu_link_content/src/MenuLinkContentInterface.php \Drupal\menu_link_content\MenuLinkContentInterface
- 11.x core/modules/menu_link_content/src/MenuLinkContentInterface.php \Drupal\menu_link_content\MenuLinkContentInterface
Defines an interface for custom menu links.
Hierarchy
- interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable \Drupal\Core\Entity\FieldableEntityInterface \Drupal\Core\Entity\TranslatableRevisionableInterface \Drupal\Core\Entity\SynchronizableInterface; interface \Drupal\Core\Entity\EntityChangedInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\EntityPublishedInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\RevisionLogInterface extends \Drupal\Core\Entity\RevisionableInterface
- interface \Drupal\menu_link_content\MenuLinkContentInterface extends \Drupal\Core\Entity\ContentEntityInterface \Drupal\Core\Entity\EntityChangedInterface \Drupal\Core\Entity\EntityPublishedInterface \Drupal\Core\Entity\RevisionLogInterface
Expanded class hierarchy of MenuLinkContentInterface
All classes that implement MenuLinkContentInterface
3 files declare their use of MenuLinkContentInterface
- MenuLinkContent.php in core/
modules/ menu_link_content/ src/ Entity/ MenuLinkContent.php - MigrateMenuLinkTest.php in core/
modules/ menu_link_content/ tests/ src/ Kernel/ Migrate/ d6/ MigrateMenuLinkTest.php - MigrateMenuLinkTestTrait.php in core/
modules/ menu_link_content/ tests/ src/ Kernel/ Migrate/ MigrateMenuLinkTestTrait.php
File
-
core/
modules/ menu_link_content/ src/ MenuLinkContentInterface.php, line 13
Namespace
Drupal\menu_link_contentView source
interface MenuLinkContentInterface extends ContentEntityInterface, EntityChangedInterface, EntityPublishedInterface, RevisionLogInterface {
/**
* Flags this instance as being wrapped in a menu link plugin instance.
*/
public function setInsidePlugin();
/**
* Gets the title of the menu link.
*
* @return string
* The title of the link.
*/
public function getTitle();
/**
* Gets the url object pointing to the URL of the menu link content entity.
*
* @return \Drupal\Core\Url
* A Url object instance.
*/
public function getUrlObject();
/**
* Gets the menu name of the custom menu link.
*
* @return string
* The menu ID.
*/
public function getMenuName();
/**
* Gets the description of the menu link for the UI.
*
* @return string
* The description to use on admin pages or as a title attribute.
*/
public function getDescription();
/**
* Gets the menu plugin ID associated with this entity.
*
* @return string
* The plugin ID.
*/
public function getPluginId();
/**
* Returns whether the menu link is marked as enabled.
*
* @return bool
* TRUE if is enabled, otherwise FALSE.
*/
public function isEnabled();
/**
* Returns whether the menu link is marked as always expanded.
*
* @return bool
* TRUE for expanded, FALSE otherwise.
*/
public function isExpanded();
/**
* Gets the plugin ID of the parent menu link.
*
* @return string
* A plugin ID, or empty string if this link is at the top level.
*/
public function getParentId();
/**
* Returns the weight of the menu link content entity.
*
* @return int
* A weight for use when ordering links.
*/
public function getWeight();
/**
* Builds up the menu link plugin definition for this entity.
*
* @return array
* The plugin definition corresponding to this entity.
*
* @see \Drupal\Core\Menu\MenuLinkTree::$defaults
*/
public function getPluginDefinition();
/**
* Returns whether the menu link requires rediscovery.
*
* If a menu-link points to a user-supplied path such as /blog then the route
* this resolves to needs to be rediscovered as the module or route providing
* a given path might change over time.
*
* For example: at the time a menu-link is created, the /blog path might be
* provided by a route in Views module, but later this path may be served by
* the Panels module. Flagging a link as requiring rediscovery ensures that if
* the route that provides a user-entered path changes over time, the link is
* flexible enough to update to reflect these changes.
*
* @return bool
* TRUE if the menu link requires rediscovery during route rebuilding.
*/
public function requiresRediscovery();
/**
* Flags a link as requiring rediscovery.
*
* @param bool $rediscovery
* Whether or not the link requires rediscovery.
*
* @return $this
* The instance on which the method was called.
*
* @see \Drupal\menu_link_content\MenuLinkContentInterface::requiresRediscovery()
*/
public function setRequiresRediscovery($rediscovery);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
AccessibleInterface::access | public | function | Checks data value access. | 9 |
CacheableDependencyInterface::getCacheContexts | public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface::getCacheTags | public | function | The cache tags associated with this object. | 27 |
EntityChangedInterface::getChangedTime | public | function | Gets the timestamp of the last entity change for the current translation. | |
EntityChangedInterface::getChangedTimeAcrossTranslations | public | function | Gets the timestamp of the last entity change across all translations. | |
EntityChangedInterface::setChangedTime | public | function | Sets the timestamp of the last entity change for the current translation. | |
EntityInterface::bundle | public | function | Gets the bundle of the entity. | 2 |
EntityInterface::create | public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface::createDuplicate | public | function | Creates a duplicate of the entity. | 2 |
EntityInterface::delete | public | function | Deletes an entity permanently. | 2 |
EntityInterface::enforceIsNew | public | function | Enforces an entity to be new. | 2 |
EntityInterface::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface::getConfigDependencyName | public | function | Gets the configuration dependency name. | 2 |
EntityInterface::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface::getEntityType | public | function | Gets the entity type definition. | 2 |
EntityInterface::getEntityTypeId | public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface::getOriginalId | public | function | Gets the original ID. | 2 |
EntityInterface::getTypedData | public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface::id | public | function | Gets the identifier. | 2 |
EntityInterface::isNew | public | function | Determines whether the entity is new. | 2 |
EntityInterface::label | public | function | Gets the label of the entity. | 2 |
EntityInterface::language | public | function | Gets the language of the entity. | 2 |
EntityInterface::load | public static | function | Loads an entity. | 2 |
EntityInterface::loadMultiple | public static | function | Loads one or more entities. | 2 |
EntityInterface::postCreate | public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface::postLoad | public static | function | Acts on loaded entities. | 3 |
EntityInterface::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface::preCreate | public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface::preSave | public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface::referencedEntities | public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface::save | public | function | Saves an entity permanently. | 2 |
EntityInterface::setOriginalId | public | function | Sets the original ID. | 2 |
EntityInterface::toArray | public | function | Gets an array of all property values. | 3 |
EntityInterface::toLink | public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface::toUrl | public | function | Gets the URL object for the entity. | 2 |
EntityInterface::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
EntityPublishedInterface::isPublished | public | function | Returns whether or not the entity is published. | |
EntityPublishedInterface::setPublished | public | function | Sets the entity as published. | |
EntityPublishedInterface::setUnpublished | public | function | Sets the entity as unpublished. | |
MenuLinkContentInterface::getDescription | public | function | Gets the description of the menu link for the UI. | 1 |
MenuLinkContentInterface::getMenuName | public | function | Gets the menu name of the custom menu link. | 1 |
MenuLinkContentInterface::getParentId | public | function | Gets the plugin ID of the parent menu link. | 1 |
MenuLinkContentInterface::getPluginDefinition | public | function | Builds up the menu link plugin definition for this entity. | 1 |
MenuLinkContentInterface::getPluginId | public | function | Gets the menu plugin ID associated with this entity. | 1 |
MenuLinkContentInterface::getTitle | public | function | Gets the title of the menu link. | 1 |
MenuLinkContentInterface::getUrlObject | public | function | Gets the url object pointing to the URL of the menu link content entity. | 1 |
MenuLinkContentInterface::getWeight | public | function | Returns the weight of the menu link content entity. | 1 |
MenuLinkContentInterface::isEnabled | public | function | Returns whether the menu link is marked as enabled. | 1 |
MenuLinkContentInterface::isExpanded | public | function | Returns whether the menu link is marked as always expanded. | 1 |
MenuLinkContentInterface::requiresRediscovery | public | function | Returns whether the menu link requires rediscovery. | 1 |
MenuLinkContentInterface::setInsidePlugin | public | function | Flags this instance as being wrapped in a menu link plugin instance. | 1 |
MenuLinkContentInterface::setRequiresRediscovery | public | function | Flags a link as requiring rediscovery. | 1 |
RefinableCacheableDependencyInterface::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface::addCacheContexts | public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface::addCacheTags | public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
RevisionableInterface::getLoadedRevisionId | public | function | Gets the loaded Revision ID of the entity. | |
RevisionableInterface::getRevisionId | public | function | Gets the revision identifier of the entity. | |
RevisionableInterface::isDefaultRevision | public | function | Checks if this entity is the default revision. | |
RevisionableInterface::isLatestRevision | public | function | Checks if this entity is the latest revision. | |
RevisionableInterface::isNewRevision | public | function | Determines whether a new revision should be created on save. | |
RevisionableInterface::preSaveRevision | public | function | Acts on a revision before it gets saved. | |
RevisionableInterface::setNewRevision | public | function | Enforces an entity to be saved as a new revision. | |
RevisionableInterface::updateLoadedRevisionId | public | function | Updates the loaded Revision ID with the revision ID. | |
RevisionableInterface::wasDefaultRevision | public | function | Checks whether the entity object was a default revision when it was saved. | |
RevisionLogInterface::getRevisionCreationTime | public | function | Gets the entity revision creation timestamp. | 1 |
RevisionLogInterface::getRevisionLogMessage | public | function | Returns the entity revision log message. | |
RevisionLogInterface::getRevisionUser | public | function | Gets the entity revision author. | |
RevisionLogInterface::getRevisionUserId | public | function | Gets the entity revision author ID. | |
RevisionLogInterface::setRevisionCreationTime | public | function | Sets the entity revision creation timestamp. | 1 |
RevisionLogInterface::setRevisionLogMessage | public | function | Sets the entity revision log message. | |
RevisionLogInterface::setRevisionUser | public | function | Sets the entity revision author. | |
RevisionLogInterface::setRevisionUserId | public | function | Sets the entity revision author by ID. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.