interface ShortcutInterface in Drupal 10

Provides an interface defining a shortcut entity.

Hierarchy

• interface \Drupal\Core\Entity\FieldableEntityInterface; interface \Drupal\Core\Entity\TranslatableRevisionableInterface; interface \Drupal\Core\Entity\SynchronizableInterface
  • interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable
    • interface \Drupal\shortcut\ShortcutInterface

2 files declare their use of ShortcutInterface

Shortcut.php in core/modules/shortcut/src/Entity/Shortcut.php

ShortcutController.php in core/modules/shortcut/src/Controller/ShortcutController.php

File

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

Namespace

Drupal\shortcut

interface ShortcutInterface extends ContentEntityInterface {

  /**
   * Returns the title of this shortcut.
   *
   * @return string
   *   The title of this shortcut.
   */
  public function getTitle();

  /**
   * Sets the title of this shortcut.
   *
   * @param string $title
   *   The title of this shortcut.
   *
   * @return $this
   *   The called shortcut entity.
   */
  public function setTitle($title);

  /**
   * Returns the weight among shortcuts with the same depth.
   *
   * @return int
   *   The shortcut weight.
   */
  public function getWeight();

  /**
   * Sets the weight among shortcuts with the same depth.
   *
   * @param int $weight
   *   The shortcut weight.
   *
   * @return $this
   *   The called shortcut entity.
   */
  public function setWeight($weight);

  /**
   * Returns the URL object pointing to the configured route.
   *
   * @return \Drupal\Core\Url
   *   The URL object.
   */
  public function getUrl();

}