Mercurial > hg > isophonics-drupal-site
annotate core/modules/shortcut/src/ShortcutInterface.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 4c8ae668cc8c |
children |
rev | line source |
---|---|
Chris@0 | 1 <?php |
Chris@0 | 2 |
Chris@0 | 3 namespace Drupal\shortcut; |
Chris@0 | 4 |
Chris@0 | 5 use Drupal\Core\Entity\ContentEntityInterface; |
Chris@0 | 6 |
Chris@0 | 7 /** |
Chris@0 | 8 * Provides an interface defining a shortcut entity. |
Chris@0 | 9 */ |
Chris@0 | 10 interface ShortcutInterface extends ContentEntityInterface { |
Chris@0 | 11 |
Chris@0 | 12 /** |
Chris@0 | 13 * Returns the title of this shortcut. |
Chris@0 | 14 * |
Chris@0 | 15 * @return string |
Chris@0 | 16 * The title of this shortcut. |
Chris@0 | 17 */ |
Chris@0 | 18 public function getTitle(); |
Chris@0 | 19 |
Chris@0 | 20 /** |
Chris@0 | 21 * Sets the title of this shortcut. |
Chris@0 | 22 * |
Chris@0 | 23 * @param string $title |
Chris@0 | 24 * The title of this shortcut. |
Chris@0 | 25 * |
Chris@0 | 26 * @return \Drupal\shortcut\ShortcutInterface |
Chris@0 | 27 * The called shortcut entity. |
Chris@0 | 28 */ |
Chris@0 | 29 public function setTitle($title); |
Chris@0 | 30 |
Chris@0 | 31 /** |
Chris@0 | 32 * Returns the weight among shortcuts with the same depth. |
Chris@0 | 33 * |
Chris@0 | 34 * @return int |
Chris@0 | 35 * The shortcut weight. |
Chris@0 | 36 */ |
Chris@0 | 37 public function getWeight(); |
Chris@0 | 38 |
Chris@0 | 39 /** |
Chris@0 | 40 * Sets the weight among shortcuts with the same depth. |
Chris@0 | 41 * |
Chris@0 | 42 * @param int $weight |
Chris@0 | 43 * The shortcut weight. |
Chris@0 | 44 * |
Chris@0 | 45 * @return \Drupal\shortcut\ShortcutInterface |
Chris@0 | 46 * The called shortcut entity. |
Chris@0 | 47 */ |
Chris@0 | 48 public function setWeight($weight); |
Chris@0 | 49 |
Chris@0 | 50 /** |
Chris@0 | 51 * Returns the URL object pointing to the configured route. |
Chris@0 | 52 * |
Chris@0 | 53 * @return \Drupal\Core\Url |
Chris@0 | 54 * The URL object. |
Chris@0 | 55 */ |
Chris@0 | 56 public function getUrl(); |
Chris@0 | 57 |
Chris@0 | 58 } |