7142557150

Committed 08 Dec 2023 02:28PM UTC coverage: 36.003% (-1.4%) from 37.36%

Build # 7142557150

Build Type

push

github

Committed by

web-flow

Commit Message

fix(jsonld): remove link to ApiDocumentation when doc is disabled (#6029)

Run Details

0 of 1 new or added line in 1 file covered. (0.0%)

2297 existing lines in 182 files now uncovered.

9992 of 27753 relevant lines covered (36.0%)

147.09 hits per line

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

0.0

/src/Metadata/FilterInterface.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\Metadata;

if (interface_exists(\ApiPlatform\Api\FilterInterface::class)) {
    class_alias(
        \ApiPlatform\Api\FilterInterface::class,
        __NAMESPACE__.'\FilterInterface'
    );

    if (false) { // @phpstan-ignore-line
        interface FilterInterface extends \ApiPlatform\Api\FilterInterface
        {
        }
    }
} else {
    /**
     * Filters applicable on a resource.
     *
     * @author Kévin Dunglas <dunglas@gmail.com>
     */
    interface FilterInterface
    {
        /**
         * Gets the description of this filter for the given resource.
         *
         * Returns an array with the filter parameter names as keys and array with the following data as values:
         *   - property: the property where the filter is applied
         *   - type: the type of the filter
         *   - required: if this filter is required
         *   - strategy (optional): the used strategy
         *   - is_collection (optional): if this filter is for collection
         *   - swagger (optional): additional parameters for the path operation,
         *     e.g. 'swagger' => [
         *       'description' => 'My Description',
         *       'name' => 'My Name',
         *       'type' => 'integer',
         *     ]
         *   - openapi (optional): additional parameters for the path operation in the version 3 spec,
         *     e.g. 'openapi' => [
         *       'description' => 'My Description',
         *       'name' => 'My Name',
         *       'schema' => [
         *          'type' => 'integer',
         *       ]
         *     ]
         *   - schema (optional): schema definition,
         *     e.g. 'schema' => [
         *       'type' => 'string',
         *       'enum' => ['value_1', 'value_2'],
         *     ]
         * The description can contain additional data specific to a filter.
         *
         * @see \ApiPlatform\OpenApi\Factory\OpenApiFactory::getFiltersParameters
         */
        public function getDescription(string $resourceClass): array;
    }
}

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\Metadata;
15
UNCOV 16	if (interface_exists(\ApiPlatform\Api\FilterInterface::class)) {	×
UNCOV 17	class_alias(	×
UNCOV 18	\ApiPlatform\Api\FilterInterface::class,	×
UNCOV 19	__NAMESPACE__.'\FilterInterface'	×
UNCOV 20	);	×
21
UNCOV 22	if (false) { // @phpstan-ignore-line	×
23	interface FilterInterface extends \ApiPlatform\Api\FilterInterface
24	{
25	}
26	}
27	} else {
28	/**
29	* Filters applicable on a resource.
30	*
31	* @author Kévin Dunglas <dunglas@gmail.com>
32	*/
33	interface FilterInterface
34	{
35	/**
36	* Gets the description of this filter for the given resource.
37	*
38	* Returns an array with the filter parameter names as keys and array with the following data as values:
39	* - property: the property where the filter is applied
40	* - type: the type of the filter
41	* - required: if this filter is required
42	* - strategy (optional): the used strategy
43	* - is_collection (optional): if this filter is for collection
44	* - swagger (optional): additional parameters for the path operation,
45	* e.g. 'swagger' => [
46	* 'description' => 'My Description',
47	* 'name' => 'My Name',
48	* 'type' => 'integer',
49	* ]
50	* - openapi (optional): additional parameters for the path operation in the version 3 spec,
51	* e.g. 'openapi' => [
52	* 'description' => 'My Description',
53	* 'name' => 'My Name',
54	* 'schema' => [
55	* 'type' => 'integer',
56	* ]
57	* ]
58	* - schema (optional): schema definition,
59	* e.g. 'schema' => [
60	* 'type' => 'string',
61	* 'enum' => ['value_1', 'value_2'],
62	* ]
63	* The description can contain additional data specific to a filter.
64	*
65	* @see \ApiPlatform\OpenApi\Factory\OpenApiFactory::getFiltersParameters
66	*/
67	public function getDescription(string $resourceClass): array;
68	}
69	}

api-platform / core / 7142557150

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