#24258

pending completion

Build # #24258

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/03bd3ee09d823bb9735e84d0c962f0336aa5d108">03bd3ee09<a href="https://github.com/api-platform/core/commit/03bd3ee09d823bb9735e84d0c962f0336aa5d108">">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/84fb363bc4b0d41c890d66bec8dc5973215beafd">84fb363bc</a>">84fb363bc</a><a href="https://github.com/api-platform/core/commit/03bd3ee09d823bb9735e84d0c962f0336aa5d108"> into 371612623">371612623</a>

Run Details

4 of 4 new or added lines in 1 file covered. (100.0%)

8723 of 9601 relevant lines covered (90.86%)

16.48 hits per line

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

76.6

/src/Bridge/Elasticsearch/DataProvider/Filter/AbstractFilter.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\Elasticsearch\DataProvider\Filter;

use ApiPlatform\Core\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\Bridge\Elasticsearch\Util\FieldDatatypeTrait;
use ApiPlatform\Core\Exception\PropertyNotFoundException;
use ApiPlatform\Core\Exception\ResourceClassNotFoundException;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use Symfony\Component\PropertyInfo\Type;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;

/**
 * Abstract class with helpers for easing the implementation of a filter.
 *
 * @experimental
 *
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
abstract class AbstractFilter implements FilterInterface
{
    use FieldDatatypeTrait { getNestedFieldPath as protected; }

    protected $properties;
    protected $propertyNameCollectionFactory;
    protected $nameConverter;

    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, ?NameConverterInterface $nameConverter = null, ?array $properties = null)
    {
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
        $this->resourceClassResolver = $resourceClassResolver;
        $this->nameConverter = $nameConverter;
        $this->properties = $properties;
    }

    /**
     * Gets all enabled properties for the given resource class.
     */
    protected function getProperties(string $resourceClass): \Traversable
    {
        if (null !== $this->properties) {
            return yield from array_keys($this->properties);
        }

        try {
            yield from $this->propertyNameCollectionFactory->create($resourceClass);
        } catch (ResourceClassNotFoundException $e) {
        }
    }

    /**
     * Is the given property enabled?
     */
    protected function hasProperty(string $resourceClass, string $property): bool
    {
        return \in_array($property, iterator_to_array($this->getProperties($resourceClass)), true);
    }

    /**
     * Gets info about the decomposed given property for the given resource class.
     *
     * Returns an array with the following info as values:
     *   - the {@see Type} of the decomposed given property
     *   - is the decomposed given property an association?
     *   - the resource class of the decomposed given property
     *   - the property name of the decomposed given property
     */
    protected function getMetadata(string $resourceClass, string $property): array
    {
        $noop = [null, null, null, null];

        if (!$this->hasProperty($resourceClass, $property)) {
            return $noop;
        }

        $properties = explode('.', $property);
        $totalProperties = \count($properties);
        $currentResourceClass = $resourceClass;
        $hasAssociation = false;
        $currentProperty = null;
        $type = null;

        foreach ($properties as $index => $currentProperty) {
            try {
                $propertyMetadata = $this->propertyMetadataFactory->create($currentResourceClass, $currentProperty);
            } catch (PropertyNotFoundException $e) {
                return $noop;
            }

            if (null === $type = $propertyMetadata->getType()) {
                return $noop;
            }

            ++$index;
            $builtinType = $type->getBuiltinType();

            if (Type::BUILTIN_TYPE_OBJECT !== $builtinType && Type::BUILTIN_TYPE_ARRAY !== $builtinType) {
                if ($totalProperties === $index) {
                    break;
                }

                return $noop;
            }

            if ($type->isCollection() && null === $type = $type->getCollectionValueType()) {
                return $noop;
            }

            if (Type::BUILTIN_TYPE_ARRAY === $builtinType && Type::BUILTIN_TYPE_OBJECT !== $type->getBuiltinType()) {
                if ($totalProperties === $index) {
                    break;
                }

                return $noop;
            }

            if (null === $className = $type->getClassName()) {
                return $noop;
            }

            if ($isResourceClass = $this->resourceClassResolver->isResourceClass($className)) {
                $currentResourceClass = $className;
            } elseif ($totalProperties !== $index) {
                return $noop;
            }

            $hasAssociation = $totalProperties === $index && $isResourceClass;
        }

        return [$type, $hasAssociation, $currentResourceClass, $currentProperty];
    }
}

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\Elasticsearch\DataProvider\Filter;
15
16	use ApiPlatform\Core\Api\ResourceClassResolverInterface;
17	use ApiPlatform\Core\Bridge\Elasticsearch\Util\FieldDatatypeTrait;
18	use ApiPlatform\Core\Exception\PropertyNotFoundException;
19	use ApiPlatform\Core\Exception\ResourceClassNotFoundException;
20	use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
21	use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
22	use Symfony\Component\PropertyInfo\Type;
23	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
24
25	/**
26	* Abstract class with helpers for easing the implementation of a filter.
27	*
28	* @experimental
29	*
30	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
31	*/
32	abstract class AbstractFilter implements FilterInterface
33	{
34	use FieldDatatypeTrait { getNestedFieldPath as protected; }
35
36	protected $properties;
37	protected $propertyNameCollectionFactory;
38	protected $nameConverter;
39
40	public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, ?NameConverterInterface $nameConverter = null, ?array $properties = null)
41	{
42	$this->propertyNameCollectionFactory = $propertyNameCollectionFactory;	16✔
43	$this->propertyMetadataFactory = $propertyMetadataFactory;	16✔
44	$this->resourceClassResolver = $resourceClassResolver;	16✔
45	$this->nameConverter = $nameConverter;	16✔
46	$this->properties = $properties;	16✔
47	}	16✔
48
49	/**
50	* Gets all enabled properties for the given resource class.
51	*/
52	protected function getProperties(string $resourceClass): \Traversable
53	{
54	if (null !== $this->properties) {	12✔
55	return yield from array_keys($this->properties);	5✔
56	}
57
58	try {
59	yield from $this->propertyNameCollectionFactory->create($resourceClass);	7✔
60	} catch (ResourceClassNotFoundException $e) {	×
61	}
62	}	7✔
63
64	/**
65	* Is the given property enabled?
66	*/
67	protected function hasProperty(string $resourceClass, string $property): bool
68	{
69	return \in_array($property, iterator_to_array($this->getProperties($resourceClass)), true);	12✔
70	}
71
72	/**
73	* Gets info about the decomposed given property for the given resource class.
74	*
75	* Returns an array with the following info as values:
76	* - the {@see Type} of the decomposed given property
77	* - is the decomposed given property an association?
78	* - the resource class of the decomposed given property
79	* - the property name of the decomposed given property
80	*/
81	protected function getMetadata(string $resourceClass, string $property): array
82	{
83	$noop = [null, null, null, null];	12✔
84
85	if (!$this->hasProperty($resourceClass, $property)) {	12✔
86	return $noop;	×
87	}
88
89	$properties = explode('.', $property);	12✔
90	$totalProperties = \count($properties);	12✔
91	$currentResourceClass = $resourceClass;	12✔
92	$hasAssociation = false;	12✔
93	$currentProperty = null;	12✔
94	$type = null;	12✔
95
96	foreach ($properties as $index => $currentProperty) {	12✔
97	try {
98	$propertyMetadata = $this->propertyMetadataFactory->create($currentResourceClass, $currentProperty);	12✔
99	} catch (PropertyNotFoundException $e) {	×
100	return $noop;	×
101	}
102
103	if (null === $type = $propertyMetadata->getType()) {	12✔
104	return $noop;	6✔
105	}
106
107	++$index;	12✔
108	$builtinType = $type->getBuiltinType();	12✔
109
110	if (Type::BUILTIN_TYPE_OBJECT !== $builtinType && Type::BUILTIN_TYPE_ARRAY !== $builtinType) {	12✔
111	if ($totalProperties === $index) {	12✔
112	break;	12✔
113	}
114
115	return $noop;	×
116	}
117
118	if ($type->isCollection() && null === $type = $type->getCollectionValueType()) {	5✔
119	return $noop;	×
120	}
121
122	if (Type::BUILTIN_TYPE_ARRAY === $builtinType && Type::BUILTIN_TYPE_OBJECT !== $type->getBuiltinType()) {	5✔
123	if ($totalProperties === $index) {	×
124	break;	×
125	}
126
127	return $noop;	×
128	}
129
130	if (null === $className = $type->getClassName()) {	5✔
131	return $noop;	×
132	}
133
134	if ($isResourceClass = $this->resourceClassResolver->isResourceClass($className)) {	5✔
135	$currentResourceClass = $className;	3✔
136	} elseif ($totalProperties !== $index) {	2✔
137	return $noop;	×
138	}
139
140	$hasAssociation = $totalProperties === $index && $isResourceClass;	5✔
141	}
142
143	return [$type, $hasAssociation, $currentResourceClass, $currentProperty];	12✔
144	}
145	}

api-platform / core / #24258

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