You are here

Home » API reference » Drupal 10 » ShortcutSet.php

class ShortcutSet in Drupal 10

Same name in this branch
  1. 10 core/modules/shortcut/src/Entity/ShortcutSet.php \Drupal\shortcut\Entity\ShortcutSet
  2. 10 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. 8 core/modules/shortcut/src/Entity/ShortcutSet.php \Drupal\shortcut\Entity\ShortcutSet
  2. 9 core/modules/shortcut/src/Entity/ShortcutSet.php \Drupal\shortcut\Entity\ShortcutSet

Defines the Shortcut set configuration entity.

Plugin annotation


@ConfigEntityType(
  id = "shortcut_set",
  label = @Translation("Shortcut set"),
  label_collection = @Translation("Shortcut sets"),
  label_singular = @Translation("shortcut set"),
  label_plural = @Translation("shortcut sets"),
  label_count = @PluralTranslation(
    singular = "@count shortcut set",
    plural = "@count shortcut sets",
  ),
  handlers = {
    "storage" = "Drupal\shortcut\ShortcutSetStorage",
    "access" = "Drupal\shortcut\ShortcutSetAccessControlHandler",
    "list_builder" = "Drupal\shortcut\ShortcutSetListBuilder",
    "form" = {
      "default" = "Drupal\shortcut\ShortcutSetForm",
      "add" = "Drupal\shortcut\ShortcutSetForm",
      "edit" = "Drupal\shortcut\ShortcutSetForm",
      "customize" = "Drupal\shortcut\Form\SetCustomize",
      "delete" = "Drupal\shortcut\Form\ShortcutSetDeleteForm"
    }
  },
  config_prefix = "set",
  bundle_of = "shortcut",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  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",
  },
  config_export = {
    "id",
    "label",
  }
)

Hierarchy

Expanded class hierarchy of ShortcutSet

11 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
shortcut.module in core/modules/shortcut/shortcut.module
Allows users to manage customizable lists of shortcut links.
ShortcutLinksTest.php in core/modules/shortcut/tests/src/Functional/ShortcutLinksTest.php
ShortcutResourceTestBase.php in core/modules/shortcut/tests/src/Functional/Rest/ShortcutResourceTestBase.php

... See full list

File

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

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 = shortcut_default_set();

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

Namesort descending Modifiers Type Description 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.
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. 4
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
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 6
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 3
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 Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete 2
ConfigEntityBundleBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function 2
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::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function 1
EntityBase::bundle public function 1
EntityBase::create public static function 1
EntityBase::delete public function 2
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::getTypedData public function
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function
EntityBase::id public function 10
EntityBase::label public function 5
EntityBase::language public function 1
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 4
EntityBase::postLoad public static function 3
EntityBase::preCreate public static function 5
EntityBase::referencedEntities public function 1
EntityBase::toLink public function
EntityBase::uriRelationships public function
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 1
EntityBase::uuid public function 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
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 Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function