8.5.x Entity.php Entity::toLink($text = NULL, $rel = 'canonical', array $options = [])
8.0.x Entity.php Entity::toLink($text = NULL, $rel = 'canonical', array $options = [])
8.1.x Entity.php Entity::toLink($text = NULL, $rel = 'canonical', array $options = [])
8.2.x Entity.php Entity::toLink($text = NULL, $rel = 'canonical', array $options = [])
8.3.x Entity.php Entity::toLink($text = NULL, $rel = 'canonical', array $options = [])
8.4.x Entity.php Entity::toLink($text = NULL, $rel = 'canonical', array $options = [])
8.6.x Entity.php Entity::toLink($text = NULL, $rel = 'canonical', array $options = [])

Generates the HTML for a link to this entity.

Parameters

string|null $text: (optional) The link text for the anchor tag as a translated string. If NULL, it will use the entity's label. Defaults to NULL.

string $rel: (optional) The link relationship type. Defaults to 'canonical'.

array $options: See \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute() for the available options.

Return value

\Drupal\Core\Link A Link to the entity.

Throws

\Drupal\Core\Entity\EntityMalformedException

\Drupal\Core\Entity\Exception\UndefinedLinkTemplateException

Overrides EntityInterface::toLink

File

core/lib/Drupal/Core/Entity/Entity.php, line 265

Class

Entity
Defines a base entity class.

Namespace

Drupal\Core\Entity

Code

public function toLink($text = NULL, $rel = 'canonical', array $options = []) {
  if (!isset($text)) {
    $text = $this
      ->label();
  }
  $url = $this
    ->toUrl($rel);
  $options += $url
    ->getOptions();
  $url
    ->setOptions($options);
  return new Link($text, $url);
}