DescriptionSuggestion.php in Linkit 8.5

Namespace

Drupal\linkit\Suggestion

File

src/Suggestion/DescriptionSuggestion.php

<?php

namespace Drupal\linkit\Suggestion;


/**
 * Defines a linkit suggestion with description.
 */
class DescriptionSuggestion extends SimpleSuggestion implements SuggestionDescriptionInterface {

  /**
   * The suggestion description.
   *
   * A string with additional information about the suggestion.
   *
   * @var string
   */
  protected $description;

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * {@inheritdoc}
   */
  public function setDescription($description) {
    $this->description = $description;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function jsonSerialize() {
    return parent::jsonSerialize() + [
      'description' => $this
        ->getDescription(),
    ];
  }

}

Classes

Name	Description
DescriptionSuggestion	Defines a linkit suggestion with description.