* * 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\Util; use ApiPlatform\Core\Api\OperationType; /** * Extracts data used by the library form given attributes. * * @author Antoine Bluchet * * @internal */ final class AttributesExtractor { private function __construct() { } /** * Extracts resource class, operation name and format request attributes. Returns an empty array if the request does * not contain required attributes. */ public static function extractAttributes(array $attributes): array { $result = ['resource_class' => $attributes['_api_resource_class'] ?? null, 'has_composite_identifier' => $attributes['_api_has_composite_identifier'] ?? false]; if ($subresourceContext = $attributes['_api_subresource_context'] ?? null) { $result['subresource_context'] = $subresourceContext; } // Normalizing identifiers tuples // TODO: 3.0 remove $identifiers = []; foreach (($attributes['_api_identifiers'] ?? ['id']) as $parameterName => $identifiedBy) { if (\is_string($identifiedBy)) { $identifiers[$identifiedBy] = [$result['resource_class'], $identifiedBy]; } else { $identifiers[$parameterName] = $identifiedBy; } } $result['identifiers'] = $identifiers; if (null === $result['resource_class']) { return []; } $hasRequestAttributeKey = false; if (isset($attributes['_api_operation_name'])) { $hasRequestAttributeKey = true; $result['operation_name'] = $attributes['_api_operation_name']; } if (isset($attributes['_api_operation'])) { $result['operation'] = $attributes['_api_operation']; } // TODO: remove in 3.0 if (!isset($result['operation']) || ($result['operation']->getExtraProperties()['is_legacy_resource_metadata'] ?? false) || ($result['operation']->getExtraProperties()['is_legacy_subresource'] ?? false)) { foreach (OperationType::TYPES as $operationType) { $attribute = "_api_{$operationType}_operation_name"; if (isset($attributes[$attribute])) { $result["{$operationType}_operation_name"] = $attributes[$attribute]; $hasRequestAttributeKey = true; break; } } } if ($previousObject = $attributes['previous_data'] ?? null) { $result['previous_data'] = $previousObject; } if (false === $hasRequestAttributeKey) { return []; } $result += [ 'receive' => (bool) ($attributes['_api_receive'] ?? true), 'respond' => (bool) ($attributes['_api_respond'] ?? true), 'persist' => (bool) ($attributes['_api_persist'] ?? true), ]; return $result; } } class_alias(AttributesExtractor::class, \ApiPlatform\Core\Util\AttributesExtractor::class);