#26202

pending completion

Build # #26202

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/070c783ae44967b424ceb2c9e72d48dc80702449">070c783ae<a href="https://github.com/api-platform/core/commit/070c783ae44967b424ceb2c9e72d48dc80702449">">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/344e251a433b28badd951d7adddf1367d4cb114a">344e251a4</a>">344e251a4</a><a href="https://github.com/api-platform/core/commit/070c783ae44967b424ceb2c9e72d48dc80702449"> into f53bb6482">f53bb6482</a>

Run Details

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

9502 of 11470 relevant lines covered (82.84%)

14.8 hits per line

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

93.75

/src/Util/AnnotationFilterExtractorTrait.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\Util;

use ApiPlatform\Core\Annotation\ApiFilter;
use Doctrine\Common\Annotations\Reader;

/**
 * Generates a service id for a generic filter.
 *
 * @internal
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 */
trait AnnotationFilterExtractorTrait
{
    /**
     * Filters annotations to get back only ApiFilter annotations.
     *
     * @param \ReflectionClass|\ReflectionProperty $reflector
     *
     * @return \Iterator only ApiFilter annotations
     */
    private function getFilterAnnotations(\Reflector $reflector, ?Reader $reader = null): \Iterator
    {
        if (\PHP_VERSION_ID >= 80000 && $attributes = $reflector->getAttributes(ApiFilter::class)) {
            foreach ($attributes as $attribute) {
                yield $attribute->newInstance();
            }
        }

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

        $miscAnnotations = $reflector instanceof \ReflectionClass ? $reader->getClassAnnotations($reflector) : $reader->getPropertyAnnotations($reflector);
        foreach ($miscAnnotations as $miscAnnotation) {
            if (ApiFilter::class === \get_class($miscAnnotation)) {
                yield $miscAnnotation;
            }
        }
    }

    /**
     * Given a filter annotation and reflection elements, find out the properties where the filter is applied.
     */
    private function getFilterProperties(ApiFilter $filterAnnotation, \ReflectionClass $reflectionClass, \ReflectionProperty $reflectionProperty = null): array
    {
        $properties = [];

        if ($filterAnnotation->properties) {
            foreach ($filterAnnotation->properties as $property => $strategy) {
                if (\is_int($property)) {
                    $properties[$strategy] = null;
                } else {
                    $properties[$property] = $strategy;
                }
            }

            return $properties;
        }

        if (null !== $reflectionProperty) {
            $properties[$reflectionProperty->getName()] = $filterAnnotation->strategy ?: null;

            return $properties;
        }

        if ($filterAnnotation->strategy) {
            foreach ($reflectionClass->getProperties() as $reflectionProperty) {
                $properties[$reflectionProperty->getName()] = $filterAnnotation->strategy;
            }
        }

        return $properties;
    }

    /**
     * Reads filter annotations from a ReflectionClass.
     *
     * @return array Key is the filter id. It has two values, properties and the ApiFilter instance
     */
    private function readFilterAnnotations(\ReflectionClass $reflectionClass, Reader $reader = null): array
    {
        $filters = [];

        foreach ($this->getFilterAnnotations($reflectionClass, $reader) as $filterAnnotation) {
            $filterClass = $filterAnnotation->filterClass;
            $id = $this->generateFilterId($reflectionClass, $filterClass, $filterAnnotation->id);

            if (!isset($filters[$id])) {
                $filters[$id] = [$filterAnnotation->arguments, $filterClass];
            }

            if ($properties = $this->getFilterProperties($filterAnnotation, $reflectionClass)) {
                $filters[$id][0]['properties'] = $properties;
            }
        }

        foreach ($reflectionClass->getProperties() as $reflectionProperty) {
            foreach ($this->getFilterAnnotations($reflectionProperty, $reader) as $filterAnnotation) {
                $filterClass = $filterAnnotation->filterClass;
                $id = $this->generateFilterId($reflectionClass, $filterClass, $filterAnnotation->id);

                if (!isset($filters[$id])) {
                    $filters[$id] = [$filterAnnotation->arguments, $filterClass];
                }

                if ($properties = $this->getFilterProperties($filterAnnotation, $reflectionClass, $reflectionProperty)) {
                    if (isset($filters[$id][0]['properties'])) {
                        $filters[$id][0]['properties'] = array_merge($filters[$id][0]['properties'], $properties);
                    } else {
                        $filters[$id][0]['properties'] = $properties;
                    }
                }
            }
        }

        $parent = $reflectionClass->getParentClass();

        if (false !== $parent) {
            return array_merge($filters, $this->readFilterAnnotations($parent, $reader));
        }

        return $filters;
    }

