interface LinkItemInterface

Same name and namespace in other branches
  1. 11.x core/modules/link/src/LinkItemInterface.php \Drupal\link\LinkItemInterface
  2. 10 core/modules/link/src/LinkItemInterface.php \Drupal\link\LinkItemInterface
  3. 9 core/modules/link/src/LinkItemInterface.php \Drupal\link\LinkItemInterface
  4. 8.9.x core/modules/link/src/LinkItemInterface.php \Drupal\link\LinkItemInterface

Defines an interface for the link field item.

Hierarchy

Expanded class hierarchy of LinkItemInterface

All classes that implement LinkItemInterface

27 files declare their use of LinkItemInterface
DefaultContentSubscriber.php in core/modules/link/src/EventSubscriber/DefaultContentSubscriber.php
LinkAccessConstraintValidator.php in core/modules/link/src/Plugin/Validation/Constraint/LinkAccessConstraintValidator.php
LinkAccessConstraintValidatorTest.php in core/modules/link/tests/src/Unit/Plugin/Validation/Constraint/LinkAccessConstraintValidatorTest.php
LinkExternalProtocolsConstraintValidator.php in core/modules/link/src/Plugin/Validation/Constraint/LinkExternalProtocolsConstraintValidator.php
LinkExternalProtocolsConstraintValidatorTest.php in core/modules/link/tests/src/Unit/Plugin/Validation/Constraint/LinkExternalProtocolsConstraintValidatorTest.php

... See full list

File

core/modules/link/src/LinkItemInterface.php, line 10

Namespace

Drupal\link
View source
interface LinkItemInterface extends FieldItemInterface {
  
  /**
   * Specifies whether the field supports only internal URLs.
   */
  const LINK_INTERNAL = 0x1;
  
  /**
   * Specifies whether the field supports only external URLs.
   */
  const LINK_EXTERNAL = 0x10;
  
  /**
   * Specifies whether the field supports both internal and external URLs.
   */
  const LINK_GENERIC = 0x11;
  
  /**
   * Determines if a link is external.
   *
   * @return bool
   *   TRUE if the link is external, FALSE otherwise.
   */
  public function isExternal();
  
  /**
   * Gets the URL object.
   *
   * @return \Drupal\Core\Url
   *   Returns a Url object.
   *
   * @throws \InvalidArgumentException
   *   Thrown when there is a problem with field data.
   */
  public function getUrl();
  
  /**
   * Gets the link title.
   *
   * @return string|null
   *   Returns the link title.
   */
  public function getTitle() : ?string;

}

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