class Link in Zircon Profile 8

Link represents an HTML link (an HTML a, area or link tag).

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\DomCrawler\Link

2 files declare their use of Link

Client.php in vendor/symfony/browser-kit/Client.php

LinkTest.php in vendor/symfony/dom-crawler/Tests/LinkTest.php

11 string references to 'Link'

contextual.views.schema.yml in core/modules/contextual/config/schema/contextual.views.schema.yml

core/modules/contextual/config/schema/contextual.views.schema.yml

DrupalLink::getButtons in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalLink.php

Returns the buttons that this plugin provides, along with metadata.

FieldHelpTest::testFieldHelp in core/modules/field/src/Tests/FieldHelpTest.php

Test the Field module's help page.

HtmlResponseAttachmentsProcessor::processHtmlHeadLink in core/lib/Drupal/Core/Render/HtmlResponseAttachmentsProcessor.php

Transform a html_head_link array into html_head and http_header arrays.

link.info.yml in core/modules/link/link.info.yml

core/modules/link/link.info.yml

... See full list

File

vendor/symfony/dom-crawler/Link.php, line 19

Namespace

Symfony\Component\DomCrawler

class Link {

  /**
   * @var \DOMElement
   */
  protected $node;

  /**
   * @var string The method to use for the link
   */
  protected $method;

  /**
   * @var string The URI of the page where the link is embedded (or the base href)
   */
  protected $currentUri;

  /**
   * Constructor.
   *
   * @param \DOMElement $node       A \DOMElement instance
   * @param string      $currentUri The URI of the page where the link is embedded (or the base href)
   * @param string      $method     The method to use for the link (get by default)
   *
   * @throws \InvalidArgumentException if the node is not a link
   */
  public function __construct(\DOMElement $node, $currentUri, $method = 'GET') {
    if (!in_array(strtolower(substr($currentUri, 0, 4)), array(
      'http',
      'file',
    ))) {
      throw new \InvalidArgumentException(sprintf('Current URI must be an absolute URL ("%s").', $currentUri));
    }
    $this
      ->setNode($node);
    $this->method = $method ? strtoupper($method) : null;
    $this->currentUri = $currentUri;
  }

  /**
   * Gets the node associated with this link.
   *
   * @return \DOMElement A \DOMElement instance
   */
  public function getNode() {
    return $this->node;
  }

  /**
   * Gets the method associated with this link.
   *
   * @return string The method
   */
  public function getMethod() {
    return $this->method;
  }

  /**
   * Gets the URI associated with this link.
   *
   * @return string The URI
   */
  public function getUri() {
    $uri = trim($this
      ->getRawUri());

    // absolute URL?
    if (null !== parse_url($uri, PHP_URL_SCHEME)) {
      return $uri;
    }

    // empty URI
    if (!$uri) {
      return $this->currentUri;
    }

    // an anchor
    if ('#' === $uri[0]) {
      return $this
        ->cleanupAnchor($this->currentUri) . $uri;
    }
    $baseUri = $this
      ->cleanupUri($this->currentUri);
    if ('?' === $uri[0]) {
      return $baseUri . $uri;
    }

    // absolute URL with relative schema
    if (0 === strpos($uri, '//')) {
      return preg_replace('#^([^/]*)//.*$#', '$1', $baseUri) . $uri;
    }
    $baseUri = preg_replace('#^(.*?//[^/]*)(?:\\/.*)?$#', '$1', $baseUri);

    // absolute path
    if ('/' === $uri[0]) {
      return $baseUri . $uri;
    }

    // relative path
    $path = parse_url(substr($this->currentUri, strlen($baseUri)), PHP_URL_PATH);
    $path = $this
      ->canonicalizePath(substr($path, 0, strrpos($path, '/')) . '/' . $uri);
    return $baseUri . ('' === $path || '/' !== $path[0] ? '/' : '') . $path;
  }

  /**
   * Returns raw URI data.
   *
   * @return string
   */
  protected function getRawUri() {
    return $this->node
      ->getAttribute('href');
  }

  /**
   * Returns the canonicalized URI path (see RFC 3986, section 5.2.4).
   *
   * @param string $path URI path
   *
   * @return string
   */
  protected function canonicalizePath($path) {
    if ('' === $path || '/' === $path) {
      return $path;
    }
    if ('.' === substr($path, -1)) {
      $path .= '/';
    }
    $output = array();
    foreach (explode('/', $path) as $segment) {
      if ('..' === $segment) {
        array_pop($output);
      }
      elseif ('.' !== $segment) {
        $output[] = $segment;
      }
    }
    return implode('/', $output);
  }

  /**
   * Sets current \DOMElement instance.
   *
   * @param \DOMElement $node A \DOMElement instance
   *
   * @throws \LogicException If given node is not an anchor
   */
  protected function setNode(\DOMElement $node) {
    if ('a' !== $node->nodeName && 'area' !== $node->nodeName && 'link' !== $node->nodeName) {
      throw new \LogicException(sprintf('Unable to navigate from a "%s" tag.', $node->nodeName));
    }
    $this->node = $node;
  }

  /**
   * Removes the query string and the anchor from the given uri.
   *
   * @param string $uri The uri to clean
   *
   * @return string
   */
  private function cleanupUri($uri) {
    return $this
      ->cleanupQuery($this
      ->cleanupAnchor($uri));
  }

  /**
   * Remove the query string from the uri.
   *
   * @param string $uri
   *
   * @return string
   */
  private function cleanupQuery($uri) {
    if (false !== ($pos = strpos($uri, '?'))) {
      return substr($uri, 0, $pos);
    }
    return $uri;
  }

  /**
   * Remove the anchor from the uri.
   *
   * @param string $uri
   *
   * @return string
   */
  private function cleanupAnchor($uri) {
    if (false !== ($pos = strpos($uri, '#'))) {
      return substr($uri, 0, $pos);
    }
    return $uri;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Link::$currentUri	protected	property
Link::$method	protected	property
Link::$node	protected	property
Link::canonicalizePath	protected	function	Returns the canonicalized URI path (see RFC 3986, section 5.2.4).
Link::cleanupAnchor	private	function	Remove the anchor from the uri.
Link::cleanupQuery	private	function	Remove the query string from the uri.
Link::cleanupUri	private	function	Removes the query string and the anchor from the given uri.
Link::getMethod	public	function	Gets the method associated with this link.	1
Link::getNode	public	function	Gets the node associated with this link.
Link::getRawUri	protected	function	Returns raw URI data.	1
Link::getUri	public	function	Gets the URI associated with this link.	1
Link::setNode	protected	function	Sets current \DOMElement instance.	1
Link::__construct	public	function	Constructor.	1