Same filename in this branch
  1. 10 core/modules/shortcut/src/Entity/ShortcutSet.php
  2. 10 core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSet.php
Same filename and directory in other branches
  1. 8.9.x core/modules/shortcut/src/Entity/ShortcutSet.php
  2. 9 core/modules/shortcut/src/Entity/ShortcutSet.php

Namespace

Drupal\shortcut\Entity

File

core/modules/shortcut/src/Entity/ShortcutSet.php
View source
<?php

namespace Drupal\shortcut\Entity;

use Drupal\Core\Config\Entity\ConfigEntityBundleBase;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\shortcut\ShortcutSetInterface;

/**
 * Defines the Shortcut set configuration entity.
 *
 * @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",
 *   }
 * )
 */
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;
  }

}

Classes

Namesort descending Description
ShortcutSet Defines the Shortcut set configuration entity.