You are here

interface SuggestionInterface in Linkit 8.5

Defines the interface for suggestions.

Hierarchy

  • interface \Drupal\linkit\Suggestion\SuggestionInterface extends \Drupal\linkit\Suggestion\JsonSerializable

Expanded class hierarchy of SuggestionInterface

All classes that implement SuggestionInterface

File

src/Suggestion/SuggestionInterface.php, line 8

Namespace

Drupal\linkit\Suggestion
View source
interface SuggestionInterface extends \JsonSerializable {

  /**
   * Gets the suggestion label.
   *
   * @return string
   *   The suggestion label.
   */
  public function getLabel();

  /**
   * Sets the suggestion label.
   *
   * @param string $label
   *   The suggestion label to set.
   *
   * @return $this
   */
  public function setLabel($label);

  /**
   * Gets the suggestion path.
   *
   * @return string
   *   The suggestion path.
   */
  public function getPath();

  /**
   * Sets the suggestion path.
   *
   * @param string $path
   *   The suggestion path to set.
   *
   * @return $this
   */
  public function setPath($path);

  /**
   * Gets the suggestion group.
   *
   * @return string
   *   The suggestion group.
   */
  public function getGroup();

  /**
   * Sets the suggestion group.
   *
   * @param string $group
   *   The suggestion group to set.
   *
   * @return $this
   */
  public function setGroup($group);

}

Members

Namesort descending Modifiers Type Description Overrides
SuggestionInterface::getGroup public function Gets the suggestion group. 1
SuggestionInterface::getLabel public function Gets the suggestion label. 1
SuggestionInterface::getPath public function Gets the suggestion path. 1
SuggestionInterface::setGroup public function Sets the suggestion group. 1
SuggestionInterface::setLabel public function Sets the suggestion label. 1
SuggestionInterface::setPath public function Sets the suggestion path. 1