#27139

pending completion

Build # #27139

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/149a8fb27410e956203301a7849bb145f5fda5e1">149a8fb27<a href="https://github.com/api-platform/core/commit/149a8fb27410e956203301a7849bb145f5fda5e1">">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/777aeaae233667208ea88c34830d5c1e70c9f03a">777aeaae2</a>">777aeaae2</a><a href="https://github.com/api-platform/core/commit/149a8fb27410e956203301a7849bb145f5fda5e1"> into 8671e3b2d">8671e3b2d</a>

Run Details

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

7597 of 12423 relevant lines covered (61.15%)

84.98 hits per line

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

50.0

/src/Annotation/ApiFilter.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\Annotation;

use ApiPlatform\Core\Api\FilterInterface;
use ApiPlatform\Core\Exception\InvalidArgumentException;

/**
 * Filter annotation.
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 *
 * @Annotation
 * @Target({"PROPERTY", "CLASS"})
 */
#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
final class ApiFilter
{
    /**
     * @var string
     */
    public $id;

    /**
     * @var string
     */
    public $strategy;

    /**
     * @var string|FilterInterface
     */
    public $filterClass;

    /**
     * @var array
     */
    public $properties = [];

    /**
     * @var array raw arguments for the filter
     */
    public $arguments = [];

    /**
     * @param string $filterClass
     * @param string $id
     * @param string $strategy
     */
    public function __construct(
        $filterClass,
        ?string $id = null,
        ?string $strategy = null,
        array $properties = [],
        array $arguments = []
    ) {
        if (\is_array($filterClass)) { /** @phpstan-ignore-line Doctrine annotations */
            $options = $filterClass;
            $this->filterClass = $options['value'] ?? null;
            unset($options['value']);

            foreach ($options as $key => $value) {
                if (!property_exists($this, $key)) {
                    throw new InvalidArgumentException(sprintf('Property "%s" does not exist on the ApiFilter annotation.', $key));
                }

                $this->{$key} = $value;
            }
        } else {
            // PHP attribute
            $this->filterClass = $filterClass;
            $this->id = $id;
            $this->strategy = $strategy;
            $this->properties = $properties;
            $this->arguments = $arguments;
        }

        if (!\is_string($this->filterClass)) {
            throw new InvalidArgumentException('This annotation needs a value representing the filter class.');
        }

        if (!is_a($this->filterClass, FilterInterface::class, true)) {
            throw new InvalidArgumentException(sprintf('The filter class "%s" does not implement "%s". Did you forget a use statement?', $this->filterClass, FilterInterface::class));
        }
    }
}

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\Annotation;
15
16	use ApiPlatform\Core\Api\FilterInterface;
17	use ApiPlatform\Core\Exception\InvalidArgumentException;
18
19	/**
20	* Filter annotation.
21	*
22	* @author Antoine Bluchet <soyuka@gmail.com>
23	*
24	* @Annotation
25	* @Target({"PROPERTY", "CLASS"})
26	*/
27	#[\Attribute(\Attribute::TARGET_PROPERTY \| \Attribute::TARGET_CLASS \| \Attribute::IS_REPEATABLE)]
28	final class ApiFilter
29	{
30	/**
31	* @var string
32	*/
33	public $id;
34
35	/**
36	* @var string
37	*/
38	public $strategy;
39
40	/**
41	* @var string\|FilterInterface
42	*/
43	public $filterClass;
44
45	/**
46	* @var array
47	*/
48	public $properties = [];
49
50	/**
51	* @var array raw arguments for the filter
52	*/
53	public $arguments = [];
54
55	/**
56	* @param string $filterClass
57	* @param string $id
58	* @param string $strategy
59	*/
60	public function __construct(
61	$filterClass,
62	?string $id = null,
63	?string $strategy = null,
64	array $properties = [],
65	array $arguments = []
66	) {
67	if (\is_array($filterClass)) { /** @phpstan-ignore-line Doctrine annotations */	1✔
68	$options = $filterClass;	×
69	$this->filterClass = $options['value'] ?? null;	×
70	unset($options['value']);	×
71
72	foreach ($options as $key => $value) {	×
73	if (!property_exists($this, $key)) {	×
74	throw new InvalidArgumentException(sprintf('Property "%s" does not exist on the ApiFilter annotation.', $key));	×
75	}
76
77	$this->{$key} = $value;	×
78	}
79	} else {
80	// PHP attribute
81	$this->filterClass = $filterClass;	1✔
82	$this->id = $id;	1✔
83	$this->strategy = $strategy;	1✔
84	$this->properties = $properties;	1✔
85	$this->arguments = $arguments;	1✔
86	}
87
88	if (!\is_string($this->filterClass)) {	1✔
89	throw new InvalidArgumentException('This annotation needs a value representing the filter class.');	×
90	}
91
92	if (!is_a($this->filterClass, FilterInterface::class, true)) {	1✔
93	throw new InvalidArgumentException(sprintf('The filter class "%s" does not implement "%s". Did you forget a use statement?', $this->filterClass, FilterInterface::class));	×
94	}
95	}	1✔
96	}

api-platform / core / #27139

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