#28125

pending completion

Build # #28125

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/390d08b27ebd034d1974df00d9ef075fa21798c3">390d08b27<a href="https://github.com/api-platform/core/commit/390d08b27ebd034d1974df00d9ef075fa21798c3">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/7e5c2d08bee492ce26ff032cfc2343eefb1874d8">7e5c2d08b</a>">7e5c2d08b</a><a href="https://github.com/api-platform/core/commit/390d08b27ebd034d1974df00d9ef075fa21798c3"> into 359baae78">359baae78</a>

Run Details

3 of 3 new or added lines in 2 files covered. (100.0%)

7570 of 11650 relevant lines covered (64.98%)

88.39 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.76

/src/Bridge/Symfony/Validator/Metadata/Property/ValidatorPropertyMetadataFactory.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\Bridge\Symfony\Validator\Metadata\Property;

use ApiPlatform\Core\Bridge\Symfony\Validator\Metadata\Property\Restriction\PropertySchemaRestrictionMetadataInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints\Bic;
use Symfony\Component\Validator\Constraints\CardScheme;
use Symfony\Component\Validator\Constraints\Compound;
use Symfony\Component\Validator\Constraints\Currency;
use Symfony\Component\Validator\Constraints\Date;
use Symfony\Component\Validator\Constraints\DateTime;
use Symfony\Component\Validator\Constraints\Email;
use Symfony\Component\Validator\Constraints\File;
use Symfony\Component\Validator\Constraints\Iban;
use Symfony\Component\Validator\Constraints\Image;
use Symfony\Component\Validator\Constraints\Isbn;
use Symfony\Component\Validator\Constraints\Issn;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\NotNull;
use Symfony\Component\Validator\Constraints\Sequentially;
use Symfony\Component\Validator\Constraints\Time;
use Symfony\Component\Validator\Constraints\Url;
use Symfony\Component\Validator\Constraints\Uuid;
use Symfony\Component\Validator\Mapping\ClassMetadataInterface as ValidatorClassMetadataInterface;
use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface as ValidatorMetadataFactoryInterface;
use Symfony\Component\Validator\Mapping\PropertyMetadataInterface as ValidatorPropertyMetadataInterface;

