www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/shortcut/src/ShortcutInterface.php

   1 <?php
   2
   3 namespace Drupal\shortcut;
   4
   5 use Drupal\Core\Entity\ContentEntityInterface;
   6
   7 /**
   8  * Provides an interface defining a shortcut entity.
   9  */
  10 interface ShortcutInterface extends ContentEntityInterface {
  11
  12   /**
  13    * Returns the title of this shortcut.
  14    *
  15    * @return string
  16    *   The title of this shortcut.
  17    */
  18   public function getTitle();
  19
  20   /**
  21    * Sets the title of this shortcut.
  22    *
  23    * @param string $title
  24    *   The title of this shortcut.
  25    *
  26    * @return \Drupal\shortcut\ShortcutInterface
  27    *   The called shortcut entity.
  28    */
  29   public function setTitle($title);
  30
  31   /**
  32    * Returns the weight among shortcuts with the same depth.
  33    *
  34    * @return int
  35    *   The shortcut weight.
  36    */
  37   public function getWeight();
  38
  39   /**
  40    * Sets the weight among shortcuts with the same depth.
  41    *
  42    * @param int $weight
  43    *   The shortcut weight.
  44    *
  45    * @return \Drupal\shortcut\ShortcutInterface
  46    *   The called shortcut entity.
  47    */
  48   public function setWeight($weight);
  49
  50   /**
  51    * Returns the URL object pointing to the configured route.
  52    *
  53    * @return \Drupal\Core\Url
  54    *   The URL object.
  55    */
  56   public function getUrl();
  57
  58 }