Provides an interface defining a menu link entity.
Expanded class hierarchy of MenuLinkInterface
All classes that implement MenuLinkInterface
interface MenuLinkInterface extends ContentEntityInterface {
/**
* Returns the Route object associated with this link, if any.
*
* @return \Symfony\Component\Routing\Route|null
* The route object for this menu link, or NULL if there isn't one.
*/
public function getRoute();
/**
* Sets the route object for this link.
*
* This should only be called by MenuLinkStorageController when loading
* the link object. Calling it at other times could result in unpredictable
* behavior.
*
* @param \Symfony\Component\Routing\Route $route
*/
public function setRouteObject(Route $route);
/**
* Resets a system-defined menu link.
*
* @return \Drupal\Core\Entity\EntityInterface
* A menu link entity.
*/
public function reset();
/**
* Builds a menu link entity from a router item.
*
* @param array $item
* A menu router item.
*
* @return \Drupal\menu_link\MenuLinkInterface
* A menu link entity.
*/
public static function buildFromRouterItem(array $item);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 5 |
ComplexDataInterface:: |
public | function | Gets a property object. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property objects. | 7 |
ComplexDataInterface:: |
public | function | Gets the definition of a contained property. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property definitions of contained properties. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property values. | 7 |
ComplexDataInterface:: |
public | function | Determines whether the data structure is empty. | 7 |
ComplexDataInterface:: |
public | function | React to changes to a child property. | 7 |
ComplexDataInterface:: |
public | function | Sets a property value. | 7 |
ComplexDataInterface:: |
public | function | Sets multiple property values. | 7 |
EntityInterface:: |
public | function | Returns the bundle of the entity. | 3 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 3 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 3 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 3 |
EntityInterface:: |
public | function | Returns the info of the type of the entity. | 3 |
EntityInterface:: |
public | function | Returns the type of the entity. | 3 |
EntityInterface:: |
public | function | Gets a backward compatibility decorator entity. | 3 |
EntityInterface:: |
public | function | Retrieves the exportable properties of the entity. | 3 |
EntityInterface:: |
public | function | Removes any possible (backward compatibility) decorator in use. | 3 |
EntityInterface:: |
public | function | Returns the revision identifier of the entity. | 3 |
EntityInterface:: |
public | function | Returns the entity identifier (the entity's machine name or numeric ID). | 3 |
EntityInterface:: |
public | function | Checks if this entity is the default revision. | 3 |
EntityInterface:: |
public | function | Returns whether the entity is new. | 3 |
EntityInterface:: |
public | function | Returns whether a new revision should be created on save. | 3 |
EntityInterface:: |
public | function | Returns the translation support status. | 3 |
EntityInterface:: |
public | function | Returns the label of the entity. | 3 |
EntityInterface:: |
public | function | Saves an entity permanently. | 3 |
EntityInterface:: |
public | function | Enforces an entity to be saved as a new revision. | 3 |
EntityInterface:: |
public | function | Returns the URI elements of the entity. | 3 |
EntityInterface:: |
public | function | Returns a list of URI relationships supported by this entity. | 3 |
EntityInterface:: |
public | function | Returns the entity UUID (Universally Unique Identifier). | 3 |
MenuLinkInterface:: |
public static | function | Builds a menu link entity from a router item. | 1 |
MenuLinkInterface:: |
public | function | Returns the Route object associated with this link, if any. | 1 |
MenuLinkInterface:: |
public | function | Resets a system-defined menu link. | 1 |
MenuLinkInterface:: |
public | function | Sets the route object for this link. | 1 |
TranslatableInterface:: |
public | function | Gets a translation of the data. | 3 |
TranslatableInterface:: |
public | function | Returns the languages the data is translated to. | 3 |
TranslatableInterface:: |
public | function | Returns the default language. | 3 |
TypedDataInterface:: |
public | function | Gets a list of validation constraints. | 4 |
TypedDataInterface:: |
public | function | Gets the data definition. | 4 |
TypedDataInterface:: |
public | function | Returns the name of a property or item. | 4 |
TypedDataInterface:: |
public | function | Returns the parent data structure; i.e. either complex data or a list. | 4 |
TypedDataInterface:: |
public | function | Returns the property path of the data. | 4 |
TypedDataInterface:: |
public | function | Returns the root of the typed data tree. | 4 |
TypedDataInterface:: |
public | function | Returns a string representation of the data. | 4 |
TypedDataInterface:: |
public | function | Gets the data type. | 5 |
TypedDataInterface:: |
public | function | Gets the data value. | 4 |
TypedDataInterface:: |
public | function | Sets the context of a property or item via a context aware parent. | 4 |
TypedDataInterface:: |
public | function | Sets the data value. | 4 |
TypedDataInterface:: |
public | function | Validates the currently set data value. | 4 |