class AbstractUriElement
Any HTML element that can link to an URI.
@author Fabien Potencier <fabien@symfony.com>
Hierarchy
- class \Symfony\Component\DomCrawler\AbstractUriElement
Expanded class hierarchy of AbstractUriElement
File
-
vendor/
symfony/ dom-crawler/ AbstractUriElement.php, line 19
Namespace
Symfony\Component\DomCrawlerView source
abstract class AbstractUriElement {
protected \DOMElement $node;
protected ?string $method;
/**
* @param \DOMElement $node A \DOMElement instance
* @param string|null $currentUri The URI of the page where the link is embedded (or the base href)
* @param string|null $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, ?string $currentUri = null, ?string $method = 'GET') {
$this->setNode($node);
$this->method = $method ? strtoupper($method) : null;
$elementUriIsRelative = !parse_url(trim($this->getRawUri()), \PHP_URL_SCHEME);
$baseUriIsAbsolute = null !== $this->currentUri && \in_array(strtolower(substr($this->currentUri, 0, 4)), [
'http',
'file',
]);
if ($elementUriIsRelative && !$baseUriIsAbsolute) {
throw new \InvalidArgumentException(\sprintf('The URL of the element is relative, so you must define its base URI passing an absolute URL to the constructor of the "%s" class ("%s" was passed).', __CLASS__, $this->currentUri));
}
}
/**
* Gets the node associated with this link.
*/
public function getNode() : \DOMElement {
return $this->node;
}
/**
* Gets the method associated with this link.
*/
public function getMethod() : string {
return $this->method ?? 'GET';
}
/**
* Gets the URI associated with this link.
*/
public function getUri() : string {
return UriResolver::resolve($this->getRawUri(), $this->currentUri);
}
/**
* Returns raw URI data.
*/
protected abstract function getRawUri() : string;
/**
* Returns the canonicalized URI path (see RFC 3986, section 5.2.4).
*
* @param string $path URI path
*/
protected function canonicalizePath(string $path) : string {
if ('' === $path || '/' === $path) {
return $path;
}
if (str_ends_with($path, '.')) {
$path .= '/';
}
$output = [];
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 abstract function setNode(\DOMElement $node) : void;
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
AbstractUriElement::$method | protected | property | ||
AbstractUriElement::$node | protected | property | ||
AbstractUriElement::canonicalizePath | protected | function | Returns the canonicalized URI path (see RFC 3986, section 5.2.4). | |
AbstractUriElement::getMethod | public | function | Gets the method associated with this link. | 1 |
AbstractUriElement::getNode | public | function | Gets the node associated with this link. | |
AbstractUriElement::getRawUri | abstract protected | function | Returns raw URI data. | 2 |
AbstractUriElement::getUri | public | function | Gets the URI associated with this link. | 1 |
AbstractUriElement::setNode | abstract protected | function | Sets current \DOMElement instance. | 2 |
AbstractUriElement::__construct | public | function | 2 |