Same name in this branch
- 10 core/modules/shortcut/src/Entity/Shortcut.php \Drupal\shortcut\Entity\Shortcut
- 10 core/modules/shortcut/src/Plugin/migrate/source/d7/Shortcut.php \Drupal\shortcut\Plugin\migrate\source\d7\Shortcut
Same name and namespace in other branches
- 8.9.x core/modules/shortcut/src/Entity/Shortcut.php \Drupal\shortcut\Entity\Shortcut
- 9 core/modules/shortcut/src/Entity/Shortcut.php \Drupal\shortcut\Entity\Shortcut
Defines the shortcut entity class.
@property \Drupal\link\LinkItemInterface $link
Plugin annotation
@ContentEntityType(
id = "shortcut",
label = @Translation("Shortcut link"),
label_collection = @Translation("Shortcut links"),
label_singular = @Translation("shortcut link"),
label_plural = @Translation("shortcut links"),
label_count = @PluralTranslation(
singular = "@count shortcut link",
plural = "@count shortcut links",
),
bundle_label = @Translation("Shortcut set"),
handlers = {
"access" = "Drupal\shortcut\ShortcutAccessControlHandler",
"form" = {
"default" = "Drupal\shortcut\ShortcutForm",
"add" = "Drupal\shortcut\ShortcutForm",
"edit" = "Drupal\shortcut\ShortcutForm",
"delete" = "Drupal\shortcut\Form\ShortcutDeleteForm"
},
},
base_table = "shortcut",
data_table = "shortcut_field_data",
translatable = TRUE,
entity_keys = {
"id" = "id",
"uuid" = "uuid",
"bundle" = "shortcut_set",
"label" = "title",
"langcode" = "langcode",
},
links = {
"canonical" = "/admin/config/user-interface/shortcut/link/{shortcut}",
"delete-form" = "/admin/config/user-interface/shortcut/link/{shortcut}/delete",
"edit-form" = "/admin/config/user-interface/shortcut/link/{shortcut}",
},
list_cache_tags = { "config:shortcut_set_list" },
bundle_entity_type = "shortcut_set"
)
Hierarchy
- class \Drupal\shortcut\Entity\Shortcut extends \Drupal\Core\Entity\ContentEntityBase implements ShortcutInterface
Expanded class hierarchy of Shortcut
8 files declare their use of Shortcut
- demo_umami.install in core/
profiles/ demo_umami/ demo_umami.install - Install, update and uninstall functions for the demo_umami installation profile.
- JsonApiFilterRegressionTest.php in core/
modules/ jsonapi/ tests/ src/ Functional/ JsonApiFilterRegressionTest.php - MigrateShortcutTest.php in core/
modules/ shortcut/ tests/ src/ Kernel/ Migrate/ d7/ MigrateShortcutTest.php - ShortcutLinksTest.php in core/
modules/ shortcut/ tests/ src/ Functional/ ShortcutLinksTest.php - ShortcutResourceTestBase.php in core/
modules/ shortcut/ tests/ src/ Functional/ Rest/ ShortcutResourceTestBase.php
5 string references to 'Shortcut'
- MultilingualReviewPageTest::getAvailablePaths in core/
modules/ migrate_drupal_ui/ tests/ src/ Functional/ d7/ MultilingualReviewPageTest.php - Gets the available upgrade paths.
- NoMultilingualReviewPageTest::getAvailablePaths in core/
modules/ migrate_drupal_ui/ tests/ src/ Functional/ d7/ NoMultilingualReviewPageTest.php - Gets the available upgrade paths.
- olivero.schema.yml in core/
themes/ olivero/ config/ schema/ olivero.schema.yml - core/themes/olivero/config/schema/olivero.schema.yml
- shortcut.info.yml in core/
modules/ shortcut/ shortcut.info.yml - core/modules/shortcut/shortcut.info.yml
- Upgrade7Test::getAvailablePaths in core/
modules/ migrate_drupal_ui/ tests/ src/ Functional/ d7/ Upgrade7Test.php
File
- core/
modules/ shortcut/ src/ Entity/ Shortcut.php, line 57
Namespace
Drupal\shortcut\EntityView source
class Shortcut extends ContentEntityBase implements ShortcutInterface {
/**
* {@inheritdoc}
*/
public function getTitle() {
return $this
->get('title')->value;
}
/**
* {@inheritdoc}
*/
public function setTitle($link_title) {
$this
->set('title', $link_title);
return $this;
}
/**
* {@inheritdoc}
*/
public function getWeight() {
return $this
->get('weight')->value;
}
/**
* {@inheritdoc}
*/
public function setWeight($weight) {
$this
->set('weight', $weight);
return $this;
}
/**
* {@inheritdoc}
*/
public function getUrl() {
return $this->link
->first()
->getUrl();
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
// Entity::postSave() calls Entity::invalidateTagsOnSave(), which only
// handles the regular cases. The Shortcut entity has one special case: a
// newly created shortcut is *also* added to a shortcut set, so we must
// invalidate the associated shortcut set's cache tag.
if (!$update) {
Cache::invalidateTags($this
->getCacheTagsToInvalidate());
}
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
/** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
$fields = parent::baseFieldDefinitions($entity_type);
$fields['id']
->setDescription(t('The ID of the shortcut.'));
$fields['uuid']
->setDescription(t('The UUID of the shortcut.'));
$fields['shortcut_set']
->setLabel(t('Shortcut set'))
->setDescription(t('The bundle of the shortcut.'));
$fields['langcode']
->setDescription(t('The language code of the shortcut.'));
$fields['title'] = BaseFieldDefinition::create('string')
->setLabel(t('Name'))
->setDescription(t('The name of the shortcut.'))
->setRequired(TRUE)
->setTranslatable(TRUE)
->setSetting('max_length', 255)
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => -10,
'settings' => [
'size' => 40,
],
]);
$fields['weight'] = BaseFieldDefinition::create('integer')
->setLabel(t('Weight'))
->setDescription(t('Weight among shortcuts in the same shortcut set.'));
$fields['link'] = BaseFieldDefinition::create('link')
->setLabel(t('Path'))
->setDescription(t('The location this shortcut points to.'))
->setRequired(TRUE)
->setSettings([
'link_type' => LinkItemInterface::LINK_INTERNAL,
'title' => DRUPAL_DISABLED,
])
->setDisplayOptions('form', [
'type' => 'link_default',
'weight' => 0,
])
->setDisplayConfigurable('form', TRUE);
return $fields;
}
/**
* {@inheritdoc}
*/
public function getCacheTagsToInvalidate() {
return $this->shortcut_set->entity
->getCacheTags();
}
/**
* Sort shortcut objects.
*
* Callback for uasort().
*
* @param \Drupal\shortcut\ShortcutInterface $a
* First item for comparison.
* @param \Drupal\shortcut\ShortcutInterface $b
* Second item for comparison.
*
* @return int
* The comparison result for uasort().
*/
public static function sort(ShortcutInterface $a, ShortcutInterface $b) {
$a_weight = $a
->getWeight();
$b_weight = $b
->getWeight();
if ($a_weight == $b_weight) {
return strnatcasecmp($a
->getTitle(), $b
->getTitle());
}
return $a_weight <=> $b_weight;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 6 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 12 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 12 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 12 |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 1 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 1 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 1 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 1 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 1 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 1 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 1 |
EntityInterface:: |
public | function | Gets the entity type definition. | 1 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 1 |
EntityInterface:: |
public | function | Gets the original ID. | 1 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 1 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 1 |
EntityInterface:: |
public | function | Gets the identifier. | 1 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 1 |
EntityInterface:: |
public | function | Gets the label of the entity. | 3 |
EntityInterface:: |
public | function | Gets the language of the entity. | 1 |
EntityInterface:: |
public static | function | Loads an entity. | 1 |
EntityInterface:: |
public static | function | Loads one or more entities. | 1 |
EntityInterface:: |
public | function | Acts on a created entity before hooks are invoked. | 1 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 7 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 4 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 6 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 8 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 3 |
EntityInterface:: |
public | function | Sets the original ID. | 1 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 1 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 1 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 1 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 1 |
FieldableEntityInterface:: |
public static | function | Provides field definitions for a specific bundle. | 2 |
FieldableEntityInterface:: |
public | function | Gets a field item list. | |
FieldableEntityInterface:: |
public | function | Gets the definition of a contained field. | |
FieldableEntityInterface:: |
public | function | Gets an array of field definitions of all contained fields. | |
FieldableEntityInterface:: |
public | function | Gets an array of all field item lists. | |
FieldableEntityInterface:: |
public | function | Gets an array of field item lists for translatable fields. | |
FieldableEntityInterface:: |
public | function | Determines whether the entity has a field with the given name. | |
FieldableEntityInterface:: |
public | function | Checks whether entity validation is required before saving the entity. | |
FieldableEntityInterface:: |
public | function | Reacts to changes to a field. | |
FieldableEntityInterface:: |
public | function | Sets a field value. | |
FieldableEntityInterface:: |
public | function | Sets whether entity validation is required before saving the entity. | |
FieldableEntityInterface:: |
public | function |
Gets an array of all field values. Overrides EntityInterface:: |
|
FieldableEntityInterface:: |
public | function | Validates the currently set values. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | |
RevisionableInterface:: |
public | function | Gets the loaded Revision ID of the entity. | |
RevisionableInterface:: |
public | function | Gets the revision identifier of the entity. | |
RevisionableInterface:: |
public | function | Checks if this entity is the default revision. | |
RevisionableInterface:: |
public | function | Checks if this entity is the latest revision. | |
RevisionableInterface:: |
public | function | Determines whether a new revision should be created on save. | |
RevisionableInterface:: |
public | function | Acts on a revision before it gets saved. | 3 |
RevisionableInterface:: |
public | function | Enforces an entity to be saved as a new revision. | |
RevisionableInterface:: |
public | function | Updates the loaded Revision ID with the revision ID. | |
RevisionableInterface:: |
public | function | Checks whether the entity object was a default revision when it was saved. | |
Shortcut:: |
public static | function |
Provides base field definitions for an entity type. Overrides FieldableEntityInterface:: |
|
Shortcut:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface:: |
|
Shortcut:: |
public | function |
Returns the title of this shortcut. Overrides ShortcutInterface:: |
|
Shortcut:: |
public | function |
Returns the URL object pointing to the configured route. Overrides ShortcutInterface:: |
|
Shortcut:: |
public | function |
Returns the weight among shortcuts with the same depth. Overrides ShortcutInterface:: |
|
Shortcut:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface:: |
|
Shortcut:: |
public | function |
Sets the title of this shortcut. Overrides ShortcutInterface:: |
|
Shortcut:: |
public | function |
Sets the weight among shortcuts with the same depth. Overrides ShortcutInterface:: |
|
Shortcut:: |
public static | function | Sort shortcut objects. | |
SynchronizableInterface:: |
public | function | Returns whether this entity is being changed as part of a synchronization. | |
SynchronizableInterface:: |
public | function | Sets the status of the synchronization flag. | |
TranslatableInterface:: |
public | function | Adds a new translation to the translatable object. | |
TranslatableInterface:: |
public | function | Gets a translation of the data. | |
TranslatableInterface:: |
public | function | Returns the languages the data is translated to. | |
TranslatableInterface:: |
public | function | Returns the translatable object in the language it was created. | |
TranslatableInterface:: |
public | function | Checks there is a translation for the given language code. | |
TranslatableInterface:: |
public | function | Determines if the current translation of the entity has unsaved changes. | |
TranslatableInterface:: |
public | function | Checks whether the translation is the default one. | |
TranslatableInterface:: |
public | function | Checks whether the translation is new. | |
TranslatableInterface:: |
public | function | Returns the translation support status. | |
TranslatableInterface:: |
public | function | Removes the translation identified by the given language code. | |
TranslatableRevisionableInterface:: |
public | function | Checks if untranslatable fields should affect only the default translation. | |
TranslatableRevisionableInterface:: |
public | function | Checks whether this is the latest revision affecting this translation. | |
TranslatableRevisionableInterface:: |
public | function | Checks whether the current translation is affected by the current revision. | |
TranslatableRevisionableInterface:: |
public | function | Checks if the revision translation affected flag value has been enforced. | |
TranslatableRevisionableInterface:: |
public | function | Marks the current revision translation as affected. | |
TranslatableRevisionableInterface:: |
public | function | Enforces the revision translation affected flag value. |