EntityLinkTargetInterface.php

Namespace

Drupal\Core\Entity

File

core/lib/Drupal/Core/Entity/EntityLinkTargetInterface.php

View source
<?php

declare (strict_types=1);
namespace Drupal\Core\Entity;

use Drupal\Core\GeneratedUrl;

/**
 * Provides an interface for generating a link target from an entity.
 */
interface EntityLinkTargetInterface {
  
  /**
   * Gets the generated URL object for a linked entity's link target.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   A linked entity.
   *
   * @return \Drupal\Core\GeneratedUrl
   *   The generated URL plus cacheability metadata.
   */
  public function getLinkTarget(EntityInterface $entity) : GeneratedUrl;

}

Interfaces

Title Deprecated Summary
EntityLinkTargetInterface Provides an interface for generating a link target from an entity.

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