class Shortcut

Same name in this branch
  1. 11.x core/modules/shortcut/src/Plugin/migrate/source/d7/Shortcut.php \Drupal\shortcut\Plugin\migrate\source\d7\Shortcut
Same name in other branches
  1. 9 core/modules/shortcut/src/Entity/Shortcut.php \Drupal\shortcut\Entity\Shortcut
  2. 9 core/modules/shortcut/src/Plugin/migrate/source/d7/Shortcut.php \Drupal\shortcut\Plugin\migrate\source\d7\Shortcut
  3. 8.9.x core/modules/shortcut/src/Entity/Shortcut.php \Drupal\shortcut\Entity\Shortcut
  4. 8.9.x core/modules/shortcut/src/Plugin/migrate/source/d7/Shortcut.php \Drupal\shortcut\Plugin\migrate\source\d7\Shortcut
  5. 10 core/modules/shortcut/src/Entity/Shortcut.php \Drupal\shortcut\Entity\Shortcut
  6. 10 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

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

Expanded class hierarchy of Shortcut

12 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
NavigationShortcutsBlockTest.php in core/modules/navigation/tests/src/Functional/NavigationShortcutsBlockTest.php
ShortcutCacheTagsTest.php in core/modules/shortcut/tests/src/Functional/ShortcutCacheTagsTest.php

... See full list

37 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
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

... See full list

File

core/modules/shortcut/src/Entity/Shortcut.php, line 57

Namespace

Drupal\shortcut\Entity
View 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' => 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

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
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 Checks data value access. Overrides EntityBase::access 1
ContentEntityBase::addTranslation public function
ContentEntityBase::bundle public function Gets the bundle of the entity. Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions public static function 5
ContentEntityBase::clearTranslationCache protected function Clears entity translation object cache to remove stale references.
ContentEntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityBase::create
ContentEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ContentEntityBase::get public function
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined. 1
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. 1
ContentEntityBase::getIterator public function
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 Returns the translation status. Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated public function
ContentEntityBase::hasField public function
ContentEntityBase::hasTranslation public function
ContentEntityBase::hasTranslationChanges public function
ContentEntityBase::id public function Gets the identifier. Overrides EntityBase::id
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 Gets the label of the entity. Overrides EntityBase::label 4
ContentEntityBase::language public function Gets the language of the entity. Overrides EntityBase::language
ContentEntityBase::onChange public function
ContentEntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate 1
ContentEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 8
ContentEntityBase::preSaveRevision public function 3
ContentEntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityBase::referencedEntities 1
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 Gets an array of all property values. Overrides EntityBase::toArray
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 Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase::uuid
ContentEntityBase::validate public function 1
ContentEntityBase::wasDefaultRevision public function
ContentEntityBase::__clone public function Magic method: Implements a deep clone.
ContentEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct
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 Overrides EntityBase::__sleep
ContentEntityBase::__unset public function Implements the magic method for unset().
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName 1
EntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget 1
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType 1
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId 1
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::invalidateTagsOnDelete protected static function Invalidates an entity&#039;s cache tags upon delete. 1
EntityBase::invalidateTagsOnSave protected function Invalidates an entity&#039;s cache tags upon save. 2
EntityBase::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew 2
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 17
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 6
EntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 7
EntityBase::save public function Saves an entity permanently. Overrides EntityInterface::save 3
EntityBase::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 2
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
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 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
Shortcut::baseFieldDefinitions public static function 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.