<?php

/*
 * This file is part of the NelmioApiDocBundle package.
 *
 * (c) Nelmio
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Nelmio\ApiDocBundle\PropertyDescriber;

use Nelmio\ApiDocBundle\ModelDescriber\ObjectModelDescriber;
use OpenApi\Annotations as OA;
use OpenApi\Generator;

/**
 * Mark a property as required if it is not nullable.
 *
 * @deprecated {@see ObjectModelDescriber::markRequiredProperties()}
 */
final class RequiredPropertyDescriber implements PropertyDescriberInterface, PropertyDescriberAwareInterface
{
    use PropertyDescriberAwareTrait;

    /**
     * @param array<string, mixed> $context Context options for describing the property
     */
    public function describe(array $types, OA\Schema $property, ?array $groups = null, ?OA\Schema $schema = null, array $context = [])
    {
        if (null === $schema) {
            trigger_deprecation(
                'nelmio/api-doc-bundle',
                '4.15.0',
                '"%s()" will have a new "OA\Schema $schema" argument in a future version. Not defining it or passing null is deprecated',
                __METHOD__
            );
        }

        if (null !== $groups) {
            trigger_deprecation(
                'nelmio/api-doc-bundle',
                '4.17.0',
                'Using the $groups parameter of "%s()" is deprecated and will be removed in a future version. Pass groups via $context[\'groups\']',
                __METHOD__
            );
        }

        $this->propertyDescriber->describe($types, $property, $groups, $schema, $context);

        if (!$property instanceof OA\Property) {
            return;
        }

        if (null === $schema) {
            return;
        }

        if (true === $property->nullable || !Generator::isDefault($property->default)) {
            return;
        }

        $existingRequiredFields = Generator::UNDEFINED !== $schema->required ? $schema->required : [];
        $existingRequiredFields[] = $property->property;

        $schema->required = array_values(array_unique($existingRequiredFields));
    }

    public function supports(array $types, array $context = []): bool
    {
        return true;
    }
}
