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
12 files declare their use of Shortcut
- MigrateShortcutTest.php in core/
modules/ shortcut/ tests/ src/ Kernel/ Migrate/ d7/ MigrateShortcutTest.php - NavigationShortcutsBlockTest.php in core/
modules/ shortcut/ tests/ src/ Functional/ NavigationShortcutsBlockTest.php - NavigationShortcutsBlockTest.php in core/
modules/ navigation/ tests/ src/ Functional/ NavigationShortcutsBlockTest.php - ShortcutCacheTagsTest.php in core/
modules/ shortcut/ tests/ src/ Functional/ ShortcutCacheTagsTest.php - ShortcutCacheTagsTest.php in core/
modules/ shortcut/ tests/ src/ Kernel/ ShortcutCacheTagsTest.php
30 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
- 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
- MigrateShortcutSetTest::setUp in core/
modules/ shortcut/ tests/ src/ Kernel/ Migrate/ d7/ MigrateShortcutSetTest.php - MigrateShortcutSetUsersTest::setUp in core/
modules/ shortcut/ tests/ src/ Kernel/ Migrate/ d7/ MigrateShortcutSetUsersTest.php - MigrateShortcutStubTest::setUp in core/
modules/ shortcut/ tests/ src/ Kernel/ Migrate/ MigrateShortcutStubTest.php
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
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.