Part-DB-server/src/Serializer/StructuralElementNormalizer.php

<?php

declare(strict_types=1);

/*
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
namespace App\Serializer;

use App\Entity\Base\AbstractStructuralDBElement;
use App\Serializer\APIPlatform\SkippableItemNormalizer;
use Symfony\Component\DependencyInjection\Attribute\Autowire;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;

/**
 * @see \App\Tests\Serializer\StructuralElementNormalizerTest
 */
class StructuralElementNormalizer implements NormalizerInterface, NormalizerAwareInterface
{
    use NormalizerAwareTrait;

    public const ALREADY_CALLED = 'STRUCTURAL_ELEMENT_NORMALIZER_ALREADY_CALLED';

    public function supportsNormalization($data, ?string $format = null, array $context = []): bool
    {
        //Only normalize if we are doing a file export operation
        if (!($context['partdb_export'] ?? false)) {
            return false;
        }

        if (isset($context[self::ALREADY_CALLED]) && in_array($data, $context[self::ALREADY_CALLED], true)) {
            //If we already handled this object, skip it
            return false;
        }

        return $data instanceof AbstractStructuralDBElement;
    }

    public function normalize($object, ?string $format = null, array $context = []): \ArrayObject|bool|float|int|string|array
    {
        if (!$object instanceof AbstractStructuralDBElement) {
            throw new \InvalidArgumentException('This normalizer only supports AbstractStructural objects!');
        }

        //Avoid infinite recursion by checking if we already handled this object
        $context[self::ALREADY_CALLED] = $context[self::ALREADY_CALLED] ?? [];
        $context[SkippableItemNormalizer::DISABLE_ITEM_NORMALIZER] = true;
        $context[self::ALREADY_CALLED][] = $object;

        $data = $this->normalizer->normalize($object, $format, $context);

        //If the data is not an array, we can't do anything with it
        if (!is_array($data)) {
            return $data;
        }

        //Remove type field for CSV export
        if ($format === 'csv') {
            unset($data['type']);
        }

        $data['full_name'] = $object->getFullPath('->');

        return $data;
    }

    /**
     * @return bool[]
     */
    public function getSupportedTypes(?string $format): array
    {
        return [
            //We cannot cache the result, as it depends on the context
            AbstractStructuralDBElement::class => false,
        ];
    }
}