3 namespace Drupal\hal\LinkManager;
5 use Drupal\Core\Cache\Cache;
6 use Drupal\Core\Cache\CacheBackendInterface;
7 use Drupal\Core\Config\ConfigFactoryInterface;
8 use Drupal\Core\Entity\ContentEntityTypeInterface;
9 use Drupal\Core\Entity\EntityManagerInterface;
10 use Drupal\Core\Extension\ModuleHandlerInterface;
11 use Symfony\Component\HttpFoundation\RequestStack;
13 class RelationLinkManager extends LinkManagerBase implements RelationLinkManagerInterface {
16 * @var \Drupal\Core\Cache\CacheBackendInterface;
23 * @var \Drupal\Core\Entity\EntityManagerInterface
25 protected $entityManager;
28 * Module handler service.
30 * @var \Drupal\Core\Extension\ModuleHandlerInterface
32 protected $moduleHandler;
37 * @param \Drupal\Core\Cache\CacheBackendInterface $cache
38 * The cache of relation URIs and their associated Typed Data IDs.
39 * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
41 * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
42 * The module handler service.
43 * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
44 * The config factory service.
45 * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
48 public function __construct(CacheBackendInterface $cache, EntityManagerInterface $entity_manager, ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory, RequestStack $request_stack) {
49 $this->cache = $cache;
50 $this->entityManager = $entity_manager;
51 $this->configFactory = $config_factory;
52 $this->moduleHandler = $module_handler;
53 $this->requestStack = $request_stack;
59 public function getRelationUri($entity_type, $bundle, $field_name, $context = []) {
60 // Per the interface documentation of this method, the returned URI may
61 // optionally also serve as the URL of a documentation page about this
62 // field. However, Drupal does not currently implement such a documentation
63 // page. Therefore, we return a URI assembled relative to the site's base
64 // URL, which is sufficient to uniquely identify the site's entity type +
65 // bundle + field for use in hypermedia formats, but we do not take into
66 // account unclean URLs, language prefixing, or anything else that would be
67 // required for Drupal to be able to respond with content at this URL. If a
68 // module is installed that adds such content, but requires this URL to be
69 // different (e.g., include a language prefix), then the module must also
70 // override the RelationLinkManager class/service to return the desired URL.
71 $uri = $this->getLinkDomain() . "/rest/relation/$entity_type/$bundle/$field_name";
72 $this->moduleHandler->alter('hal_relation_uri', $uri, $context);
73 // @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0. This
74 // hook is invoked to maintain backwards compatibility
75 $this->moduleHandler->alter('rest_relation_uri', $uri, $context);
82 public function getRelationInternalIds($relation_uri, $context = []) {
83 $relations = $this->getRelations($context);
84 if (isset($relations[$relation_uri])) {
85 return $relations[$relation_uri];
91 * Get the array of relation links.
93 * Any field can be handled as a relation simply by changing how it is
94 * normalized. Therefore, there is no prior knowledge that can be used here
95 * to determine which fields to assign relation URIs. Instead, each field,
96 * even primitives, are given a relation URI. It is up to the caller to
97 * determine which URIs to use.
99 * @param array $context
100 * Context from the normalizer/serializer operation.
103 * An array of typed data IDs keyed by corresponding relation URI. The keys
108 * - 'entity_type' (deprecated)
109 * The values for 'entity_type_id', 'bundle' and 'field_name' are strings.
110 * The 'entity_type' key exists for backwards compatibility and its value is
111 * the full entity type object. The 'entity_type' key will be removed before
114 * @see https://www.drupal.org/node/2877608
116 protected function getRelations($context = []) {
117 $cid = 'hal:links:relations';
118 $cache = $this->cache->get($cid);
120 $data = $this->writeCache($context);
123 $data = $cache->data;
126 // @todo https://www.drupal.org/node/2716163 Remove this in Drupal 9.0.
127 foreach ($data as $relation_uri => $ids) {
128 $data[$relation_uri]['entity_type'] = $this->entityManager->getDefinition($ids['entity_type_id']);
134 * Writes the cache of relation links.
136 * @param array $context
137 * Context from the normalizer/serializer operation.
140 * An array of typed data IDs keyed by corresponding relation URI. The keys
145 * The values for 'entity_type_id', 'bundle' and 'field_name' are strings.
147 protected function writeCache($context = []) {
150 foreach ($this->entityManager->getDefinitions() as $entity_type) {
151 if ($entity_type instanceof ContentEntityTypeInterface) {
152 foreach ($this->entityManager->getBundleInfo($entity_type->id()) as $bundle => $bundle_info) {
153 foreach ($this->entityManager->getFieldDefinitions($entity_type->id(), $bundle) as $field_definition) {
154 $relation_uri = $this->getRelationUri($entity_type->id(), $bundle, $field_definition->getName(), $context);
155 $data[$relation_uri] = [
156 'entity_type_id' => $entity_type->id(),
158 'field_name' => $field_definition->getName(),
164 // These URIs only change when field info changes, so cache it permanently
165 // and only clear it when the fields cache is cleared.
166 $this->cache->set('hal:links:relations', $data, Cache::PERMANENT, ['entity_field_info']);