ObjectMapperProcessor.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\State\Processor;

use ApiPlatform\Metadata\Operation;
use ApiPlatform\State\ProcessorInterface;
use ApiPlatform\State\Util\StateOptionsTrait;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\ObjectMapper\ObjectMapperInterface;

/**
 * @deprecated since API Platform 4.3, use {@see ObjectMapperInputProcessor} and {@see ObjectMapperOutputProcessor} instead
 *
 * @implements ProcessorInterface<mixed,mixed>
 */
final class ObjectMapperProcessor implements ProcessorInterface
{
    use StateOptionsTrait;

    /**
     * @param ProcessorInterface<mixed,mixed> $decorated
     */
    public function __construct(
        private readonly ?ObjectMapperInterface $objectMapper,
        private readonly ProcessorInterface $decorated,
    ) {
        trigger_deprecation('api-platform/core', '4.3', 'The "%s" class is deprecated, use "%s" and "%s" instead.', self::class, ObjectMapperInputProcessor::class, ObjectMapperOutputProcessor::class);
    }

    public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): object|array|null
    {
        $class = $operation->getInputClass();

        if (
            $data instanceof Response
            || !$this->objectMapper
            || !$operation->canWrite()
            || null === $data
            || !is_a($data, $class, true)
            || !$operation->canMap()
        ) {
            return $this->decorated->process($data, $operation, $uriVariables, $context);
        }

        $request = $context['request'] ?? null;

        // maps the Resource to an Entity
        if ($request?->attributes->get('mapped_data')) {
            $mappedData = $this->objectMapper->map($data, $request->attributes->get('mapped_data'));
        } else {
            $mappedData = $this->objectMapper->map($data, $this->getStateOptionsClass($operation, $operation->getClass()));
        }
        $request?->attributes->set('mapped_data', $mappedData);

        $persisted = $this->decorated->process(
            $mappedData,
            $operation,
            $uriVariables,
            $context,
        );

        // in some cases (delete operation), the decoration may return a null object
        if (null === $persisted) {
            return $persisted;
        }

        $request?->attributes->set('persisted_data', $persisted);

        // return the Resource representation of the persisted entity
        return $this->objectMapper->map(
            // persist the entity
            $persisted,
            $operation->getClass()
        );
    }
}