class AuthorArticles in JSON:API Resources 8

Processes a request for a collection containing a user's article nodes.

@internal

Hierarchy

• class \Drupal\jsonapi_resources\Resource\ResourceBase
  • class \Drupal\jsonapi_resources\Resource\EntityResourceBase implements ResourceObjectToEntityMapperAwareInterface uses EntityCreationTrait
    • class \Drupal\jsonapi_resources\Resource\EntityQueryResourceBase
      • class \Drupal\jsonapi_resources_test\Resource\AuthorArticles

1 string reference to 'AuthorArticles'

jsonapi_resources_test.routing.yml in tests/modules/jsonapi_resources_test/jsonapi_resources_test.routing.yml

tests/modules/jsonapi_resources_test/jsonapi_resources_test.routing.yml

File

tests/modules/jsonapi_resources_test/src/Resource/AuthorArticles.php, line 17

Namespace

Drupal\jsonapi_resources_test\Resource

class AuthorArticles extends EntityQueryResourceBase {

  /**
   * Process the resource request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   * @param \Drupal\user\UserInterface $user
   *   The user.
   *
   * @return \Drupal\jsonapi\ResourceResponse
   *   The response.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function process(Request $request, UserInterface $user) : ResourceResponse {

    // Force the author to be included.
    $include = $request->query
      ->get('include');
    $request->query
      ->set('include', $include . (empty($include) ? '' : ',') . 'uid');
    $cacheability = new CacheableMetadata();
    $entity_type = $this->entityTypeManager
      ->getDefinition('node');
    $entity_query = $this
      ->getEntityQuery('node')
      ->condition($entity_type
      ->getKey('bundle'), 'article')
      ->condition($entity_type
      ->getKey('status'), NodeInterface::PUBLISHED)
      ->condition($entity_type
      ->getKey('uid'), $user
      ->id());
    $cacheability
      ->addCacheContexts([
      'url.path',
    ]);
    $paginator = $this
      ->getPaginatorForRequest($request);
    $paginator
      ->applyToQuery($entity_query, $cacheability);
    $data = $this
      ->loadResourceObjectDataFromEntityQuery($entity_query, $cacheability);
    $pagination_links = $paginator
      ->getPaginationLinks($entity_query, $cacheability, TRUE);
    $response = $this
      ->createJsonapiResponse($data, $request, 200, [], $pagination_links);
    $response
      ->addCacheableDependency($cacheability);
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AuthorArticles::process	public	function	Process the resource request.
EntityCreationTrait::modifyCreatedEntity	protected	function	Modifies the created entity before it is saved.	2
EntityCreationTrait::processEntityCreation	protected	function	Process the resource request.
EntityQueryResourceBase::$entityQueryExecutor	private	property	The entity query executor utility.
EntityQueryResourceBase::getEntityQuery	protected	function	Gets an entity query for the given entity type.
EntityQueryResourceBase::getPaginatorForRequest	protected	function	Gets an entity query paginator for the current request.
EntityQueryResourceBase::loadResourceObjectDataFromEntityQuery	protected	function	Finds entity resource object using an entity query.
EntityQueryResourceBase::loadResourceObjectsByEntityIds	private	function	Loads and access checks entities loaded by ID as JSON:API resource objects.
EntityQueryResourceBase::setCacheabilityCapturingExecutor	public	function	Sets the cacheability capturing entity query executor.
EntityResourceBase::$entityAccessChecker	private	property	The JSON:API entity access checker.
EntityResourceBase::$entityTypeManager	protected	property	The entity type manager.
EntityResourceBase::createCollectionDataFromEntities	protected	function	Creates a JSON:API resource object from the given entity.
EntityResourceBase::createIndividualDataFromEntity	protected	function	Creates a JSON:API resource object from the given entity.
EntityResourceBase::getResourceTypesByEntityTypeId	protected	function	Get all resource types that represent variants of the given entity type ID.
EntityResourceBase::setEntityAccessChecker	public	function	Sets the entity access checker.
EntityResourceBase::setEntityTypeManager	public	function	Sets the entity type manager.
EntityValidationTrait::validate	protected static	function	Verifies that an entity does not violate any validation constraints.
ResourceBase::$documentExtractor	private	property	The document extractor.
ResourceBase::$resourceResponseFactory	private	property	The resource response factory.
ResourceBase::$resourceTypeRepository	protected	property	The resource type repository.
ResourceBase::createJsonapiResponse	protected	function	Builds a response with the appropriate wrapped document.
ResourceBase::getDocumentFromRequest	protected	function	Get the document from the request.
ResourceBase::getRouteResourceTypes	public	function		2
ResourceBase::setDocumentExtractor	public	function	Sets the document extractor.
ResourceBase::setResourceResponseFactory	public	function	Sets the resource response factory.
ResourceBase::setResourceTypeRepository	public	function	Sets the resource type repository.
ResourceObjectToEntityMapperAwareTrait::$resourceObjectToEntityMapper	private	property	The service which created an entity from a resource object.
ResourceObjectToEntityMapperAwareTrait::setResourceObjectToEntityMapper	public	function