    /**
     * Generates a unique, per-class and per-filter identifier prefixed by `annotated_`.
     *
     * @param \ReflectionClass $reflectionClass the reflection class of a Resource
     * @param string           $filterClass     the filter class
     * @param string|null      $filterId        the filter id
     */
    private function generateFilterId(\ReflectionClass $reflectionClass, string $filterClass, string $filterId = null): string
    {
        $suffix = null !== $filterId ? '_'.$filterId : $filterId;

        return 'annotated_'.Inflector::tableize(str_replace('\\', '', $reflectionClass->getName().(new \ReflectionClass($filterClass))->getName().$suffix));
    }
}

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\Util;
15
16	use ApiPlatform\Core\Annotation\ApiFilter;
17	use Doctrine\Common\Annotations\Reader;
18
19	/**
20	* Generates a service id for a generic filter.
21	*
22	* @internal
23	*
24	* @author Antoine Bluchet <soyuka@gmail.com>
25	*/
26	trait AnnotationFilterExtractorTrait
27	{
28	/**
29	* Filters annotations to get back only ApiFilter annotations.
30	*
31	* @param \ReflectionClass\|\ReflectionProperty $reflector
32	*
33	* @return \Iterator only ApiFilter annotations
34	*/
35	private function getFilterAnnotations(\Reflector $reflector, ?Reader $reader = null): \Iterator
36	{
37	if (\PHP_VERSION_ID >= 80000 && $attributes = $reflector->getAttributes(ApiFilter::class)) {	10✔
38	foreach ($attributes as $attribute) {	×
39	yield $attribute->newInstance();	×
40	}
41	}
42
43	if (null === $reader) {	10✔
44	return;	×
45	}
46
47	$miscAnnotations = $reflector instanceof \ReflectionClass ? $reader->getClassAnnotations($reflector) : $reader->getPropertyAnnotations($reflector);	10✔
48	foreach ($miscAnnotations as $miscAnnotation) {	10✔
49	if (ApiFilter::class === \get_class($miscAnnotation)) {	10✔
50	yield $miscAnnotation;	10✔
51	}
52	}
53	}	10✔
54
55	/**
56	* Given a filter annotation and reflection elements, find out the properties where the filter is applied.
57	*/
58	private function getFilterProperties(ApiFilter $filterAnnotation, \ReflectionClass $reflectionClass, \ReflectionProperty $reflectionProperty = null): array
59	{
60	$properties = [];	10✔
61
62	if ($filterAnnotation->properties) {	10✔
63	foreach ($filterAnnotation->properties as $property => $strategy) {	5✔
64	if (\is_int($property)) {	5✔
65	$properties[$strategy] = null;	4✔
66	} else {
67	$properties[$property] = $strategy;	3✔
68	}
69	}
70
71	return $properties;	5✔
72	}
73
74	if (null !== $reflectionProperty) {	10✔
75	$properties[$reflectionProperty->getName()] = $filterAnnotation->strategy ?: null;	5✔
76
77	return $properties;	5✔
78	}
79
80	if ($filterAnnotation->strategy) {	9✔
81	foreach ($reflectionClass->getProperties() as $reflectionProperty) {	3✔
82	$properties[$reflectionProperty->getName()] = $filterAnnotation->strategy;	3✔
83	}
84	}
85
86	return $properties;	9✔
87	}
88
89	/**
90	* Reads filter annotations from a ReflectionClass.
91	*
92	* @return array Key is the filter id. It has two values, properties and the ApiFilter instance
93	*/
94	private function readFilterAnnotations(\ReflectionClass $reflectionClass, Reader $reader = null): array
95	{
96	$filters = [];	10✔
97
98	foreach ($this->getFilterAnnotations($reflectionClass, $reader) as $filterAnnotation) {	10✔
99	$filterClass = $filterAnnotation->filterClass;	10✔
100	$id = $this->generateFilterId($reflectionClass, $filterClass, $filterAnnotation->id);	10✔
101
102	if (!isset($filters[$id])) {	10✔
103	$filters[$id] = [$filterAnnotation->arguments, $filterClass];	10✔
104	}
105
106	if ($properties = $this->getFilterProperties($filterAnnotation, $reflectionClass)) {	10✔
107	$filters[$id][0]['properties'] = $properties;	5✔
108	}
109	}
110
111	foreach ($reflectionClass->getProperties() as $reflectionProperty) {	10✔
112	foreach ($this->getFilterAnnotations($reflectionProperty, $reader) as $filterAnnotation) {	10✔
113	$filterClass = $filterAnnotation->filterClass;	5✔
114	$id = $this->generateFilterId($reflectionClass, $filterClass, $filterAnnotation->id);	5✔
115
116	if (!isset($filters[$id])) {	5✔
117	$filters[$id] = [$filterAnnotation->arguments, $filterClass];	4✔
118	}
119
120	if ($properties = $this->getFilterProperties($filterAnnotation, $reflectionClass, $reflectionProperty)) {	5✔
121	if (isset($filters[$id][0]['properties'])) {	5✔
122	$filters[$id][0]['properties'] = array_merge($filters[$id][0]['properties'], $properties);	4✔
123	} else {
124	$filters[$id][0]['properties'] = $properties;	4✔
125	}
126	}
127	}
128	}
129
130	$parent = $reflectionClass->getParentClass();	10✔
131
132	if (false !== $parent) {	10✔
133	return array_merge($filters, $this->readFilterAnnotations($parent, $reader));	6✔
134	}
135
136	return $filters;	10✔
137	}
138
139	/**
140	* Generates a unique, per-class and per-filter identifier prefixed by `annotated_`.
141	*
142	* @param \ReflectionClass $reflectionClass the reflection class of a Resource
143	* @param string $filterClass the filter class
144	* @param string\|null $filterId the filter id
145	*/
146	private function generateFilterId(\ReflectionClass $reflectionClass, string $filterClass, string $filterId = null): string
147	{
148	$suffix = null !== $filterId ? '_'.$filterId : $filterId;	10✔
149
150	return 'annotated_'.Inflector::tableize(str_replace('\\', '', $reflectionClass->getName().(new \ReflectionClass($filterClass))->getName().$suffix));	10✔
151	}
152	}

api-platform / core / #26202

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