class ShortcutSet

Same name in this branch
  1. main core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSet.php \Drupal\shortcut\Plugin\migrate\source\d7\ShortcutSet
Same name and namespace in other branches
  1. 11.x core/modules/shortcut/src/Entity/ShortcutSet.php \Drupal\shortcut\Entity\ShortcutSet
  2. 11.x core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSet.php \Drupal\shortcut\Plugin\migrate\source\d7\ShortcutSet
  3. 10 core/modules/shortcut/src/Entity/ShortcutSet.php \Drupal\shortcut\Entity\ShortcutSet
  4. 10 core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSet.php \Drupal\shortcut\Plugin\migrate\source\d7\ShortcutSet
  5. 9 core/modules/shortcut/src/Entity/ShortcutSet.php \Drupal\shortcut\Entity\ShortcutSet
  6. 9 core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSet.php \Drupal\shortcut\Plugin\migrate\source\d7\ShortcutSet
  7. 8.9.x core/modules/shortcut/src/Entity/ShortcutSet.php \Drupal\shortcut\Entity\ShortcutSet
  8. 8.9.x core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSet.php \Drupal\shortcut\Plugin\migrate\source\d7\ShortcutSet

Defines the Shortcut set configuration entity.

Attributes

#[ConfigEntityType(id: 'shortcut_set', label: new TranslatableMarkup('Shortcut set'), label_collection: new TranslatableMarkup('Shortcut sets'), label_singular: new TranslatableMarkup('shortcut set'), label_plural: new TranslatableMarkup('shortcut sets'), config_prefix: 'set', entity_keys: [ 'id' => 'id', 'label' => 'label', ], handlers: [ 'storage' => ShortcutSetStorage::class, 'access' => ShortcutSetAccessControlHandler::class, 'list_builder' => ShortcutSetListBuilder::class, 'form' => [ 'default' => ShortcutSetForm::class, 'add' => ShortcutSetForm::class, 'edit' => ShortcutSetForm::class, 'customize' => SetCustomize::class, 'delete' => ShortcutSetDeleteForm::class, ], ], links: [ 'customize-form' => '/admin/config/user-interface/shortcut/manage/{shortcut_set}/customize', 'delete-form' => '/admin/config/user-interface/shortcut/manage/{shortcut_set}/delete', 'edit-form' => '/admin/config/user-interface/shortcut/manage/{shortcut_set}', 'collection' => '/admin/config/user-interface/shortcut', ], bundle_of: 'shortcut', label_count: [ 'singular' => '@count shortcut set', 'plural' => '@count shortcut sets', ], config_export: [ 'id', 'label', ])]

Hierarchy

Expanded class hierarchy of ShortcutSet

14 files declare their use of ShortcutSet
ConfigTranslationListUiTest.php in core/modules/config_translation/tests/src/Functional/ConfigTranslationListUiTest.php
MigrateShortcutSetTest.php in core/modules/shortcut/tests/src/Kernel/Migrate/d7/MigrateShortcutSetTest.php
NavigationShortcutsBlockTest.php in core/modules/navigation/tests/src/Functional/NavigationShortcutsBlockTest.php
ShortcutCacheTagsTest.php in core/modules/shortcut/tests/src/Kernel/ShortcutCacheTagsTest.php
ShortcutCacheTagsTest.php in core/modules/shortcut/tests/src/Functional/ShortcutCacheTagsTest.php

... See full list

File

core/modules/shortcut/src/Entity/ShortcutSet.php, line 20

Namespace

Drupal\shortcut\Entity
View source
class ShortcutSet extends ConfigEntityBundleBase implements ShortcutSetInterface {
  
  /**
   * The machine name for the configuration entity.
   *
   * @var string
   */
  protected $id;
  