/**
 * Decorates a metadata loader using the validator.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class ValidatorPropertyMetadataFactory implements PropertyMetadataFactoryInterface
{
    /**
     * @var string[] A list of constraint classes making the entity required
     */
    public const REQUIRED_CONSTRAINTS = [NotBlank::class, NotNull::class];

    public const SCHEMA_MAPPED_CONSTRAINTS = [
        Url::class => 'http://schema.org/url',
        Email::class => 'http://schema.org/email',
        Uuid::class => 'http://schema.org/identifier',
        CardScheme::class => 'http://schema.org/identifier',
        Bic::class => 'http://schema.org/identifier',
        Iban::class => 'http://schema.org/identifier',
        Date::class => 'http://schema.org/Date',
        DateTime::class => 'http://schema.org/DateTime',
        Time::class => 'http://schema.org/Time',
        Image::class => 'http://schema.org/image',
        File::class => 'http://schema.org/MediaObject',
        Currency::class => 'http://schema.org/priceCurrency',
        Isbn::class => 'http://schema.org/isbn',
        Issn::class => 'http://schema.org/issn',
    ];

    private $decorated;
    private $validatorMetadataFactory;
    /**
     * @var iterable<PropertySchemaRestrictionMetadataInterface>
     */
    private $restrictionsMetadata;

    /**
     * @param PropertySchemaRestrictionMetadataInterface[] $restrictionsMetadata
     */
    public function __construct(ValidatorMetadataFactoryInterface $validatorMetadataFactory, PropertyMetadataFactoryInterface $decorated, iterable $restrictionsMetadata = [])
    {
        $this->validatorMetadataFactory = $validatorMetadataFactory;
        $this->decorated = $decorated;
        $this->restrictionsMetadata = $restrictionsMetadata;
    }

    /**
     * {@inheritdoc}
     */
    public function create(string $resourceClass, string $property, array $options = []): PropertyMetadata
    {
        $propertyMetadata = $this->decorated->create($resourceClass, $property, $options);

        $required = $propertyMetadata->isRequired();
        $iri = $propertyMetadata->getIri();
        $schema = $propertyMetadata->getSchema();

        if (null !== $required && null !== $iri && null !== $schema) {
            return $propertyMetadata;
        }

        $validatorClassMetadata = $this->validatorMetadataFactory->getMetadataFor($resourceClass);

        if (!$validatorClassMetadata instanceof ValidatorClassMetadataInterface) {
            throw new \UnexpectedValueException(sprintf('Validator class metadata expected to be of type "%s".', ValidatorClassMetadataInterface::class));
        }

        $validationGroups = $this->getValidationGroups($validatorClassMetadata, $options);
        $restrictions = [];

        foreach ($validatorClassMetadata->getPropertyMetadata($property) as $validatorPropertyMetadata) {
            foreach ($this->getPropertyConstraints($validatorPropertyMetadata, $validationGroups) as $constraint) {
                if (null === $required && $this->isRequired($constraint)) {
                    $required = true;
                }

                if (null === $iri) {
                    $iri = self::SCHEMA_MAPPED_CONSTRAINTS[\get_class($constraint)] ?? null;
                }

                foreach ($this->restrictionsMetadata as $restrictionMetadata) {
                    if ($restrictionMetadata->supports($constraint, $propertyMetadata)) {
                        $restrictions[] = $restrictionMetadata->create($constraint, $propertyMetadata);
                    }
                }
            }
        }

        $propertyMetadata = $propertyMetadata->withIri($iri)->withRequired($required ?? false);

        if (!empty($restrictions)) {
            if (null === $schema) {
                $schema = [];
            }

            $schema += array_merge(...$restrictions);
            $propertyMetadata = $propertyMetadata->withSchema($schema);
        }

        return $propertyMetadata;
    }

    /**
     * Returns the list of validation groups.
     */
    private function getValidationGroups(ValidatorClassMetadataInterface $classMetadata, array $options): array
    {
        if (isset($options['validation_groups'])) {
            return $options['validation_groups'];
        }

        if (!method_exists($classMetadata, 'getDefaultGroup')) {
            throw new \UnexpectedValueException(sprintf('Validator class metadata expected to have method "%s".', 'getDefaultGroup'));
        }

        return [$classMetadata->getDefaultGroup()];
    }

    /**
     * Tests if the property is required because of its validation groups.
     */
    private function getPropertyConstraints(
        ValidatorPropertyMetadataInterface $validatorPropertyMetadata,
        array $groups
    ): array {
        $constraints = [];

        foreach ($groups as $validationGroup) {
            if (!\is_string($validationGroup)) {
                continue;
            }

            foreach ($validatorPropertyMetadata->findConstraints($validationGroup) as $propertyConstraint) {
                if ($propertyConstraint instanceof Sequentially || $propertyConstraint instanceof Compound) {
                    $constraints[] = method_exists($propertyConstraint, 'getNestedContraints') ? $propertyConstraint->getNestedContraints() : $propertyConstraint->getNestedConstraints();
                } else {
                    $constraints[] = [$propertyConstraint];
                }
            }
        }

        return array_merge([], ...$constraints);
    }

    /**
     * Is this constraint making the related property required?
     */
    private function isRequired(Constraint $constraint): bool
    {
        foreach (self::REQUIRED_CONSTRAINTS as $requiredConstraint) {
            if ($constraint instanceof $requiredConstraint) {
                return true;
            }
        }

        return false;
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Core\Bridge\Symfony\Validator\Metadata\Property;
15
16	use ApiPlatform\Core\Bridge\Symfony\Validator\Metadata\Property\Restriction\PropertySchemaRestrictionMetadataInterface;
17	use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
18	use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
19	use Symfony\Component\Validator\Constraint;
20	use Symfony\Component\Validator\Constraints\Bic;
21	use Symfony\Component\Validator\Constraints\CardScheme;
22	use Symfony\Component\Validator\Constraints\Compound;
23	use Symfony\Component\Validator\Constraints\Currency;
24	use Symfony\Component\Validator\Constraints\Date;
25	use Symfony\Component\Validator\Constraints\DateTime;
26	use Symfony\Component\Validator\Constraints\Email;
27	use Symfony\Component\Validator\Constraints\File;
28	use Symfony\Component\Validator\Constraints\Iban;
29	use Symfony\Component\Validator\Constraints\Image;
30	use Symfony\Component\Validator\Constraints\Isbn;
31	use Symfony\Component\Validator\Constraints\Issn;
32	use Symfony\Component\Validator\Constraints\NotBlank;
33	use Symfony\Component\Validator\Constraints\NotNull;
34	use Symfony\Component\Validator\Constraints\Sequentially;
35	use Symfony\Component\Validator\Constraints\Time;
36	use Symfony\Component\Validator\Constraints\Url;
37	use Symfony\Component\Validator\Constraints\Uuid;
38	use Symfony\Component\Validator\Mapping\ClassMetadataInterface as ValidatorClassMetadataInterface;
39	use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface as ValidatorMetadataFactoryInterface;
40	use Symfony\Component\Validator\Mapping\PropertyMetadataInterface as ValidatorPropertyMetadataInterface;
41
42	/**
43	* Decorates a metadata loader using the validator.
44	*
45	* @author Kévin Dunglas <dunglas@gmail.com>
46	*/
47	final class ValidatorPropertyMetadataFactory implements PropertyMetadataFactoryInterface
48	{
49	/**
50	* @var string[] A list of constraint classes making the entity required
51	*/
52	public const REQUIRED_CONSTRAINTS = [NotBlank::class, NotNull::class];
53
54	public const SCHEMA_MAPPED_CONSTRAINTS = [
55	Url::class => 'http://schema.org/url',
56	Email::class => 'http://schema.org/email',
57	Uuid::class => 'http://schema.org/identifier',
58	CardScheme::class => 'http://schema.org/identifier',
59	Bic::class => 'http://schema.org/identifier',
60	Iban::class => 'http://schema.org/identifier',
61	Date::class => 'http://schema.org/Date',
62	DateTime::class => 'http://schema.org/DateTime',
63	Time::class => 'http://schema.org/Time',
64	Image::class => 'http://schema.org/image',
65	File::class => 'http://schema.org/MediaObject',
66	Currency::class => 'http://schema.org/priceCurrency',
67	Isbn::class => 'http://schema.org/isbn',
68	Issn::class => 'http://schema.org/issn',
69	];
70
71	private $decorated;
72	private $validatorMetadataFactory;
73	/**
74	* @var iterable<PropertySchemaRestrictionMetadataInterface>
75	*/
76	private $restrictionsMetadata;
77
78	/**
79	* @param PropertySchemaRestrictionMetadataInterface[] $restrictionsMetadata
80	*/
81	public function __construct(ValidatorMetadataFactoryInterface $validatorMetadataFactory, PropertyMetadataFactoryInterface $decorated, iterable $restrictionsMetadata = [])
82	{
83	$this->validatorMetadataFactory = $validatorMetadataFactory;	667✔
84	$this->decorated = $decorated;	667✔
85	$this->restrictionsMetadata = $restrictionsMetadata;	667✔
86	}	667✔
87
88	/**
89	* {@inheritdoc}
90	*/
91	public function create(string $resourceClass, string $property, array $options = []): PropertyMetadata
92	{
93	$propertyMetadata = $this->decorated->create($resourceClass, $property, $options);	216✔
94
95	$required = $propertyMetadata->isRequired();	216✔
96	$iri = $propertyMetadata->getIri();	216✔
97	$schema = $propertyMetadata->getSchema();	216✔
98
99	if (null !== $required && null !== $iri && null !== $schema) {	216✔
100	return $propertyMetadata;	×
101	}
102
103	$validatorClassMetadata = $this->validatorMetadataFactory->getMetadataFor($resourceClass);	216✔
104
105	if (!$validatorClassMetadata instanceof ValidatorClassMetadataInterface) {	216✔
106	throw new \UnexpectedValueException(sprintf('Validator class metadata expected to be of type "%s".', ValidatorClassMetadataInterface::class));	×
107	}
108
109	$validationGroups = $this->getValidationGroups($validatorClassMetadata, $options);	216✔
110	$restrictions = [];	216✔
111
112	foreach ($validatorClassMetadata->getPropertyMetadata($property) as $validatorPropertyMetadata) {	216✔
113	foreach ($this->getPropertyConstraints($validatorPropertyMetadata, $validationGroups) as $constraint) {	57✔
114	if (null === $required && $this->isRequired($constraint)) {	54✔
115	$required = true;	49✔
116	}
117
118	if (null === $iri) {	54✔
119	$iri = self::SCHEMA_MAPPED_CONSTRAINTS[\get_class($constraint)] ?? null;	39✔
120	}
121
122	foreach ($this->restrictionsMetadata as $restrictionMetadata) {	54✔
123	if ($restrictionMetadata->supports($constraint, $propertyMetadata)) {	54✔
124	$restrictions[] = $restrictionMetadata->create($constraint, $propertyMetadata);	3✔
125	}
126	}
127	}
128	}
129
130	$propertyMetadata = $propertyMetadata->withIri($iri)->withRequired($required ?? false);	216✔
131
132	if (!empty($restrictions)) {	216✔
133	if (null === $schema) {	3✔
134	$schema = [];	3✔
135	}
136
137	$schema += array_merge(...$restrictions);	3✔
138	$propertyMetadata = $propertyMetadata->withSchema($schema);	3✔
139	}
140
141	return $propertyMetadata;	216✔
142	}
143
144	/**
145	* Returns the list of validation groups.
146	*/
147	private function getValidationGroups(ValidatorClassMetadataInterface $classMetadata, array $options): array
148	{
149	if (isset($options['validation_groups'])) {	216✔
150	return $options['validation_groups'];	×
151	}
152
153	if (!method_exists($classMetadata, 'getDefaultGroup')) {	216✔
154	throw new \UnexpectedValueException(sprintf('Validator class metadata expected to have method "%s".', 'getDefaultGroup'));	×
155	}
156
157	return [$classMetadata->getDefaultGroup()];	216✔
158	}
159
160	/**
161	* Tests if the property is required because of its validation groups.
162	*/
163	private function getPropertyConstraints(
164	ValidatorPropertyMetadataInterface $validatorPropertyMetadata,
165	array $groups
166	): array {
167	$constraints = [];	57✔
168
169	foreach ($groups as $validationGroup) {	57✔
170	if (!\is_string($validationGroup)) {	57✔
171	continue;	×
172	}
173
174	foreach ($validatorPropertyMetadata->findConstraints($validationGroup) as $propertyConstraint) {	57✔
175	if ($propertyConstraint instanceof Sequentially \|\| $propertyConstraint instanceof Compound) {	54✔
176	$constraints[] = method_exists($propertyConstraint, 'getNestedContraints') ? $propertyConstraint->getNestedContraints() : $propertyConstraint->getNestedConstraints();	×
177	} else {
178	$constraints[] = [$propertyConstraint];	54✔
179	}
180	}
181	}
182
183	return array_merge([], ...$constraints);	57✔
184	}
185
186	/**
187	* Is this constraint making the related property required?
188	*/
189	private function isRequired(Constraint $constraint): bool
190	{
191	foreach (self::REQUIRED_CONSTRAINTS as $requiredConstraint) {	54✔
192	if ($constraint instanceof $requiredConstraint) {	54✔
193	return true;	49✔
194	}
195	}
196
197	return false;	12✔
198	}
199	}

api-platform / core / #28125

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous