class Link
Same name in this branch
- 9 core/lib/Drupal/Core/Render/Element/Link.php \Drupal\Core\Render\Element\Link
- 9 core/lib/Drupal/Core/Link.php \Drupal\Core\Link
Same name in other branches
- 8.9.x core/modules/jsonapi/src/JsonApiResource/Link.php \Drupal\jsonapi\JsonApiResource\Link
- 8.9.x core/lib/Drupal/Core/Render/Element/Link.php \Drupal\Core\Render\Element\Link
- 8.9.x core/lib/Drupal/Core/Link.php \Drupal\Core\Link
- 10 core/modules/jsonapi/src/JsonApiResource/Link.php \Drupal\jsonapi\JsonApiResource\Link
- 10 core/lib/Drupal/Core/Render/Element/Link.php \Drupal\Core\Render\Element\Link
- 10 core/lib/Drupal/Core/Link.php \Drupal\Core\Link
- 11.x core/modules/jsonapi/src/JsonApiResource/Link.php \Drupal\jsonapi\JsonApiResource\Link
- 11.x core/lib/Drupal/Core/Render/Element/Link.php \Drupal\Core\Render\Element\Link
- 11.x core/lib/Drupal/Core/Link.php \Drupal\Core\Link
Represents an RFC8288 based link.
@internal JSON:API maintains no PHP API. The API is the HTTP API. This class may change at any time and could break any dependencies on it.
Hierarchy
- class \Drupal\jsonapi\JsonApiResource\Link implements \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\Cache\CacheableDependencyTrait
Expanded class hierarchy of Link
See also
https://www.drupal.org/project/drupal/issues/3032787
https://tools.ietf.org/html/rfc8288
7 files declare their use of Link
- EntityResource.php in core/
modules/ jsonapi/ src/ Controller/ EntityResource.php - EntryPoint.php in core/
modules/ jsonapi/ src/ Controller/ EntryPoint.php - FileUpload.php in core/
modules/ jsonapi/ src/ Controller/ FileUpload.php - LinkCollectionNormalizer.php in core/
modules/ jsonapi/ src/ Normalizer/ LinkCollectionNormalizer.php - LinkCollectionNormalizerTest.php in core/
modules/ jsonapi/ tests/ src/ Kernel/ Normalizer/ LinkCollectionNormalizerTest.php
165 string references to 'Link'
- AnnotatedClassDiscoveryTest::provideBadAnnotations in core/
tests/ Drupal/ Tests/ Component/ Plugin/ Discovery/ AnnotatedClassDiscoveryTest.php - All the Drupal documentation standards tags.
- ckeditor5.ckeditor5.yml in core/
modules/ ckeditor5/ ckeditor5.ckeditor5.yml - core/modules/ckeditor5/ckeditor5.ckeditor5.yml
- CKEditor5DialogTest::testCKEditor5FocusInTooltipsInDialog in core/
modules/ ckeditor5/ tests/ src/ FunctionalJavascript/ CKEditor5DialogTest.php - Tests if CKEditor 5 tooltips can be interacted with in dialogs.
- CKEditor5UpdateAlignmentTest::testUpdateAlignmentButtons in core/
modules/ ckeditor5/ tests/ src/ Functional/ Update/ CKEditor5UpdateAlignmentTest.php - Tests update of individual button that are alignment configuration.
- CKEditorPluginManagerTest::providerGetEnabledButtons in core/
modules/ ckeditor/ tests/ src/ Unit/ CKEditorPluginManagerTest.php - Provides a list of configs to test.
File
-
core/
modules/ jsonapi/ src/ JsonApiResource/ Link.php, line 23
Namespace
Drupal\jsonapi\JsonApiResourceView source
final class Link implements CacheableDependencyInterface {
use CacheableDependencyTrait;
/**
* The link URI.
*
* @var \Drupal\Core\Url
*/
protected $uri;
/**
* The URI, as a string.
*
* @var string
*/
protected $href;
/**
* The link relation types.
*
* @var string[]
*
* @todo: change this type documentation to be a single string in
* https://www.drupal.org/project/drupal/issues/3080467.
*/
protected $rel;
/**
* The link target attributes.
*
* @var string[]
* An associative array where the keys are the attribute keys and values are
* either string or an array of strings.
*/
protected $attributes;
/**
* JSON:API Link constructor.
*
* @param \Drupal\Core\Cache\CacheableMetadata $cacheability
* Any cacheability metadata associated with the link. For example, a
* 'call-to-action' link might reference a registration resource if an event
* has vacancies or a wait-list resource otherwise. Therefore, the link's
* cacheability might be depend on a certain entity's values other than the
* entity on which the link will appear.
* @param \Drupal\Core\Url $url
* The Url object for the link.
* @param string $link_relation_type
* An array of registered or extension RFC8288 link relation types.
* @param array $target_attributes
* An associative array of target attributes for the link.
*
* @see https://tools.ietf.org/html/rfc8288#section-2.1
*/
public function __construct(CacheableMetadata $cacheability, Url $url, string $link_relation_type, array $target_attributes = []) {
assert(Inspector::assertAllStrings(array_keys($target_attributes)));
assert(Inspector::assertAll(function ($target_attribute_value) {
return is_string($target_attribute_value) || is_array($target_attribute_value);
}, array_values($target_attributes)));
$generated_url = $url->setAbsolute()
->toString(TRUE);
$this->href = $generated_url->getGeneratedUrl();
$this->uri = $url;
$this->rel = $link_relation_type;
$this->attributes = $target_attributes;
$this->setCacheability($cacheability->addCacheableDependency($generated_url));
}
/**
* Gets the link's URI.
*
* @return \Drupal\Core\Url
* The link's URI as a Url object.
*/
public function getUri() {
return $this->uri;
}
/**
* Gets the link's URI as a string.
*
* @return string
* The link's URI as a string.
*/
public function getHref() {
return $this->href;
}
/**
* Gets the link's relation type.
*
* @return string
* The link's relation type.
*/
public function getLinkRelationType() {
return $this->rel;
}
/**
* Gets the link's target attributes.
*
* @return string[]
* The link's target attributes.
*/
public function getTargetAttributes() {
return $this->attributes;
}
/**
* Compares two links.
*
* @param \Drupal\jsonapi\JsonApiResource\Link $a
* The first link.
* @param \Drupal\jsonapi\JsonApiResource\Link $b
* The second link.
*
* @return int
* 0 if the links can be considered identical, an integer greater than or
* less than 0 otherwise.
*/
public static function compare(Link $a, Link $b) {
// Any string concatenation would work, but a Link header-like format makes
// it clear what is being compared.
$a_string = sprintf('<%s>;rel="%s"', $a->getHref(), $a->rel);
$b_string = sprintf('<%s>;rel="%s"', $b->getHref(), $b->rel);
$cmp = strcmp($a_string, $b_string);
// If the `href` or `rel` of the links are not equivalent, it's not
// necessary to compare target attributes.
if ($cmp === 0) {
return (int) (!empty(DiffArray::diffAssocRecursive($a->getTargetAttributes(), $b->getTargetAttributes())));
}
return $cmp;
}
/**
* Merges two equivalent links into one link with the merged cacheability.
*
* The links must share the same URI, link relation type and attributes.
*
* @param \Drupal\jsonapi\JsonApiResource\Link $a
* The first link.
* @param \Drupal\jsonapi\JsonApiResource\Link $b
* The second link.
*
* @return static
* A new JSON:API Link object with the cacheability of both links merged.
*/
public static function merge(Link $a, Link $b) {
assert(static::compare($a, $b) === 0, 'Only equivalent links can be merged.');
$merged_cacheability = (new CacheableMetadata())->addCacheableDependency($a)
->addCacheableDependency($b);
return new static($merged_cacheability, $a->getUri(), $a->getLinkRelationType(), $a->getTargetAttributes());
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | |
CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | |
CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | |
CacheableDependencyTrait::getCacheContexts | public | function | 4 | |
CacheableDependencyTrait::getCacheMaxAge | public | function | 4 | |
CacheableDependencyTrait::getCacheTags | public | function | 4 | |
CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | |
Link::$attributes | protected | property | The link target attributes. | |
Link::$href | protected | property | The URI, as a string. | |
Link::$rel | protected | property | The link relation types. | |
Link::$uri | protected | property | The link URI. | |
Link::compare | public static | function | Compares two links. | |
Link::getHref | public | function | Gets the link's URI as a string. | |
Link::getLinkRelationType | public | function | Gets the link's relation type. | |
Link::getTargetAttributes | public | function | Gets the link's target attributes. | |
Link::getUri | public | function | Gets the link's URI. | |
Link::merge | public static | function | Merges two equivalent links into one link with the merged cacheability. | |
Link::__construct | public | function | JSON:API Link constructor. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.