  /**
   * The human-readable name of the configuration entity.
   *
   * @var string
   */
  protected $label;
  
  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    if (!$update && !$this->isSyncing()) {
      // Save a new shortcut set with links copied from the user's default set.
      $default_set = $storage->getDefaultSet(\Drupal::currentUser());
      // This is the default set, do not copy shortcuts.
      if ($default_set->id() != $this->id()) {
        foreach ($default_set->getShortcuts() as $shortcut) {
          $shortcut = $shortcut->createDuplicate();
          $shortcut->enforceIsNew();
          $shortcut->shortcut_set->target_id = $this->id();
          $shortcut->save();
        }
      }
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public static function preDelete(EntityStorageInterface $storage, array $entities) {
    parent::preDelete($storage, $entities);
    foreach ($entities as $entity) {
      $storage->deleteAssignedShortcutSets($entity);
      // Next, delete the shortcuts for this set.
      $shortcut_ids = \Drupal::entityQuery('shortcut')->accessCheck(FALSE)
        ->condition('shortcut_set', $entity->id(), '=')
        ->execute();
      $controller = \Drupal::entityTypeManager()->getStorage('shortcut');
      $entities = $controller->loadMultiple($shortcut_ids);
      $controller->delete($entities);
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function resetLinkWeights() {
    $weight = -50;
    foreach ($this->getShortcuts() as $shortcut) {
      $shortcut->setWeight(++$weight);
      $shortcut->save();
    }
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getShortcuts() {
    $shortcuts = \Drupal::entityTypeManager()->getStorage('shortcut')
      ->loadByProperties([
      'shortcut_set' => $this->id(),
    ]);
    uasort($shortcuts, [
      '\\Drupal\\shortcut\\Entity\\Shortcut',
      'sort',
    ]);
    return $shortcuts;
  }

}

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.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity.
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function
ConfigEntityBase::createDuplicate public function
ConfigEntityBase::disable public function #[ActionMethod(adminLabel: new TranslatableMarkup('Disable'), pluralize: FALSE)]
ConfigEntityBase::enable public function #[ActionMethod(adminLabel: new TranslatableMarkup('Enable'), pluralize: FALSE)]
ConfigEntityBase::get public function
ConfigEntityBase::getCacheTagsToInvalidate public function
ConfigEntityBase::getConfigDependencyName public function
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function
ConfigEntityBase::getDependencies public function
ConfigEntityBase::getOriginalId public function
ConfigEntityBase::getThirdPartyProviders public function
ConfigEntityBase::getThirdPartySetting public function
ConfigEntityBase::getThirdPartySettings public function
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the
config system already invalidates them.
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system
already invalidates it.
ConfigEntityBase::isInstallable public function
ConfigEntityBase::isNew public function Overrides EntityBase::isNew().
ConfigEntityBase::isUninstalling public function
ConfigEntityBase::onDependencyRemoval public function
ConfigEntityBase::save public function
ConfigEntityBase::set public function #[ActionMethod(adminLabel: new TranslatableMarkup('Set a value'), pluralize: 'setMultiple')]
ConfigEntityBase::setOriginalId public function
ConfigEntityBase::setStatus public function #[ActionMethod(adminLabel: new TranslatableMarkup('Set status'), pluralize: FALSE)]
ConfigEntityBase::setThirdPartySetting public function #[ActionMethod(adminLabel: new TranslatableMarkup('Set third-party setting'))]
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Callback for uasort() to sort configuration entities by weight and label.
ConfigEntityBase::status public function
ConfigEntityBase::toArray public function
ConfigEntityBase::toUrl public function
ConfigEntityBase::trustData public function
ConfigEntityBase::unsetThirdPartySetting public function
ConfigEntityBase::__construct public function
ConfigEntityBase::__sleep public function
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBundleBase::postDelete public static function
ConfigEntityBundleBase::preSave public function Acts on an entity before the presave hook is invoked.
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
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
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::access public function
EntityBase::bundle public function
EntityBase::create public static function
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::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::getTypedData public function
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function
EntityBase::id public function
EntityBase::label public function
EntityBase::language 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::postCreate public function
EntityBase::postLoad public static function
EntityBase::preCreate public static function
EntityBase::referencedEntities public function
EntityBase::setOriginal public function
EntityBase::toLink public function
EntityBase::uriRelationships public function
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity.
EntityBase::uuid public function
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance.
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler.
PluginDependencyTrait::themeHandler protected function Wraps the theme handler.
RefinableCacheableDependencyTrait::addCacheableDependency public function
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
ShortcutSet::$id protected property The machine name for the configuration entity.
ShortcutSet::$label protected property The human-readable name of the configuration entity.
ShortcutSet::getShortcuts public function Returns all the shortcuts from a shortcut set sorted correctly. Overrides ShortcutSetInterface::getShortcuts
ShortcutSet::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase::postSave
ShortcutSet::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides ConfigEntityBase::preDelete
ShortcutSet::resetLinkWeights public function Resets the link weights in a shortcut set to match their current order. Overrides ShortcutSetInterface::resetLinkWeights
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.