class TypeLinkManager in Drupal 9

Hierarchy

• class \Drupal\hal\LinkManager\LinkManagerBase
  • class \Drupal\hal\LinkManager\TypeLinkManager implements TypeLinkManagerInterface

1 string reference to 'TypeLinkManager'

hal.services.yml in core/modules/hal/hal.services.yml

core/modules/hal/hal.services.yml

1 service uses TypeLinkManager

hal.link_manager.type in core/modules/hal/hal.services.yml

Drupal\hal\LinkManager\TypeLinkManager

File

core/modules/hal/src/LinkManager/TypeLinkManager.php, line 14

Namespace

Drupal\hal\LinkManager

class TypeLinkManager extends LinkManagerBase implements TypeLinkManagerInterface {

  /**
   * Injected cache backend.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cache;

  /**
   * Module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $bundleInfoService;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The injected cache backend for caching type URIs.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundle_info_service
   *   The bundle info service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(CacheBackendInterface $cache, ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory, RequestStack $request_stack, EntityTypeBundleInfoInterface $bundle_info_service, EntityTypeManagerInterface $entity_type_manager) {
    $this->cache = $cache;
    $this->configFactory = $config_factory;
    $this->moduleHandler = $module_handler;
    $this->requestStack = $request_stack;
    $this->bundleInfoService = $bundle_info_service;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function getTypeUri($entity_type, $bundle, $context = []) {

    // Per the interface documentation of this method, the returned URI may
    // optionally also serve as the URL of a documentation page about this
    // bundle. However, Drupal does not currently implement such a documentation
    // page. Therefore, we return a URI assembled relative to the site's base
    // URL, which is sufficient to uniquely identify the site's entity type and
    // bundle for use in hypermedia formats, but we do not take into account
    // unclean URLs, language prefixing, or anything else that would be required
    // for Drupal to be able to respond with content at this URL. If a module is
    // installed that adds such content, but requires this URL to be different
    // (e.g., include a language prefix), then the module must also override the
    // TypeLinkManager class/service to return the desired URL.
    $uri = $this
      ->getLinkDomain($context) . "/rest/type/{$entity_type}/{$bundle}";
    $this->moduleHandler
      ->alter('hal_type_uri', $uri, $context);
    return $uri;
  }

  /**
   * {@inheritdoc}
   */
  public function getTypeInternalIds($type_uri, $context = []) {
    $types = $this
      ->getTypes($context);
    if (isset($types[$type_uri])) {
      return $types[$type_uri];
    }
    return FALSE;
  }

  /**
   * Get the array of type links.
   *
   * @param array $context
   *   Context from the normalizer/serializer operation.
   *
   * @return array
   *   An array of typed data ids (entity_type and bundle) keyed by
   *   corresponding type URI.
   */
  protected function getTypes($context = []) {
    $cid = 'hal:links:types';
    $cache = $this->cache
      ->get($cid);
    if (!$cache) {
      $data = $this
        ->writeCache($context);
    }
    else {
      $data = $cache->data;
    }
    return $data;
  }

  /**
   * Writes the cache of type links.
   *
   * @param array $context
   *   Context from the normalizer/serializer operation.
   *
   * @return array
   *   An array of typed data ids (entity_type and bundle) keyed by
   *   corresponding type URI.
   */
  protected function writeCache($context = []) {
    $data = [];

    // Type URIs correspond to bundles. Iterate through the bundles to get the
    // URI and data for them.
    $entity_types = $this->entityTypeManager
      ->getDefinitions();
    foreach ($this->bundleInfoService
      ->getAllBundleInfo() as $entity_type_id => $bundles) {

      // Only content entities are supported currently.
      // @todo Consider supporting config entities.
      if ($entity_types[$entity_type_id]
        ->entityClassImplements(ConfigEntityInterface::class)) {
        continue;
      }
      foreach ($bundles as $bundle => $bundle_info) {

        // Get a type URI for the bundle.
        $bundle_uri = $this
          ->getTypeUri($entity_type_id, $bundle, $context);
        $data[$bundle_uri] = [
          'entity_type' => $entity_type_id,
          'bundle' => $bundle,
        ];
      }
    }

    // These URIs only change when entity info changes, so cache it permanently
    // and only clear it when entity_info is cleared.
    $this->cache
      ->set('hal:links:types', $data, Cache::PERMANENT, [
      'entity_types',
    ]);
    return $data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LinkManagerBase::$configFactory	protected	property	Config factory service.
LinkManagerBase::$linkDomain	protected	property	Link domain used for type links URIs.
LinkManagerBase::$requestStack	protected	property	The request stack.
LinkManagerBase::getLinkDomain	protected	function	Gets the link domain.
LinkManagerBase::setLinkDomain	public	function
TypeLinkManager::$bundleInfoService	protected	property	The bundle info service.
TypeLinkManager::$cache	protected	property	Injected cache backend.
TypeLinkManager::$entityTypeManager	protected	property	The entity type manager.
TypeLinkManager::$moduleHandler	protected	property	Module handler service.
TypeLinkManager::getTypeInternalIds	public	function	Get a bundle's Typed Data IDs based on a URI. Overrides TypeLinkManagerInterface::getTypeInternalIds
TypeLinkManager::getTypes	protected	function	Get the array of type links.
TypeLinkManager::getTypeUri	public	function	Gets the URI that corresponds to a bundle. Overrides TypeLinkManagerInterface::getTypeUri
TypeLinkManager::writeCache	protected	function	Writes the cache of type links.
TypeLinkManager::__construct	public	function	Constructor.