ShortcutInterface.php

Same filename in other branches
  1. 9 core/modules/shortcut/src/ShortcutInterface.php
  2. 8.9.x core/modules/shortcut/src/ShortcutInterface.php
  3. 10 core/modules/shortcut/src/ShortcutInterface.php

Namespace

Drupal\shortcut

File

core/modules/shortcut/src/ShortcutInterface.php

View source
<?php

namespace Drupal\shortcut;

use Drupal\Core\Entity\ContentEntityInterface;

/**
 * Provides an interface defining a shortcut entity.
 */
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();

}

Interfaces

Title Deprecated Summary
ShortcutInterface Provides an interface defining a shortcut entity.

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