23458742876

Committed 23 Mar 2026 08:33PM UTC coverage: 98.605% (-0.09%) from 98.693%

Build # 23458742876

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #115 from wol-soft/fix/issue-110

Type system (Type widening for compositions, union types). Fixes #110 and #114.

Coverage Stats

544 of 554 new or added lines in 51 files covered. (98.19%)

3887 of 3942 relevant lines covered (98.6%)

547.23 hits per line

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

99.15

/src/PropertyProcessor/Property/BaseProcessor.php

<?php

declare(strict_types=1);

namespace PHPModelGenerator\PropertyProcessor\Property;

use PHPMicroTemplate\Exception\FileSystemException;
use PHPMicroTemplate\Exception\SyntaxErrorException;
use PHPMicroTemplate\Exception\UndefinedSymbolException;
use PHPModelGenerator\Exception\Object\MaxPropertiesException;
use PHPModelGenerator\Exception\Object\MinPropertiesException;
use PHPModelGenerator\Exception\SchemaException;
use PHPModelGenerator\Model\Property\BaseProperty;
use PHPModelGenerator\Model\Property\CompositionPropertyDecorator;
use PHPModelGenerator\Model\Property\Property;
use PHPModelGenerator\Model\Property\PropertyInterface;
use PHPModelGenerator\Model\Property\PropertyType;
use PHPModelGenerator\Model\SchemaDefinition\JsonSchema;
use PHPModelGenerator\Model\Validator;
use PHPModelGenerator\Model\Validator\AbstractComposedPropertyValidator;
use PHPModelGenerator\Exception\Generic\DeniedPropertyException;
use PHPModelGenerator\Model\Validator\AdditionalPropertiesValidator;
use PHPModelGenerator\Model\Validator\ComposedPropertyValidator;
use PHPModelGenerator\Model\Validator\ConditionalPropertyValidator;
use PHPModelGenerator\Model\Validator\NoAdditionalPropertiesValidator;
use PHPModelGenerator\Model\Validator\PatternPropertiesValidator;
use PHPModelGenerator\Model\Validator\PropertyNamesValidator;
use PHPModelGenerator\Model\Validator\PropertyTemplateValidator;
use PHPModelGenerator\Model\Validator\PropertyValidator;
use PHPModelGenerator\PropertyProcessor\ComposedValue\AllOfProcessor;
use PHPModelGenerator\PropertyProcessor\ComposedValue\ComposedPropertiesInterface;
use PHPModelGenerator\PropertyProcessor\PropertyMetaDataCollection;
use PHPModelGenerator\PropertyProcessor\PropertyFactory;
use PHPModelGenerator\PropertyProcessor\PropertyProcessorFactory;

/**
 * Class BaseObjectProcessor
 *
 * @package PHPModelGenerator\PropertyProcessor\Property
 */
class BaseProcessor extends AbstractPropertyProcessor
{
    protected const TYPE = 'object';

