api-platform / core

src/DataProvider/ChainSubresourceDataProvider.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\DataProvider;

use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;

/**
 * Tries each configured data provider and returns the result of the first able to handle the resource class.
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 */
final class ChainSubresourceDataProvider implements SubresourceDataProviderInterface
{
    /**
     * @var iterable<SubresourceDataProviderInterface>
     *
     * @internal
     */
    public $dataProviders;

    /**
     * @param SubresourceDataProviderInterface[] $dataProviders
     */
    public function __construct(iterable $dataProviders)
    {
        $this->dataProviders = $dataProviders;
    }

    /**
     * {@inheritdoc}
     */
    public function getSubresource(string $resourceClass, array $identifiers, array $context, string $operationName = null)
    {
        foreach ($this->dataProviders as $dataProvider) {
            try {
                if ($dataProvider instanceof RestrictedDataProviderInterface && !$dataProvider->supports($resourceClass, $operationName, $context)) {
                    continue;
                }

                return $dataProvider->getSubresource($resourceClass, $identifiers, $context, $operationName);
            } catch (ResourceClassNotSupportedException $e) {
                @trigger_error(sprintf('Throwing a "%s" in a data provider is deprecated in favor of implementing "%s"', ResourceClassNotSupportedException::class, RestrictedDataProviderInterface::class), E_USER_DEPRECATED);
                continue;
            }
        }

        return ($context['collection'] ?? false) ? [] : null;

The expression return $context['collection'] ?? false ? array() : null also could return the type array which is incompatible with the return type mandated by ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface::getSubresource() of iterable|null|object.

    }
}