final class PaginatorMetadata in JSON:API Resources 8

Contains metadata about pagination in an entity query.

Hierarchy

• class \Drupal\jsonapi_resources\Entity\Query\PaginatorMetadata

2 files declare their use of PaginatorMetadata

CacheabilityCapturingExecutor.php in src/Unstable/Entity/Query/CacheabilityCapturingExecutor.php

OffsetLimitPaginator.php in src/Unstable/Entity/Query/Pagination/OffsetLimitPaginator.php

File

src/Entity/Query/PaginatorMetadata.php, line 8

Namespace

Drupal\jsonapi_resources\Entity\Query

final class PaginatorMetadata {
  const KEY = 'jsonapi_resource_paginator_metadata';

  /**
   * Whether there should be a `next` page link.
   *
   * @var bool
   */
  public $hasNextPage;

  /**
   * The maximum number of results that may be returned in the response.
   *
   * @var int
   */
  public $pageSizeMax;

  /**
   * A property storing the current location of the paginator.
   *
   * For an offset-limit based paginator, this would be the offset. For a
   * cursor-based paginator, this might be an opaque string.
   *
   * @var mixed
   */
  public $pageLocation;

}

Members

Name	Modifiers	Type	Description	Overrides
PaginatorMetadata::$hasNextPage	public	property	Whether there should be a `next` page link.
PaginatorMetadata::$pageLocation	public	property	A property storing the current location of the paginator.
PaginatorMetadata::$pageSizeMax	public	property	The maximum number of results that may be returned in the response.
PaginatorMetadata::KEY		constant