api-platform / core

src/Bridge/Symfony/Bundle/DataCollector/RequestDataCollector.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Bridge\Symfony\Bundle\DataCollector;

use ApiPlatform\Core\Bridge\Symfony\Bundle\DataPersister\TraceableChainDataPersister;
use ApiPlatform\Core\Bridge\Symfony\Bundle\DataProvider\TraceableChainCollectionDataProvider;
use ApiPlatform\Core\Bridge\Symfony\Bundle\DataProvider\TraceableChainItemDataProvider;
use ApiPlatform\Core\Bridge\Symfony\Bundle\DataProvider\TraceableChainSubresourceDataProvider;
use ApiPlatform\Core\DataPersister\DataPersisterInterface;
use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Util\RequestAttributesExtractor;
use Psr\Container\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\DataCollector\DataCollector;

/**
 * @author Julien DENIAU <julien.deniau@gmail.com>
 * @author Anthony GRASSIOT <antograssiot@free.fr>
 */
final class RequestDataCollector extends DataCollector
{
    private $metadataFactory;
    private $filterLocator;
    private $collectionDataProvider;
    private $itemDataProvider;
    private $subresourceDataProvider;
    private $dataPersister;

    public function __construct(ResourceMetadataFactoryInterface $metadataFactory, ContainerInterface $filterLocator, CollectionDataProviderInterface $collectionDataProvider = null, ItemDataProviderInterface $itemDataProvider = null, SubresourceDataProviderInterface $subresourceDataProvider = null, DataPersisterInterface $dataPersister = null)
    {
        $this->metadataFactory = $metadataFactory;
        $this->filterLocator = $filterLocator;
        $this->collectionDataProvider = $collectionDataProvider;
        $this->itemDataProvider = $itemDataProvider;
        $this->subresourceDataProvider = $subresourceDataProvider;
        $this->dataPersister = $dataPersister;
    }

    /**
     * {@inheritdoc}
     */
    public function collect(Request $request, Response $response, \Exception $exception = null)
    {
        $counters = ['ignored_filters' => 0];
        $resourceClass = $request->attributes->get('_api_resource_class');
        $resourceMetadata = $resourceClass ? $this->metadataFactory->create($resourceClass) : null;

        $filters = [];
        foreach ($resourceMetadata ? $resourceMetadata->getAttribute('filters', []) : [] as $id) {
            if ($this->filterLocator->has($id)) {
                $filters[$id] = \get_class($this->filterLocator->get($id));
                continue;
            }

            $filters[$id] = null;
            ++$counters['ignored_filters'];
        }

        $this->data = [
            'resource_class' => $resourceClass,
            'resource_metadata' => $resourceMetadata ? $this->cloneVar($resourceMetadata) : null,
            'acceptable_content_types' => $request->getAcceptableContentTypes(),
            'request_attributes' => RequestAttributesExtractor::extractAttributes($request),
            'filters' => $filters,
            'counters' => $counters,
            'dataProviders' => [],
            'dataPersisters' => ['responses' => []],
        ];

        if ($this->collectionDataProvider instanceof TraceableChainCollectionDataProvider) {
            $this->data['dataProviders']['collection'] = [
                'context' => $this->cloneVar($this->collectionDataProvider->getContext()),
                'responses' => $this->collectionDataProvider->getProvidersResponse(),
            ];
        }

        if ($this->itemDataProvider instanceof TraceableChainItemDataProvider) {
            $this->data['dataProviders']['item'] = [
                'context' => $this->cloneVar($this->itemDataProvider->getContext()),
                'responses' => $this->itemDataProvider->getProvidersResponse(),
            ];
        }

        if ($this->subresourceDataProvider instanceof TraceableChainSubresourceDataProvider) {
            $this->data['dataProviders']['subresource'] = [
                'context' => $this->cloneVar($this->subresourceDataProvider->getContext()),
                'responses' => $this->subresourceDataProvider->getProvidersResponse(),
            ];
        }

        if ($this->dataPersister instanceof TraceableChainDataPersister) {
            $this->data['dataPersisters']['responses'] = $this->dataPersister->getPersistersResponse();
        }
    }

    public function getAcceptableContentTypes(): array
    {
        return $this->data['acceptable_content_types'] ?? [];

The expression return $this->data['acceptable_content_types'] ?? array() could return the type Symfony\Component\VarDumper\Cloner\Data which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    public function getResourceClass()
    {
        return $this->data['resource_class'] ?? null;
    }

    public function getResourceMetadata()
    {
        return $this->data['resource_metadata'] ?? null;
    }

    public function getRequestAttributes(): array
    {
        return $this->data['request_attributes'] ?? [];

The expression return $this->data['request_attributes'] ?? array() could return the type Symfony\Component\VarDumper\Cloner\Data which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    public function getFilters(): array
    {
        return $this->data['filters'] ?? [];

The expression return $this->data['filters'] ?? array() could return the type Symfony\Component\VarDumper\Cloner\Data which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    public function getCounters(): array
    {
        return $this->data['counters'] ?? [];

The expression return $this->data['counters'] ?? array() could return the type Symfony\Component\VarDumper\Cloner\Data which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    public function getCollectionDataProviders(): array
    {
        return $this->data['dataProviders']['collection'] ?? ['context' => [], 'responses' => []];

The expression return $this->data['dataProviders']['collection'] ?? array('context' => array(), 'responses' => array()) could return the type Symfony\Component\VarDumper\Cloner\Data which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    public function getItemDataProviders(): array
    {
        return $this->data['dataProviders']['item'] ?? ['context' => [], 'responses' => []];

The expression return $this->data['dataProviders']['item'] ?? array('context' => array(), 'responses' => array()) could return the type Symfony\Component\VarDumper\Cloner\Data which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    public function getSubresourceDataProviders(): array
    {
        return $this->data['dataProviders']['subresource'] ?? ['context' => [], 'responses' => []];

The expression return $this->data['dataProviders']['subresource'] ?? array('context' => array(), 'responses' => array()) could return the type Symfony\Component\VarDumper\Cloner\Data which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    public function getDataPersisters(): array
    {
        return $this->data['dataPersisters'] ?? ['responses' => []];

The expression return $this->data['dataPersisters'] ?? array('responses' => array()) could return the type Symfony\Component\VarDumper\Cloner\Data which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * {@inheritdoc}
     */
    public function getName(): string
    {
        return 'api_platform.data_collector.request';
    }

    /**
     * {@inheritdoc}
     */
    public function reset()
    {
        $this->data = [];
    }
}