class EntryPoint

Same name in other branches
  1. 8.9.x core/modules/jsonapi/src/Controller/EntryPoint.php \Drupal\jsonapi\Controller\EntryPoint
  2. 10 core/modules/jsonapi/src/Controller/EntryPoint.php \Drupal\jsonapi\Controller\EntryPoint
  3. 11.x core/modules/jsonapi/src/Controller/EntryPoint.php \Drupal\jsonapi\Controller\EntryPoint

Controller for the API entry point.

@internal JSON:API maintains no PHP API. The API is the HTTP API. This class may change at any time and could break any dependencies on it.

Hierarchy

Expanded class hierarchy of EntryPoint

See also

https://www.drupal.org/project/drupal/issues/3032787

jsonapi.api.php

1 file declares its use of EntryPoint
Routes.php in core/modules/jsonapi/src/Routing/Routes.php

File

core/modules/jsonapi/src/Controller/EntryPoint.php, line 29

Namespace

Drupal\jsonapi\Controller
View source
class EntryPoint extends ControllerBase {
    
    /**
     * The JSON:API resource type repository.
     *
     * @var \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface
     */
    protected $resourceTypeRepository;
    
    /**
     * The account object.
     *
     * @var \Drupal\Core\Session\AccountInterface
     */
    protected $user;
    
    /**
     * EntryPoint constructor.
     *
     * @param \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface $resource_type_repository
     *   The resource type repository.
     * @param \Drupal\Core\Session\AccountInterface $user
     *   The current user.
     */
    public function __construct(ResourceTypeRepositoryInterface $resource_type_repository, AccountInterface $user) {
        $this->resourceTypeRepository = $resource_type_repository;
        $this->user = $user;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('jsonapi.resource_type.repository'), $container->get('current_user'));
    }
    
    /**
     * Controller to list all the resources.
     *
     * @return \Drupal\jsonapi\ResourceResponse
     *   The response object.
     */
    public function index() {
        $cacheability = (new CacheableMetadata())->addCacheContexts([
            'user.roles:authenticated',
        ])
            ->addCacheTags([
            'jsonapi_resource_types',
        ]);
        // Only build URLs for exposed resources.
        $resources = array_filter($this->resourceTypeRepository
            ->all(), function ($resource) {
            return !$resource->isInternal();
        });
        $self_link = new Link(new CacheableMetadata(), Url::fromRoute('jsonapi.resource_list'), 'self');
        $urls = array_reduce($resources, function (LinkCollection $carry, ResourceType $resource_type) {
            if ($resource_type->isLocatable() || $resource_type->isMutable()) {
                $route_suffix = $resource_type->isLocatable() ? 'collection' : 'collection.post';
                $url = Url::fromRoute(sprintf('jsonapi.%s.%s', $resource_type->getTypeName(), $route_suffix))
                    ->setAbsolute();
                // Using a resource type name in place of a link relation type is not
                // technically valid. However, since it matches the link key, it will
                // not actually be serialized since the rel is omitted if it matches the
                // link key; because of that no client can rely on it. Once an extension
                // relation type is implemented for links to a collection, that should
                // be used instead. Unfortunately, the `collection` link relation type
                // would not be semantically correct since it would imply that the
                // entrypoint is a *member* of the link target.
                // @todo: implement an extension relation type to signal that this is a primary collection resource.
                $link_relation_type = $resource_type->getTypeName();
                return $carry->withLink($resource_type->getTypeName(), new Link(new CacheableMetadata(), $url, $link_relation_type));
            }
            return $carry;
        }, new LinkCollection([
            'self' => $self_link,
        ]));
        $meta = [];
        if ($this->user
            ->isAuthenticated()) {
            $current_user_uuid = $this->entityTypeManager()
                ->getStorage('user')
                ->load($this->user
                ->id())
                ->uuid();
            $meta['links']['me'] = [
                'meta' => [
                    'id' => $current_user_uuid,
                ],
            ];
            $cacheability->addCacheContexts([
                'user',
            ]);
            try {
                $me_url = Url::fromRoute('jsonapi.user--user.individual', [
                    'entity' => $current_user_uuid,
                ])->setAbsolute()
                    ->toString(TRUE);
                $meta['links']['me']['href'] = $me_url->getGeneratedUrl();
                // The cacheability of the `me` URL is the cacheability of that URL
                // itself and the currently authenticated user.
                $cacheability = $cacheability->merge($me_url);
            } catch (RouteNotFoundException $e) {
                // Do not add the link if the route is disabled or marked as internal.
            }
        }
        $response = new CacheableResourceResponse(new JsonApiDocumentTopLevel(new ResourceObjectData([]), new NullIncludedData(), $urls, $meta));
        return $response->addCacheableDependency($cacheability);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 3
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 3
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
EntryPoint::$resourceTypeRepository protected property The JSON:API resource type repository.
EntryPoint::$user protected property The account object.
EntryPoint::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
EntryPoint::index public function Controller to list all the resources.
EntryPoint::__construct public function EntryPoint constructor.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.