    private const COUNT_PROPERTIES =
        'count(
            array_unique(
                array_merge(
                    array_keys($this->_rawModelDataInput),
                    array_keys($modelData),
                )
            ),
        )';

    /**
     * @inheritdoc
     *
     * @throws FileSystemException
     * @throws SchemaException
     * @throws SyntaxErrorException
     * @throws UndefinedSymbolException
     */
    public function process(string $propertyName, JsonSchema $propertySchema): PropertyInterface
    {
        $this->schema
            ->getSchemaDictionary()
            ->setUpDefinitionDictionary($this->schemaProcessor, $this->schema);

        // create a property which is used to gather composed properties validators.
        $property = new BaseProperty($propertyName, new PropertyType(static::TYPE), $propertySchema);
        $this->generateValidators($property, $propertySchema);

        $this->addPropertiesToSchema($propertySchema);
        $this->transferComposedPropertiesToSchema($property);

        $this->addPropertyNamesValidator($propertySchema);
        $this->addPatternPropertiesValidator($propertySchema);
        $this->addAdditionalPropertiesValidator($propertySchema);

        $this->addMinPropertiesValidator($propertyName, $propertySchema);
        $this->addMaxPropertiesValidator($propertyName, $propertySchema);

        return $property;
    }

    /**
     * Add a validator to check all provided property names
     *
     * @throws SchemaException
     * @throws FileSystemException
     * @throws SyntaxErrorException
     * @throws UndefinedSymbolException
     */
    protected function addPropertyNamesValidator(JsonSchema $propertySchema): void
    {
        if (!isset($propertySchema->getJson()['propertyNames'])) {
            return;
        }

        $this->schema->addBaseValidator(
            new PropertyNamesValidator(
                $this->schemaProcessor,
                $this->schema,
                $propertySchema->withJson($propertySchema->getJson()['propertyNames']),
            )
        );
    }

    /**
     * Add an object validator to specify constraints for properties which are not defined in the schema
     *
     * @throws FileSystemException
     * @throws SchemaException
     * @throws SyntaxErrorException
     * @throws UndefinedSymbolException
     */
    protected function addAdditionalPropertiesValidator(JsonSchema $propertySchema): void
    {
        $json = $propertySchema->getJson();

        if (
            !isset($json['additionalProperties']) &&
            $this->schemaProcessor->getGeneratorConfiguration()->denyAdditionalProperties()
        ) {
            $json['additionalProperties'] = false;
        }

        if (!isset($json['additionalProperties']) || $json['additionalProperties'] === true) {
            return;
        }

        if (!is_bool($json['additionalProperties'])) {
            $this->schema->addBaseValidator(
                new AdditionalPropertiesValidator(
                    $this->schemaProcessor,
                    $this->schema,
                    $propertySchema,
                )
            );

            return;
        }

        $this->schema->addBaseValidator(
            new NoAdditionalPropertiesValidator(
                new Property($this->schema->getClassName(), null, $propertySchema),
                $json,
            )
        );
    }

    /**
     * @throws SchemaException
     */
    protected function addPatternPropertiesValidator(JsonSchema $propertySchema): void
    {
        $json = $propertySchema->getJson();

        if (!isset($json['patternProperties'])) {
            return;
        }

        foreach ($json['patternProperties'] as $pattern => $schema) {
            $escapedPattern = addcslashes($pattern, '/');

            if (@preg_match("/$escapedPattern/", '') === false) {
                throw new SchemaException(
                    "Invalid pattern '$pattern' for pattern property in file {$propertySchema->getFile()}",
                );
            }

            $validator = new PatternPropertiesValidator(
                $this->schemaProcessor,
                $this->schema,
                $pattern,
                $propertySchema->withJson($schema),
            );

            $this->schema->addBaseValidator($validator);
        }
    }

    /**
     * Add an object validator to limit the amount of provided properties
     *
     * @throws SchemaException
     */
    protected function addMaxPropertiesValidator(string $propertyName, JsonSchema $propertySchema): void
    {
        $json = $propertySchema->getJson();

        if (!isset($json['maxProperties'])) {
            return;
        }

        $this->schema->addBaseValidator(
            new PropertyValidator(
                new Property($propertyName, null, $propertySchema),
                sprintf(
                    '%s > %d',
                    self::COUNT_PROPERTIES,
                    $json['maxProperties'],
                ),
                MaxPropertiesException::class,
                [$json['maxProperties']],
            )
        );
    }

    /**
     * Add an object validator to force at least the defined amount of properties to be provided
     *
     * @throws SchemaException
     */
    protected function addMinPropertiesValidator(string $propertyName, JsonSchema $propertySchema): void
    {
        $json = $propertySchema->getJson();

        if (!isset($json['minProperties'])) {
            return;
        }

        $this->schema->addBaseValidator(
            new PropertyValidator(
                new Property($propertyName, null, $propertySchema),
                sprintf(
                    '%s < %d',
                    self::COUNT_PROPERTIES,
                    $json['minProperties'],
                ),
                MinPropertiesException::class,
                [$json['minProperties']],
            )
        );
    }

    /**
     * Add the properties defined in the JSON schema to the current schema model
     *
     * @throws SchemaException
     */
    protected function addPropertiesToSchema(JsonSchema $propertySchema): void
    {
        $json = $propertySchema->getJson();

        $propertyFactory = new PropertyFactory(new PropertyProcessorFactory());
        $propertyMetaDataCollection = new PropertyMetaDataCollection(
            $json['required'] ?? [],
            $json['dependencies'] ?? [],
        );

        $json['properties'] ??= [];
        // setup empty properties for required properties which aren't defined in the properties section of the schema
        $json['properties'] += array_fill_keys(
            array_diff($json['required'] ?? [], array_keys($json['properties'])),
            [],
        );

        foreach ($json['properties'] as $propertyName => $propertyStructure) {
            if ($propertyStructure === false) {
                if (in_array($propertyName, $json['required'] ?? [], true)) {
                    throw new SchemaException(
                        sprintf(
                            "Property '%s' is denied (schema false) but also listed as required in file %s",
                            $propertyName,
                            $propertySchema->getFile(),
                        ),
                    );
                }

                $this->schema->addBaseValidator(
                    new PropertyValidator(
                        new Property($propertyName, null, $propertySchema->withJson([])),
                        "array_key_exists('" . addslashes($propertyName) . "', \$modelData)",
                        DeniedPropertyException::class,
                    )
                );
                continue;
            }

            $this->schema->addProperty(
                $propertyFactory->create(
                    $propertyMetaDataCollection,
                    $this->schemaProcessor,
                    $this->schema,
                    (string) $propertyName,
                    $propertySchema->withJson($propertyStructure),
                )
            );
        }
    }

    /**
     * Transfer properties of composed properties to the current schema to offer a complete model including all
     * composed properties.
     *
     * @throws SchemaException
     */
    protected function transferComposedPropertiesToSchema(PropertyInterface $property): void
    {
        foreach ($property->getValidators() as $validator) {
            $validator = $validator->getValidator();

            if (!is_a($validator, AbstractComposedPropertyValidator::class)) {
                continue;
            }

            // If the transferred validator of the composed property is also a composed property strip the nested
            // composition validations from the added validator. The nested composition will be validated in the object
            // generated for the nested composition which will be executed via an instantiation. Consequently, the
            // validation must not be executed in the outer composition.
            $this->schema->addBaseValidator(
                ($validator instanceof ComposedPropertyValidator)
                    ? $validator->withoutNestedCompositionValidation()
                    : $validator,
            );

            if (!is_a($validator->getCompositionProcessor(), ComposedPropertiesInterface::class, true)) {
                continue;
            }

            $branchesForValidator = $validator instanceof ConditionalPropertyValidator
                ? $validator->getConditionBranches()
                : $validator->getComposedProperties();

            $totalBranches = count($branchesForValidator);
            $resolvedPropertiesCallbacks = 0;
            $seenBranchPropertyNames = [];

            foreach ($validator->getComposedProperties() as $composedProperty) {
                $composedProperty->onResolve(function () use (
                    $composedProperty,
                    $property,
                    $validator,
                    $branchesForValidator,
                    $totalBranches,
                    &$resolvedPropertiesCallbacks,
                    &$seenBranchPropertyNames,
                ): void {
                    if (!$composedProperty->getNestedSchema()) {
                        throw new SchemaException(
                            sprintf(
                                "No nested schema for composed property %s in file %s found",
                                $property->getName(),
                                $property->getJsonSchema()->getFile(),
                            )
                        );
                    }

                    $isBranchForValidator = in_array($composedProperty, $branchesForValidator, true);

                    $composedProperty->getNestedSchema()->onAllPropertiesResolved(
                        function () use (
                            $composedProperty,
                            $validator,
                            $isBranchForValidator,
                            $totalBranches,
                            &$resolvedPropertiesCallbacks,
                            &$seenBranchPropertyNames,
                        ): void {
                            foreach ($composedProperty->getNestedSchema()->getProperties() as $branchProperty) {
                                $this->schema->addProperty(
                                    $this->cloneTransferredProperty(
                                        $branchProperty,
                                        $composedProperty,
                                        $validator,
                                    ),
                                    $validator->getCompositionProcessor(),
                                );

                                $composedProperty->appendAffectedObjectProperty($branchProperty);
                                $seenBranchPropertyNames[$branchProperty->getName()] = true;
                            }

                            if ($isBranchForValidator && ++$resolvedPropertiesCallbacks === $totalBranches) {
                                foreach (array_keys($seenBranchPropertyNames) as $branchPropertyName) {
                                    $this->schema->getPropertyMerger()->checkForTotalConflict(
                                        $branchPropertyName,
                                        $totalBranches,
                                    );
                                }
                            }
                        },
                    );
                });
            }
        }
    }

    /**
     * Clone the provided property to transfer it to a schema. Sets the nullability and required flag based on the
     * composition processor used to set up the composition. Widens the type to mixed when the property is exclusive
     * to one anyOf/oneOf branch and at least one other branch allows additional properties, preventing TypeError when
     * raw input values of an arbitrary type are stored in the property slot.
     */
    private function cloneTransferredProperty(
        PropertyInterface $property,
        CompositionPropertyDecorator $sourceBranch,
        AbstractComposedPropertyValidator $validator,
    ): PropertyInterface {
        $compositionProcessor = $validator->getCompositionProcessor();

        $transferredProperty = (clone $property)
            ->filterValidators(static fn(Validator $validator): bool =>
                is_a($validator->getValidator(), PropertyTemplateValidator::class));

        if (!is_a($compositionProcessor, AllOfProcessor::class, true)) {
            $transferredProperty->setRequired(false);

            if ($transferredProperty->getType()) {
                $transferredProperty->setType(
                    new PropertyType($transferredProperty->getType()->getNames(), true),
                    new PropertyType($transferredProperty->getType(true)->getNames(), true),
                );
            }

            $wideningBranches = $validator instanceof ConditionalPropertyValidator
                ? $validator->getConditionBranches()
                : $validator->getComposedProperties();

            if ($this->exclusiveBranchPropertyNeedsWidening($property->getName(), $sourceBranch, $wideningBranches)) {
                $transferredProperty->setType(null, null, reset: true);
            }
        }

        return $transferredProperty;
    }

    /**
     * Returns true when the property named $propertyName is exclusive to $sourceBranch and at least
     * one other anyOf/oneOf branch allows additional properties (i.e. does NOT declare
     * additionalProperties: false). In that case the property slot can receive an arbitrarily-typed
     * raw input value from a non-matching branch, so the native type hint must be removed.
     *
     * Returns false when the property appears in another branch too (Schema::addProperty handles
     * that via type merging) or when all other branches have additionalProperties: false (making
     * the property mutually exclusive with the other branches' properties).
     *
     * @param CompositionPropertyDecorator[] $allBranches
     */
    private function exclusiveBranchPropertyNeedsWidening(
        string $propertyName,
        CompositionPropertyDecorator $sourceBranch,
        array $allBranches,
    ): bool {
        // Pass 1: if any other branch defines the same property, Phase 6 handles the type
        // merging via Schema::addProperty — widening to mixed is not needed here.
        foreach ($allBranches as $branch) {
            if ($branch === $sourceBranch) {
                continue;
            }

            $branchPropertyNames = $branch->getNestedSchema()
                ? array_map(
                    static fn(PropertyInterface $p): string => $p->getName(),
                    $branch->getNestedSchema()->getProperties(),
                )
                : [];

            if (in_array($propertyName, $branchPropertyNames, true)) {
                return false;
            }
        }

        // Pass 2: the property is exclusive to $sourceBranch. Widening is needed when at
        // least one other branch allows additional properties — an arbitrary input value can
        // then land in this slot when that branch is the one that matched.
        foreach ($allBranches as $branch) {
            if ($branch === $sourceBranch) {
                continue;
            }

            if (($branch->getBranchSchema()->getJson()['additionalProperties'] ?? true) !== false) {
                return true;
            }
        }

        // All other branches have additionalProperties:false — no arbitrary value can arrive.
        return false;
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	namespace PHPModelGenerator\PropertyProcessor\Property;
6
7	use PHPMicroTemplate\Exception\FileSystemException;
8	use PHPMicroTemplate\Exception\SyntaxErrorException;
9	use PHPMicroTemplate\Exception\UndefinedSymbolException;
10	use PHPModelGenerator\Exception\Object\MaxPropertiesException;
11	use PHPModelGenerator\Exception\Object\MinPropertiesException;
12	use PHPModelGenerator\Exception\SchemaException;
13	use PHPModelGenerator\Model\Property\BaseProperty;
14	use PHPModelGenerator\Model\Property\CompositionPropertyDecorator;
15	use PHPModelGenerator\Model\Property\Property;
16	use PHPModelGenerator\Model\Property\PropertyInterface;
17	use PHPModelGenerator\Model\Property\PropertyType;
18	use PHPModelGenerator\Model\SchemaDefinition\JsonSchema;
19	use PHPModelGenerator\Model\Validator;
20	use PHPModelGenerator\Model\Validator\AbstractComposedPropertyValidator;
21	use PHPModelGenerator\Exception\Generic\DeniedPropertyException;
22	use PHPModelGenerator\Model\Validator\AdditionalPropertiesValidator;
23	use PHPModelGenerator\Model\Validator\ComposedPropertyValidator;
24	use PHPModelGenerator\Model\Validator\ConditionalPropertyValidator;
25	use PHPModelGenerator\Model\Validator\NoAdditionalPropertiesValidator;
26	use PHPModelGenerator\Model\Validator\PatternPropertiesValidator;
27	use PHPModelGenerator\Model\Validator\PropertyNamesValidator;
28	use PHPModelGenerator\Model\Validator\PropertyTemplateValidator;
29	use PHPModelGenerator\Model\Validator\PropertyValidator;
30	use PHPModelGenerator\PropertyProcessor\ComposedValue\AllOfProcessor;
31	use PHPModelGenerator\PropertyProcessor\ComposedValue\ComposedPropertiesInterface;
32	use PHPModelGenerator\PropertyProcessor\PropertyMetaDataCollection;
33	use PHPModelGenerator\PropertyProcessor\PropertyFactory;
34	use PHPModelGenerator\PropertyProcessor\PropertyProcessorFactory;
35
36	/**
37	* Class BaseObjectProcessor
38	*
39	* @package PHPModelGenerator\PropertyProcessor\Property
40	*/
41	class BaseProcessor extends AbstractPropertyProcessor
42	{
43	protected const TYPE = 'object';
44
45	private const COUNT_PROPERTIES =
46	'count(
47	array_unique(
48	array_merge(
49	array_keys($this->_rawModelDataInput),
50	array_keys($modelData),
51	)
52	),
53	)';
54
55	/**
56	* @inheritdoc
57	*
58	* @throws FileSystemException
59	* @throws SchemaException
60	* @throws SyntaxErrorException
61	* @throws UndefinedSymbolException
62	*/
63	public function process(string $propertyName, JsonSchema $propertySchema): PropertyInterface	2,064✔
64	{
65	$this->schema	2,064✔
66	->getSchemaDictionary()	2,064✔
67	->setUpDefinitionDictionary($this->schemaProcessor, $this->schema);	2,064✔
68
69	// create a property which is used to gather composed properties validators.
70	$property = new BaseProperty($propertyName, new PropertyType(static::TYPE), $propertySchema);	2,064✔
71	$this->generateValidators($property, $propertySchema);	2,064✔
72
73	$this->addPropertiesToSchema($propertySchema);	2,063✔
74	$this->transferComposedPropertiesToSchema($property);	2,005✔
75
76	$this->addPropertyNamesValidator($propertySchema);	2,004✔
77	$this->addPatternPropertiesValidator($propertySchema);	2,003✔
78	$this->addAdditionalPropertiesValidator($propertySchema);	2,002✔
79
80	$this->addMinPropertiesValidator($propertyName, $propertySchema);	2,002✔
81	$this->addMaxPropertiesValidator($propertyName, $propertySchema);	2,002✔
82
83	return $property;	2,002✔
84	}
85
86	/**
87	* Add a validator to check all provided property names
88	*
89	* @throws SchemaException
90	* @throws FileSystemException
91	* @throws SyntaxErrorException
92	* @throws UndefinedSymbolException
93	*/
94	protected function addPropertyNamesValidator(JsonSchema $propertySchema): void	2,004✔
95	{
96	if (!isset($propertySchema->getJson()['propertyNames'])) {	2,004✔
97	return;	1,960✔
98	}
99
100	$this->schema->addBaseValidator(	44✔
101	new PropertyNamesValidator(	44✔
102	$this->schemaProcessor,	44✔
103	$this->schema,	44✔
104	$propertySchema->withJson($propertySchema->getJson()['propertyNames']),	44✔
105	)	44✔
106	);	44✔
107	}
108
109	/**
110	* Add an object validator to specify constraints for properties which are not defined in the schema
111	*
112	* @throws FileSystemException
113	* @throws SchemaException
114	* @throws SyntaxErrorException
115	* @throws UndefinedSymbolException
116	*/
117	protected function addAdditionalPropertiesValidator(JsonSchema $propertySchema): void	2,002✔
118	{
119	$json = $propertySchema->getJson();	2,002✔
120
121	if (
122	!isset($json['additionalProperties']) &&	2,002✔
123	$this->schemaProcessor->getGeneratorConfiguration()->denyAdditionalProperties()	2,002✔
124	) {
125	$json['additionalProperties'] = false;	5✔
126	}
127
128	if (!isset($json['additionalProperties']) \|\| $json['additionalProperties'] === true) {	2,002✔
129	return;	1,924✔
130	}
131
132	if (!is_bool($json['additionalProperties'])) {	230✔
133	$this->schema->addBaseValidator(	88✔
134	new AdditionalPropertiesValidator(	88✔
135	$this->schemaProcessor,	88✔
136	$this->schema,	88✔
137	$propertySchema,	88✔
138	)	88✔
139	);	88✔
140
141	return;	88✔
142	}
143
144	$this->schema->addBaseValidator(	142✔
145	new NoAdditionalPropertiesValidator(	142✔
146	new Property($this->schema->getClassName(), null, $propertySchema),	142✔
147	$json,	142✔
148	)	142✔
149	);	142✔
150	}
151
152	/**
153	* @throws SchemaException
154	*/
155	protected function addPatternPropertiesValidator(JsonSchema $propertySchema): void	2,003✔
156	{
157	$json = $propertySchema->getJson();	2,003✔
158
159	if (!isset($json['patternProperties'])) {	2,003✔
160	return;	1,947✔
161	}
162
163	foreach ($json['patternProperties'] as $pattern => $schema) {	58✔
164	$escapedPattern = addcslashes($pattern, '/');	58✔
165
166	if (@preg_match("/$escapedPattern/", '') === false) {	58✔
167	throw new SchemaException(	1✔
168	"Invalid pattern '$pattern' for pattern property in file {$propertySchema->getFile()}",	1✔
169	);	1✔
170	}
171
172	$validator = new PatternPropertiesValidator(	57✔
173	$this->schemaProcessor,	57✔
174	$this->schema,	57✔
175	$pattern,	57✔
176	$propertySchema->withJson($schema),	57✔
177	);	57✔
178
179	$this->schema->addBaseValidator($validator);	57✔
180	}
181	}
182
183	/**
184	* Add an object validator to limit the amount of provided properties
185	*
186	* @throws SchemaException
187	*/
188	protected function addMaxPropertiesValidator(string $propertyName, JsonSchema $propertySchema): void	2,002✔
189	{
190	$json = $propertySchema->getJson();	2,002✔
191
192	if (!isset($json['maxProperties'])) {	2,002✔
193	return;	1,969✔
194	}
195
196	$this->schema->addBaseValidator(	41✔
197	new PropertyValidator(	41✔
198	new Property($propertyName, null, $propertySchema),	41✔
199	sprintf(	41✔
200	'%s > %d',	41✔
201	self::COUNT_PROPERTIES,	41✔
202	$json['maxProperties'],	41✔
203	),	41✔
204	MaxPropertiesException::class,	41✔
205	[$json['maxProperties']],	41✔
206	)	41✔
207	);	41✔
208	}
209
210	/**
211	* Add an object validator to force at least the defined amount of properties to be provided
212	*
213	* @throws SchemaException
214	*/
215	protected function addMinPropertiesValidator(string $propertyName, JsonSchema $propertySchema): void	2,002✔
216	{
217	$json = $propertySchema->getJson();	2,002✔
218
219	if (!isset($json['minProperties'])) {	2,002✔
220	return;	1,987✔
221	}
222
223	$this->schema->addBaseValidator(	23✔
224	new PropertyValidator(	23✔
225	new Property($propertyName, null, $propertySchema),	23✔
226	sprintf(	23✔
227	'%s < %d',	23✔
228	self::COUNT_PROPERTIES,	23✔
229	$json['minProperties'],	23✔
230	),	23✔
231	MinPropertiesException::class,	23✔
232	[$json['minProperties']],	23✔
233	)	23✔
234	);	23✔
235	}
236
237	/**
238	* Add the properties defined in the JSON schema to the current schema model
239	*
240	* @throws SchemaException
241	*/
242	protected function addPropertiesToSchema(JsonSchema $propertySchema): void	2,063✔
243	{
244	$json = $propertySchema->getJson();	2,063✔
245
246	$propertyFactory = new PropertyFactory(new PropertyProcessorFactory());	2,063✔
247	$propertyMetaDataCollection = new PropertyMetaDataCollection(	2,063✔
248	$json['required'] ?? [],	2,063✔
249	$json['dependencies'] ?? [],	2,063✔
250	);	2,063✔
251
252	$json['properties'] ??= [];	2,063✔
253	// setup empty properties for required properties which aren't defined in the properties section of the schema
254	$json['properties'] += array_fill_keys(	2,063✔
255	array_diff($json['required'] ?? [], array_keys($json['properties'])),	2,063✔
256	[],	2,063✔
257	);	2,063✔
258
259	foreach ($json['properties'] as $propertyName => $propertyStructure) {	2,063✔
260	if ($propertyStructure === false) {	1,996✔
261	if (in_array($propertyName, $json['required'] ?? [], true)) {	13✔
262	throw new SchemaException(	1✔
263	sprintf(	1✔
264	"Property '%s' is denied (schema false) but also listed as required in file %s",	1✔
265	$propertyName,	1✔
266	$propertySchema->getFile(),	1✔
267	),	1✔
268	);	1✔
269	}
270
271	$this->schema->addBaseValidator(	12✔
272	new PropertyValidator(	12✔
273	new Property($propertyName, null, $propertySchema->withJson([])),	12✔
274	"array_key_exists('" . addslashes($propertyName) . "', \$modelData)",	12✔
275	DeniedPropertyException::class,	12✔
276	)	12✔
277	);	12✔
278	continue;	12✔
279	}
280
281	$this->schema->addProperty(	1,995✔
282	$propertyFactory->create(	1,995✔
283	$propertyMetaDataCollection,	1,995✔
284	$this->schemaProcessor,	1,995✔
285	$this->schema,	1,995✔
286	(string) $propertyName,	1,995✔
287	$propertySchema->withJson($propertyStructure),	1,995✔
288	)	1,995✔
289	);	1,995✔
290	}
291	}
292
293	/**
294	* Transfer properties of composed properties to the current schema to offer a complete model including all
295	* composed properties.
296	*
297	* @throws SchemaException
298	*/
299	protected function transferComposedPropertiesToSchema(PropertyInterface $property): void	2,005✔
300	{
301	foreach ($property->getValidators() as $validator) {	2,005✔
302	$validator = $validator->getValidator();	2,005✔
303
304	if (!is_a($validator, AbstractComposedPropertyValidator::class)) {	2,005✔
305	continue;	2,005✔
306	}
307
308	// If the transferred validator of the composed property is also a composed property strip the nested
309	// composition validations from the added validator. The nested composition will be validated in the object
310	// generated for the nested composition which will be executed via an instantiation. Consequently, the
311	// validation must not be executed in the outer composition.
312	$this->schema->addBaseValidator(	266✔
313	($validator instanceof ComposedPropertyValidator)	266✔
314	? $validator->withoutNestedCompositionValidation()	242✔
315	: $validator,	266✔
316	);	266✔
317
318	if (!is_a($validator->getCompositionProcessor(), ComposedPropertiesInterface::class, true)) {	266✔
319	continue;	×
320	}
321
322	$branchesForValidator = $validator instanceof ConditionalPropertyValidator	266✔
323	? $validator->getConditionBranches()	38✔
324	: $validator->getComposedProperties();	242✔
325
326	$totalBranches = count($branchesForValidator);	266✔
327	$resolvedPropertiesCallbacks = 0;	266✔
328	$seenBranchPropertyNames = [];	266✔
329
330	foreach ($validator->getComposedProperties() as $composedProperty) {	266✔
331	$composedProperty->onResolve(function () use (	266✔
332	$composedProperty,	266✔
333	$property,	266✔
334	$validator,	266✔
335	$branchesForValidator,	266✔
336	$totalBranches,	266✔
337	&$resolvedPropertiesCallbacks,	266✔
338	&$seenBranchPropertyNames,	266✔
339	): void {	266✔
340	if (!$composedProperty->getNestedSchema()) {	266✔
341	throw new SchemaException(	1✔
342	sprintf(	1✔
343	"No nested schema for composed property %s in file %s found",	1✔
344	$property->getName(),	1✔
345	$property->getJsonSchema()->getFile(),	1✔
346	)	1✔
347	);	1✔
348	}
349
350	$isBranchForValidator = in_array($composedProperty, $branchesForValidator, true);	265✔
351
352	$composedProperty->getNestedSchema()->onAllPropertiesResolved(	265✔
353	function () use (	265✔
354	$composedProperty,	265✔
355	$validator,	265✔
356	$isBranchForValidator,	265✔
357	$totalBranches,	265✔
358	&$resolvedPropertiesCallbacks,	265✔
359	&$seenBranchPropertyNames,	265✔
360	): void {	265✔
361	foreach ($composedProperty->getNestedSchema()->getProperties() as $branchProperty) {	265✔
362	$this->schema->addProperty(	265✔
363	$this->cloneTransferredProperty(	265✔
364	$branchProperty,	265✔
365	$composedProperty,	265✔
366	$validator,	265✔
367	),	265✔
368	$validator->getCompositionProcessor(),	265✔
369	);	265✔
370
371	$composedProperty->appendAffectedObjectProperty($branchProperty);	263✔
372	$seenBranchPropertyNames[$branchProperty->getName()] = true;	263✔
373	}
374
375	if ($isBranchForValidator && ++$resolvedPropertiesCallbacks === $totalBranches) {	263✔
376	foreach (array_keys($seenBranchPropertyNames) as $branchPropertyName) {	262✔
377	$this->schema->getPropertyMerger()->checkForTotalConflict(	262✔
378	$branchPropertyName,	262✔
379	$totalBranches,	262✔
380	);	262✔
381	}
382	}
383	},	265✔
384	);	265✔
385	});	266✔
386	}
387	}
388	}
389
390	/**
391	* Clone the provided property to transfer it to a schema. Sets the nullability and required flag based on the
392	* composition processor used to set up the composition. Widens the type to mixed when the property is exclusive
393	* to one anyOf/oneOf branch and at least one other branch allows additional properties, preventing TypeError when
394	* raw input values of an arbitrary type are stored in the property slot.
395	*/
396	private function cloneTransferredProperty(	265✔
397	PropertyInterface $property,
398	CompositionPropertyDecorator $sourceBranch,
399	AbstractComposedPropertyValidator $validator,
400	): PropertyInterface {
401	$compositionProcessor = $validator->getCompositionProcessor();	265✔
402
403	$transferredProperty = (clone $property)	265✔
404	->filterValidators(static fn(Validator $validator): bool =>	265✔
405	is_a($validator->getValidator(), PropertyTemplateValidator::class));	265✔
406
407	if (!is_a($compositionProcessor, AllOfProcessor::class, true)) {	265✔
408	$transferredProperty->setRequired(false);	167✔
409
410	if ($transferredProperty->getType()) {	167✔
411	$transferredProperty->setType(	167✔
412	new PropertyType($transferredProperty->getType()->getNames(), true),	167✔
413	new PropertyType($transferredProperty->getType(true)->getNames(), true),	167✔
414	);	167✔
415	}
416
417	$wideningBranches = $validator instanceof ConditionalPropertyValidator	167✔
418	? $validator->getConditionBranches()	38✔
419	: $validator->getComposedProperties();	129✔
420
421	if ($this->exclusiveBranchPropertyNeedsWidening($property->getName(), $sourceBranch, $wideningBranches)) {	167✔
422	$transferredProperty->setType(null, null, reset: true);	130✔
423	}
424	}
425
426	return $transferredProperty;	265✔
427	}
428
429	/**
430	* Returns true when the property named $propertyName is exclusive to $sourceBranch and at least
431	* one other anyOf/oneOf branch allows additional properties (i.e. does NOT declare
432	* additionalProperties: false). In that case the property slot can receive an arbitrarily-typed
433	* raw input value from a non-matching branch, so the native type hint must be removed.
434	*
435	* Returns false when the property appears in another branch too (Schema::addProperty handles
436	* that via type merging) or when all other branches have additionalProperties: false (making
437	* the property mutually exclusive with the other branches' properties).
438	*
439	* @param CompositionPropertyDecorator[] $allBranches
440	*/
441	private function exclusiveBranchPropertyNeedsWidening(	167✔
442	string $propertyName,
443	CompositionPropertyDecorator $sourceBranch,
444	array $allBranches,
445	): bool {
446	// Pass 1: if any other branch defines the same property, Phase 6 handles the type
447	// merging via Schema::addProperty — widening to mixed is not needed here.
448	foreach ($allBranches as $branch) {	167✔
449	if ($branch === $sourceBranch) {	167✔
450	continue;	167✔
451	}
452
453	$branchPropertyNames = $branch->getNestedSchema()	166✔
454	? array_map(	166✔
455	static fn(PropertyInterface $p): string => $p->getName(),	166✔
456	$branch->getNestedSchema()->getProperties(),	166✔
457	)	166✔
NEW 458	: [];	×
459
460	if (in_array($propertyName, $branchPropertyNames, true)) {	166✔
461	return false;	69✔
462	}
463	}
464
465	// Pass 2: the property is exclusive to $sourceBranch. Widening is needed when at
466	// least one other branch allows additional properties — an arbitrary input value can
467	// then land in this slot when that branch is the one that matched.
468	foreach ($allBranches as $branch) {	132✔
469	if ($branch === $sourceBranch) {	132✔
470	continue;	101✔
471	}
472
473	if (($branch->getBranchSchema()->getJson()['additionalProperties'] ?? true) !== false) {	131✔
474	return true;	130✔
475	}
476	}
477
478	// All other branches have additionalProperties:false — no arbitrary value can arrive.
479	return false;	8✔
480	}
481	}

wol-soft / php-json-schema-model-generator / 23458742876

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