interface ShortcutInterface
Same name and namespace in other branches
- 9 core/modules/shortcut/src/ShortcutInterface.php \Drupal\shortcut\ShortcutInterface
- 8.9.x core/modules/shortcut/src/ShortcutInterface.php \Drupal\shortcut\ShortcutInterface
- 10 core/modules/shortcut/src/ShortcutInterface.php \Drupal\shortcut\ShortcutInterface
Provides an interface defining a shortcut entity.
Hierarchy
- interface \Drupal\Core\Entity\FieldableEntityInterface implements \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\SynchronizableInterface implements \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\TranslatableRevisionableInterface implements \Drupal\Core\Entity\TranslatableInterface, \Drupal\Core\Entity\RevisionableInterface
- interface \Drupal\Core\Entity\ContentEntityInterface implements \Drupal\Core\Entity\Traversable, \Drupal\Core\Entity\FieldableEntityInterface, \Drupal\Core\Entity\TranslatableRevisionableInterface, \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\shortcut\ShortcutInterface implements \Drupal\Core\Entity\ContentEntityInterface
- interface \Drupal\Core\Entity\ContentEntityInterface implements \Drupal\Core\Entity\Traversable, \Drupal\Core\Entity\FieldableEntityInterface, \Drupal\Core\Entity\TranslatableRevisionableInterface, \Drupal\Core\Entity\SynchronizableInterface
Expanded class hierarchy of ShortcutInterface
All classes that implement ShortcutInterface
3 files declare their use of ShortcutInterface
- MigrateShortcutTest.php in core/
modules/ shortcut/ tests/ src/ Kernel/ Migrate/ d7/ MigrateShortcutTest.php - Shortcut.php in core/
modules/ shortcut/ src/ Entity/ Shortcut.php - ShortcutController.php in core/
modules/ shortcut/ src/ Controller/ ShortcutController.php
File
-
core/
modules/ shortcut/ src/ ShortcutInterface.php, line 10
Namespace
Drupal\shortcutView source
interface ShortcutInterface extends ContentEntityInterface {
/**
* Returns the title of this shortcut.
*
* @return string
* The title of this shortcut.
*/
public function getTitle();
/**
* Sets the title of this shortcut.
*
* @param string $title
* The title of this shortcut.
*
* @return $this
* The called shortcut entity.
*/
public function setTitle($title);
/**
* Returns the weight among shortcuts with the same depth.
*
* @return int
* The shortcut weight.
*/
public function getWeight();
/**
* Sets the weight among shortcuts with the same depth.
*
* @param int $weight
* The shortcut weight.
*
* @return $this
* The called shortcut entity.
*/
public function setWeight($weight);
/**
* Returns the URL object pointing to the configured route.
*
* @return \Drupal\Core\Url
* The URL object.
*/
public function getUrl();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AccessibleInterface::access | public | function | Checks data value access. | 10 | |
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 | |
ContentEntityInterface::getBundleEntity | public | function | Gets the bundle entity of this entity. | 1 | |
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::getOriginal | public | function | Returns the original unchanged 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. | 2 | |
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::setOriginal | public | function | Sets the original unchanged entity. | 2 | |
EntityInterface::setOriginalId | public | function | Sets the original ID. | 2 | |
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 | |
FieldableEntityInterface::baseFieldDefinitions | public static | function | Provides base field definitions for an entity type. | 2 | |
FieldableEntityInterface::bundleFieldDefinitions | public static | function | Provides field definitions for a specific bundle. | 2 | |
FieldableEntityInterface::get | public | function | Gets a field item list. | 1 | |
FieldableEntityInterface::getFieldDefinition | public | function | Gets the definition of a contained field. | 1 | |
FieldableEntityInterface::getFieldDefinitions | public | function | Gets an array of field definitions of all contained fields. | 1 | |
FieldableEntityInterface::getFields | public | function | Gets an array of all field item lists. | 1 | |
FieldableEntityInterface::getTranslatableFields | public | function | Gets an array of field item lists for translatable fields. | 1 | |
FieldableEntityInterface::hasField | public | function | Determines whether the entity has a field with the given name. | 1 | |
FieldableEntityInterface::isValidationRequired | public | function | Checks whether entity validation is required before saving the entity. | 1 | |
FieldableEntityInterface::onChange | public | function | Reacts to changes to a field. | 1 | |
FieldableEntityInterface::set | public | function | Sets a field value. | 1 | |
FieldableEntityInterface::setValidationRequired | public | function | Sets whether entity validation is required before saving the entity. | 1 | |
FieldableEntityInterface::toArray | public | function | Gets an array of all field values. | Overrides EntityInterface::toArray | |
FieldableEntityInterface::validate | public | function | Validates the currently set values. | 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. | 2 | |
RevisionableInterface::getRevisionId | public | function | Gets the revision identifier of the entity. | 2 | |
RevisionableInterface::isDefaultRevision | public | function | Checks if this entity is the default revision. | 2 | |
RevisionableInterface::isLatestRevision | public | function | Checks if this entity is the latest revision. | 2 | |
RevisionableInterface::isNewRevision | public | function | Determines whether a new revision should be created on save. | 2 | |
RevisionableInterface::preSaveRevision | public | function | Acts on a revision before it gets saved. | 2 | |
RevisionableInterface::setNewRevision | public | function | Enforces an entity to be saved as a new revision. | 2 | |
RevisionableInterface::updateLoadedRevisionId | public | function | Updates the loaded Revision ID with the revision ID. | 2 | |
RevisionableInterface::wasDefaultRevision | public | function | Checks whether the entity object was a default revision when it was saved. | 2 | |
ShortcutInterface::getTitle | public | function | Returns the title of this shortcut. | 1 | |
ShortcutInterface::getUrl | public | function | Returns the URL object pointing to the configured route. | 1 | |
ShortcutInterface::getWeight | public | function | Returns the weight among shortcuts with the same depth. | 1 | |
ShortcutInterface::setTitle | public | function | Sets the title of this shortcut. | 1 | |
ShortcutInterface::setWeight | public | function | Sets the weight among shortcuts with the same depth. | 1 | |
SynchronizableInterface::isSyncing | public | function | Returns whether this entity is being changed as part of a synchronization. | 1 | |
SynchronizableInterface::setSyncing | public | function | Sets the status of the synchronization flag. | 1 | |
TranslatableInterface::addTranslation | public | function | Adds a new translation to the translatable object. | 1 | |
TranslatableInterface::getTranslation | public | function | Gets a translation of the data. | 1 | |
TranslatableInterface::getTranslationLanguages | public | function | Returns the languages the data is translated to. | 1 | |
TranslatableInterface::getUntranslated | public | function | Returns the translatable object in the language it was created. | 1 | |
TranslatableInterface::hasTranslation | public | function | Checks there is a translation for the given language code. | 1 | |
TranslatableInterface::hasTranslationChanges | public | function | Determines if the current translation of the entity has unsaved changes. | 1 | |
TranslatableInterface::isDefaultTranslation | public | function | Checks whether the translation is the default one. | 1 | |
TranslatableInterface::isNewTranslation | public | function | Checks whether the translation is new. | 1 | |
TranslatableInterface::isTranslatable | public | function | Returns the translation support status. | 1 | |
TranslatableInterface::removeTranslation | public | function | Removes the translation identified by the given language code. | 1 | |
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly | public | function | Checks if untranslatable fields should affect only the default translation. | 1 | |
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision | public | function | Checks whether this is the latest revision affecting this translation. | 1 | |
TranslatableRevisionableInterface::isRevisionTranslationAffected | public | function | Checks whether the current translation is affected by the current revision. | 1 | |
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced | public | function | Checks if the revision translation affected flag value has been enforced. | 1 | |
TranslatableRevisionableInterface::setRevisionTranslationAffected | public | function | Marks the current revision translation as affected. | 1 | |
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced | public | function | Enforces the revision translation affected flag value. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.