class LinkManager in JSON:API 8

Class to generate links and queries for entities.

@todo Make this take cacheability into account in https://www.drupal.org/project/jsonapi/issues/2952714.

Hierarchy

• class \Drupal\jsonapi\LinkManager\LinkManager

15 files declare their use of LinkManager

ConfigEntityNormalizerTest.php in tests/src/Unit/Normalizer/ConfigEntityNormalizerTest.php

EntityNormalizer.php in src/Normalizer/EntityNormalizer.php

EntityNormalizerValueTest.php in tests/src/Unit/Normalizer/Value/EntityNormalizerValueTest.php

EntityReferenceFieldNormalizer.php in src/Normalizer/EntityReferenceFieldNormalizer.php

EntityReferenceFieldNormalizerTest.php in tests/src/Unit/Normalizer/EntityReferenceFieldNormalizerTest.php

... See full list

1 string reference to 'LinkManager'

jsonapi.services.yml in ./jsonapi.services.yml

jsonapi.services.yml

1 service uses LinkManager

jsonapi.link_manager in ./jsonapi.services.yml

Drupal\jsonapi\LinkManager\LinkManager

File

src/LinkManager/LinkManager.php, line 20

Namespace

Drupal\jsonapi\LinkManager

class LinkManager {

  /**
   * Used to generate a link to a jsonapi representation of an entity.
   *
   * @var \Drupal\Core\Render\MetadataBubblingUrlGenerator
   */
  protected $urlGenerator;

  /**
   * Instantiates a LinkManager object.
   *
   * @param \Symfony\Component\Routing\Matcher\RequestMatcherInterface|null $_router
   *   Unused. Kept for backwards compatibility.
   * @param \Drupal\Core\Routing\UrlGeneratorInterface $url_generator
   *   The Url generator.
   */
  public function __construct(RequestMatcherInterface $_router = NULL, UrlGeneratorInterface $url_generator) {
    $this->urlGenerator = $url_generator;
  }

  /**
   * Gets a link for the entity.
   *
   * @param int $entity_id
   *   The entity ID to generate the link for. Note: Depending on the
   *   configuration this might be the UUID as well.
   * @param \Drupal\jsonapi\ResourceType\ResourceType $resource_type
   *   The JSON API resource type.
   * @param array $route_parameters
   *   Parameters for the route generation.
   * @param string $key
   *   A key to build the route identifier.
   *
   * @return string|null
   *   The URL string, or NULL if the given entity is not locatable.
   */
  public function getEntityLink($entity_id, ResourceType $resource_type, array $route_parameters, $key) {
    if (!$resource_type
      ->isLocatable()) {
      return NULL;
    }
    $route_parameters += [
      $resource_type
        ->getEntityTypeId() => $entity_id,
    ];
    $route_key = sprintf('jsonapi.%s.%s', $resource_type
      ->getTypeName(), $key);
    return $this->urlGenerator
      ->generateFromRoute($route_key, $route_parameters, [
      'absolute' => TRUE,
    ], TRUE)
      ->getGeneratedUrl();
  }

  /**
   * Get the full URL for a given request object.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param array|null $query
   *   The query parameters to use. Leave it empty to get the query from the
   *   request object.
   *
   * @return string
   *   The full URL.
   */
  public function getRequestLink(Request $request, $query = NULL) {
    if ($query === NULL) {
      return $request
        ->getUri();
    }
    $uri_without_query_string = $request
      ->getSchemeAndHttpHost() . $request
      ->getBaseUrl() . $request
      ->getPathInfo();
    return Url::fromUri($uri_without_query_string)
      ->setOption('query', $query)
      ->toString();
  }

  /**
   * Get the pager links for a given request object.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param array $link_context
   *   An associative array with extra data to build the links.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
   *   When the offset and size are invalid.
   *
   * @return string[]
   *   An array of URLs, with:
   *   - a 'next' key if it is not the last page;
   *   - 'prev' and 'first' keys if it's not the first page.
   */
  public function getPagerLinks(Request $request, array $link_context = []) {
    if (!empty($link_context['total_count']) && !($total = (int) $link_context['total_count'])) {
      return [];
    }
    $params = $request
      ->get('_json_api_params');
    if ($page_param = $params[OffsetPage::KEY_NAME]) {

      /* @var \Drupal\jsonapi\Query\OffsetPage $page_param */
      $offset = $page_param
        ->getOffset();
      $size = $page_param
        ->getSize();
    }
    else {

      // Apply the defaults.
      $offset = OffsetPage::DEFAULT_OFFSET;
      $size = OffsetPage::SIZE_MAX;
    }
    if ($size <= 0) {
      throw new BadRequestHttpException(sprintf('The page size needs to be a positive integer.'));
    }
    $query = (array) $request->query
      ->getIterator();
    $links = [];

    // Check if this is not the last page.
    if ($link_context['has_next_page']) {
      $links['next'] = $this
        ->getRequestLink($request, $this
        ->getPagerQueries('next', $offset, $size, $query));
      if (!empty($total)) {
        $links['last'] = $this
          ->getRequestLink($request, $this
          ->getPagerQueries('last', $offset, $size, $query, $total));
      }
    }

    // Check if this is not the first page.
    if ($offset > 0) {
      $links['first'] = $this
        ->getRequestLink($request, $this
        ->getPagerQueries('first', $offset, $size, $query));
      $links['prev'] = $this
        ->getRequestLink($request, $this
        ->getPagerQueries('prev', $offset, $size, $query));
    }
    return $links;
  }

  /**
   * Get the query param array.
   *
   * @param string $link_id
   *   The name of the pagination link requested.
   * @param int $offset
   *   The starting index.
   * @param int $size
   *   The pagination page size.
   * @param array $query
   *   The query parameters.
   * @param int $total
   *   The total size of the collection.
   *
   * @return array
   *   The pagination query param array.
   */
  protected function getPagerQueries($link_id, $offset, $size, array $query = [], $total = 0) {
    $extra_query = [];
    switch ($link_id) {
      case 'next':
        $extra_query = [
          'page' => [
            'offset' => $offset + $size,
            'limit' => $size,
          ],
        ];
        break;
      case 'first':
        $extra_query = [
          'page' => [
            'offset' => 0,
            'limit' => $size,
          ],
        ];
        break;
      case 'last':
        if ($total) {
          $extra_query = [
            'page' => [
              'offset' => (ceil($total / $size) - 1) * $size,
              'limit' => $size,
            ],
          ];
        }
        break;
      case 'prev':
        $extra_query = [
          'page' => [
            'offset' => max($offset - $size, 0),
            'limit' => $size,
          ],
        ];
        break;
    }
    return array_merge($query, $extra_query);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LinkManager::$urlGenerator	protected	property	Used to generate a link to a jsonapi representation of an entity.
LinkManager::getEntityLink	public	function	Gets a link for the entity.
LinkManager::getPagerLinks	public	function	Get the pager links for a given request object.
LinkManager::getPagerQueries	protected	function	Get the query param array.
LinkManager::getRequestLink	public	function	Get the full URL for a given request object.
LinkManager::__construct	public	function	Instantiates a LinkManager object.