interface ShortcutSetInterface

Same name and namespace in other branches
  1. 11.x core/modules/shortcut/src/ShortcutSetInterface.php \Drupal\shortcut\ShortcutSetInterface
  2. 10 core/modules/shortcut/src/ShortcutSetInterface.php \Drupal\shortcut\ShortcutSetInterface
  3. 8.9.x core/modules/shortcut/src/ShortcutSetInterface.php \Drupal\shortcut\ShortcutSetInterface

Provides an interface defining a shortcut set entity.

Hierarchy

Expanded class hierarchy of ShortcutSetInterface

All classes that implement ShortcutSetInterface

6 files declare their use of ShortcutSetInterface
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.
ShortcutController.php in core/modules/shortcut/src/Controller/ShortcutController.php
ShortcutSet.php in core/modules/shortcut/src/Entity/ShortcutSet.php
ShortcutSetController.php in core/modules/shortcut/src/Controller/ShortcutSetController.php

... See full list

File

core/modules/shortcut/src/ShortcutSetInterface.php, line 10

Namespace

Drupal\shortcut
View source
interface ShortcutSetInterface extends ConfigEntityInterface {
  
  /**
   * Resets the link weights in a shortcut set to match their current order.
   *
   * This function can be used, for example, when a new shortcut link is added
   * to the set. If the link is added to the end of the array and this function
   * is called, it will force that link to display at the end of the list.
   *
   * @return $this
   *   The shortcut set.
   */
  public function resetLinkWeights();
  
  /**
   * Returns all the shortcuts from a shortcut set sorted correctly.
   *
   * @return \Drupal\shortcut\ShortcutInterface[]
   *   An array of shortcut entities.
   */
  public function getShortcuts();

}

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