class Shortcut
Same name in this branch
- main core/modules/shortcut/src/Plugin/migrate/source/d7/Shortcut.php \Drupal\shortcut\Plugin\migrate\source\d7\Shortcut
Same name and namespace in other branches
- 11.x core/modules/shortcut/src/Entity/Shortcut.php \Drupal\shortcut\Entity\Shortcut
- 11.x core/modules/shortcut/src/Plugin/migrate/source/d7/Shortcut.php \Drupal\shortcut\Plugin\migrate\source\d7\Shortcut
- 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
- 9 core/modules/shortcut/src/Entity/Shortcut.php \Drupal\shortcut\Entity\Shortcut
- 9 core/modules/shortcut/src/Plugin/migrate/source/d7/Shortcut.php \Drupal\shortcut\Plugin\migrate\source\d7\Shortcut
- 8.9.x core/modules/shortcut/src/Entity/Shortcut.php \Drupal\shortcut\Entity\Shortcut
- 8.9.x core/modules/shortcut/src/Plugin/migrate/source/d7/Shortcut.php \Drupal\shortcut\Plugin\migrate\source\d7\Shortcut
Defines the shortcut entity class.
@property \Drupal\link\LinkItemInterface $link
Attributes
#[ContentEntityType(id: 'shortcut', label: new TranslatableMarkup('Shortcut link'), label_collection: new TranslatableMarkup('Shortcut links'), label_singular: new TranslatableMarkup('shortcut link'), label_plural: new TranslatableMarkup('shortcut links'), entity_keys: [
'id' => 'id',
'uuid' => 'uuid',
'bundle' => 'shortcut_set',
'label' => 'title',
'langcode' => 'langcode',
], handlers: [
'access' => ShortcutAccessControlHandler::class,
'form' => [
'default' => ShortcutForm::class,
'add' => ShortcutForm::class,
'edit' => ShortcutForm::class,
'delete' => ShortcutDeleteForm::class,
],
'link_target' => [
'view' => ShortcutLinkTarget::class,
],
], 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}',
], bundle_entity_type: 'shortcut_set', bundle_label: new TranslatableMarkup('Shortcut set'), base_table: 'shortcut', data_table: 'shortcut_field_data', translatable: TRUE, label_count: [
'singular' => '@count shortcut link',
'plural' => '@count shortcut links',
], list_cache_tags: [
'config:shortcut_set_list',
])]
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
- class \Drupal\shortcut\Entity\Shortcut implements \Drupal\shortcut\ShortcutInterface extends \Drupal\Core\Entity\ContentEntityBase
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
Expanded class hierarchy of Shortcut
14 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 profile.
- EntityLinksTest.php in core/
modules/ filter/ tests/ src/ Kernel/ EntityLinksTest.php - JsonApiFilterRegressionTest.php in core/
modules/ jsonapi/ tests/ src/ Functional/ JsonApiFilterRegressionTest.php - MigrateShortcutTest.php in core/
modules/ shortcut/ tests/ src/ Kernel/ Migrate/ d7/ MigrateShortcutTest.php - NavigationShortcutsBlockTest.php in core/
modules/ navigation/ tests/ src/ Functional/ NavigationShortcutsBlockTest.php
43 string references to 'Shortcut'
- 478b3170-1dfd-49d8-8eb3-f1b285445ab7.yml in core/
recipes/ basic_shortcuts/ content/ shortcut/ 478b3170-1dfd-49d8-8eb3-f1b285445ab7.yml - core/recipes/basic_shortcuts/content/shortcut/478b3170-1dfd-49d8-8eb3-f1b285445ab7.yml
- BlockInstallTest::testCacheTagInvalidationUponInstallation in core/
modules/ block/ tests/ src/ Functional/ BlockInstallTest.php - Tests cache tag invalidation after installing the block module.
- ConfigActionValidationTest::setUp in core/
tests/ Drupal/ KernelTests/ Core/ Recipe/ ConfigActionValidationTest.php - d5377721-d6de-4fdf-82e2-557c50f84ceb.yml in core/
recipes/ basic_shortcuts/ content/ shortcut/ d5377721-d6de-4fdf-82e2-557c50f84ceb.yml - core/recipes/basic_shortcuts/content/shortcut/d5377721-d6de-4fdf-82e2-557c50f84ceb.yml
- demo_umami.info.yml in core/
profiles/ demo_umami/ demo_umami.info.yml - core/profiles/demo_umami/demo_umami.info.yml
File
-
core/
modules/ shortcut/ src/ Entity/ Shortcut.php, line 24
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);
// EntityBase::postSave() calls EntityBase::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' => LinkTitleVisibility::Disabled->value,
])
->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
| Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title |
|---|---|---|---|---|---|
| CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | ||
| CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | ||
| CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | ||
| CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | ||
| ContentEntityBase::$activeLangcode | protected | property | Language code identifying the entity active language. | ||
| ContentEntityBase::$defaultLangcode | protected | property | Local cache for the default language code. | ||
| ContentEntityBase::$defaultLangcodeKey | protected | property | The default langcode entity key. | ||
| ContentEntityBase::$enforceDefaultTranslation | protected | property | Override the result of isDefaultTranslation(). | ||
| ContentEntityBase::$enforceRevisionTranslationAffected | protected | property | Whether the revision translation affected flag has been enforced. | ||
| ContentEntityBase::$entityKeys | protected | property | Holds untranslatable entity keys such as the ID, bundle, and revision ID. | ||
| ContentEntityBase::$fieldDefinitions | protected | property | Local cache for field definitions. | ||
| ContentEntityBase::$fields | protected | property | The array of fields, each being an instance of FieldItemListInterface. | ||
| ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck | protected static | property | Local cache for fields to skip from the checking for translation changes. | ||
| ContentEntityBase::$isDefaultRevision | protected | property | Indicates whether this is the default revision. | ||
| ContentEntityBase::$langcodeKey | protected | property | The language entity key. | ||
| ContentEntityBase::$languages | protected | property | Local cache for the available language objects. | ||
| ContentEntityBase::$loadedRevisionId | protected | property | The loaded revision ID before the new revision was set. | ||
| ContentEntityBase::$newRevision | protected | property | Boolean indicating whether a new revision should be created on save. | ||
| ContentEntityBase::$revisionTranslationAffectedKey | protected | property | The revision translation affected entity key. | ||
| ContentEntityBase::$translatableEntityKeys | protected | property | Holds translatable entity keys such as the label. | ||
| ContentEntityBase::$translationInitialize | protected | property | A flag indicating whether a translation object is being initialized. | ||
| ContentEntityBase::$translations | protected | property | An array of entity translation metadata. | ||
| ContentEntityBase::$validated | protected | property | Whether entity validation was performed. | ||
| ContentEntityBase::$validationRequired | protected | property | Whether entity validation is required before saving the entity. | ||
| ContentEntityBase::$values | protected | property | The plain data values of the contained fields. | ||
| ContentEntityBase::access | public | function | |||
| ContentEntityBase::addTranslation | public | function | |||
| ContentEntityBase::bundle | public | function | |||
| ContentEntityBase::bundleFieldDefinitions | public static | function | |||
| ContentEntityBase::clearTranslationCache | protected | function | Clears entity translation object cache to remove stale references. | ||
| ContentEntityBase::create | public static | function | |||
| ContentEntityBase::createDuplicate | public | function | |||
| ContentEntityBase::get | public | function | |||
| ContentEntityBase::getBundleEntity | public | function | |||
| ContentEntityBase::getEntityKey | protected | function | Gets the value of the given entity key, if defined. | ||
| ContentEntityBase::getFieldDefinition | public | function | |||
| ContentEntityBase::getFieldDefinitions | public | function | |||
| ContentEntityBase::getFields | public | function | |||
| ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck | protected | function | Returns an array of field names to skip in ::hasTranslationChanges. | ||
| ContentEntityBase::getIterator | public | function | Retrieves the iterator for the object. | ||
| ContentEntityBase::getLanguages | protected | function | |||
| ContentEntityBase::getLoadedRevisionId | public | function | |||
| ContentEntityBase::getRevisionId | public | function | |||
| ContentEntityBase::getTranslatableFields | public | function | |||
| ContentEntityBase::getTranslatedField | protected | function | Gets a translated field. | ||
| ContentEntityBase::getTranslation | public | function | |||
| ContentEntityBase::getTranslationLanguages | public | function | |||
| ContentEntityBase::getTranslationStatus | public | function | |||
| ContentEntityBase::getUntranslated | public | function | |||
| ContentEntityBase::hasField | public | function | |||
| ContentEntityBase::hasTranslation | public | function | |||
| ContentEntityBase::hasTranslationChanges | public | function | |||
| ContentEntityBase::id | public | function | |||
| ContentEntityBase::initializeTranslation | protected | function | Instantiates a translation object for an existing translation. | ||
| ContentEntityBase::isDefaultRevision | public | function | |||
| ContentEntityBase::isDefaultTranslation | public | function | |||
| ContentEntityBase::isDefaultTranslationAffectedOnly | public | function | |||
| ContentEntityBase::isLatestRevision | public | function | |||
| ContentEntityBase::isLatestTranslationAffectedRevision | public | function | |||
| ContentEntityBase::isNewRevision | public | function | |||
| ContentEntityBase::isNewTranslation | public | function | |||
| ContentEntityBase::isRevisionTranslationAffected | public | function | |||
| ContentEntityBase::isRevisionTranslationAffectedEnforced | public | function | |||
| ContentEntityBase::isTranslatable | public | function | |||
| ContentEntityBase::isValidationRequired | public | function | |||
| ContentEntityBase::label | public | function | |||
| ContentEntityBase::language | public | function | |||
| ContentEntityBase::onChange | public | function | |||
| ContentEntityBase::postCreate | public | function | |||
| ContentEntityBase::preSave | public | function | |||
| ContentEntityBase::preSaveRevision | public | function | |||
| ContentEntityBase::referencedEntities | public | function | |||
| ContentEntityBase::removeTranslation | public | function | |||
| ContentEntityBase::set | public | function | |||
| ContentEntityBase::setDefaultLangcode | protected | function | Populates the local cache for the default language code. | ||
| ContentEntityBase::setDefaultTranslationEnforced | public | function | Set or clear an override of the isDefaultTranslation() result. | ||
| ContentEntityBase::setNewRevision | public | function | |||
| ContentEntityBase::setRevisionTranslationAffected | public | function | |||
| ContentEntityBase::setRevisionTranslationAffectedEnforced | public | function | |||
| ContentEntityBase::setValidationRequired | public | function | |||
| ContentEntityBase::toArray | public | function | |||
| ContentEntityBase::updateFieldLangcodes | protected | function | Updates language for already instantiated fields. | ||
| ContentEntityBase::updateLoadedRevisionId | public | function | |||
| ContentEntityBase::updateOriginalValues | public | function | Updates the original values with the interim changes. | ||
| ContentEntityBase::uuid | public | function | |||
| ContentEntityBase::validate | public | function | |||
| ContentEntityBase::wasDefaultRevision | public | function | |||
| ContentEntityBase::__clone | public | function | Magic method: Implements a deep clone. | ||
| ContentEntityBase::__construct | public | function | |||
| ContentEntityBase::__get | public | function | Implements the magic method for getting object properties. | ||
| ContentEntityBase::__isset | public | function | Implements the magic method for isset(). | ||
| ContentEntityBase::__set | public | function | Implements the magic method for setting object properties. | ||
| ContentEntityBase::__sleep | public | function | |||
| ContentEntityBase::__unset | public | function | Implements the magic method for unset(). | ||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
| DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep | ||
| DependencySerializationTrait::__wakeup | public | function | |||
| EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | ||
| EntityBase::$entityTypeId | protected | property | The entity type. | ||
| EntityBase::$originalEntity | protected | property | The original unchanged entity. | ||
| EntityBase::$typedData | protected | property | A typed data object wrapping this entity. | ||
| EntityBase::delete | public | function | |||
| EntityBase::enforceIsNew | public | function | |||
| EntityBase::entityTypeBundleInfo | protected | function | Gets the entity type bundle info service. | ||
| EntityBase::entityTypeManager | protected | function | Gets the entity type manager. | ||
| EntityBase::getCacheContexts | public | function | |||
| EntityBase::getCacheMaxAge | public | function | |||
| EntityBase::getCacheTags | public | function | |||
| EntityBase::getConfigDependencyKey | public | function | |||
| EntityBase::getConfigDependencyName | public | function | |||
| EntityBase::getConfigTarget | public | function | |||
| EntityBase::getEntityType | public | function | |||
| EntityBase::getEntityTypeId | public | function | |||
| EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | ||
| EntityBase::getOriginal | public | function | |||
| EntityBase::getOriginalId | public | function | |||
| EntityBase::getTypedData | public | function | |||
| EntityBase::getTypedDataClass | private | function | Returns the typed data class name for this entity. | ||
| EntityBase::hasLinkTemplate | public | function | |||
| EntityBase::invalidateTagsOnDelete | protected static | function | Invalidates an entity's cache tags upon delete. | ||
| EntityBase::invalidateTagsOnSave | protected | function | Invalidates an entity's cache tags upon save. | ||
| EntityBase::isNew | public | function | |||
| EntityBase::languageManager | protected | function | Gets the language manager. | ||
| EntityBase::linkTemplates | protected | function | Gets an array link templates. | ||
| EntityBase::load | public static | function | |||
| EntityBase::loadMultiple | public static | function | |||
| EntityBase::postDelete | public static | function | |||
| EntityBase::postLoad | public static | function | |||
| EntityBase::preCreate | public static | function | |||
| EntityBase::preDelete | public static | function | |||
| EntityBase::save | public | function | |||
| EntityBase::setOriginal | public | function | |||
| EntityBase::setOriginalId | public | function | |||
| EntityBase::toLink | public | function | |||
| EntityBase::toUrl | public | function | |||
| EntityBase::uriRelationships | public | function | |||
| EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | ||
| EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | ||
| EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck | protected | function | Returns an array of field names to skip when checking for changes. | Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck | |
| RefinableCacheableDependencyTrait::addCacheableDependency | public | function | |||
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | |||
| RefinableCacheableDependencyTrait::addCacheTags | public | function | |||
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | |||
| Shortcut::baseFieldDefinitions | public static | function | Provides base field definitions for an entity type. | Overrides ContentEntityBase::baseFieldDefinitions | |
| Shortcut::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | Overrides EntityBase::getCacheTagsToInvalidate | |
| Shortcut::getTitle | public | function | Returns the title of this shortcut. | Overrides ShortcutInterface::getTitle | |
| Shortcut::getUrl | public | function | Returns the URL object pointing to the configured route. | Overrides ShortcutInterface::getUrl | |
| Shortcut::getWeight | public | function | Returns the weight among shortcuts with the same depth. | Overrides ShortcutInterface::getWeight | |
| Shortcut::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides ContentEntityBase::postSave | |
| Shortcut::setTitle | public | function | Sets the title of this shortcut. | Overrides ShortcutInterface::setTitle | |
| Shortcut::setWeight | public | function | Sets the weight among shortcuts with the same depth. | Overrides ShortcutInterface::setWeight | |
| Shortcut::sort | public static | function | Sort shortcut objects. | ||
| SynchronizableEntityTrait::$isSyncing | protected | property | Is entity being created updated or deleted through synchronization process. | ||
| SynchronizableEntityTrait::isSyncing | public | function | |||
| SynchronizableEntityTrait::setSyncing | public | function | |||
| TranslationStatusInterface::TRANSLATION_CREATED | constant | Status code identifying a newly created translation. | |||
| TranslationStatusInterface::TRANSLATION_EXISTING | constant | Status code identifying an existing translation. | |||
| TranslationStatusInterface::TRANSLATION_REMOVED | constant | Status code identifying a removed translation. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.