• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

api-platform / core / 16050929464

03 Jul 2025 12:51PM UTC coverage: 22.065% (+0.2%) from 21.821%
16050929464

push

github

soyuka
chore: todo improvement

11516 of 52192 relevant lines covered (22.06%)

22.08 hits per line

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

100.0
/src/Metadata/NotExposed.php
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

16
use ApiPlatform\OpenApi\Attributes\Webhook;
17
use ApiPlatform\OpenApi\Model\Operation as OpenApiOperation;
18
use ApiPlatform\State\OptionsInterface;
19

20
/**
21
 * A NotExposed operation is an operation declared for internal usage,
22
 * for example to generate an IRI on a resource without item operations.
23
 * It is ignored from OpenApi documentation and must return a HTTP 404.
24
 *
25
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
26
 */
27
#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
28
final class NotExposed extends HttpOperation
29
{
30
    /**
31
     * {@inheritdoc}
32
     */
33
    public function __construct(
34
        string $method = 'GET',
35
        ?string $uriTemplate = null,
36
        ?array $types = null,
37
        $formats = null,
38
        $inputFormats = null,
39
        $outputFormats = null,
40
        $uriVariables = null,
41
        ?string $routePrefix = null,
42
        ?string $routeName = null,
43
        ?array $defaults = null,
44
        ?array $requirements = null,
45
        ?array $options = null,
46
        ?bool $stateless = null,
47
        ?string $sunset = null,
48
        ?string $acceptPatch = null,
49
        $status = 404,
50
        ?string $host = null,
51
        ?array $schemes = null,
52
        ?string $condition = null,
53
        ?string $controller = 'api_platform.action.not_exposed',
54
        ?array $headers = null,
55
        ?array $cacheHeaders = null,
56
        ?array $paginationViaCursor = null,
57

58
        ?array $hydraContext = null,
59
        bool|OpenApiOperation|Webhook|null $openapi = false,
60
        ?array $exceptionToStatus = null,
61

62
        ?bool $queryParameterValidationEnabled = null,
63
        ?array $links = null,
64
        ?array $errors = null,
65

66
        ?string $shortName = null,
67
        ?string $class = null,
68
        ?bool $paginationEnabled = null,
69
        ?string $paginationType = null,
70
        ?int $paginationItemsPerPage = null,
71
        ?int $paginationMaximumItemsPerPage = null,
72
        ?bool $paginationPartial = null,
73
        ?bool $paginationClientEnabled = null,
74
        ?bool $paginationClientItemsPerPage = null,
75
        ?bool $paginationClientPartial = null,
76
        ?bool $paginationFetchJoinCollection = null,
77
        ?bool $paginationUseOutputWalkers = null,
78
        ?array $order = null,
79
        ?string $description = null,
80
        ?array $normalizationContext = null,
81
        ?array $denormalizationContext = null,
82
        ?bool $collectDenormalizationErrors = null,
83
        string|\Stringable|null $security = null,
84
        ?string $securityMessage = null,
85
        string|\Stringable|null $securityPostDenormalize = null,
86
        ?string $securityPostDenormalizeMessage = null,
87
        string|\Stringable|null $securityPostValidation = null,
88
        ?string $securityPostValidationMessage = null,
89
        ?string $deprecationReason = null,
90
        ?array $filters = null,
91
        ?array $validationContext = null,
92
        $input = null,
93
        $output = false,
94
        $mercure = null,
95
        $messenger = null,
96
        ?int $urlGenerationStrategy = null,
97
        ?bool $read = false,
98
        ?bool $deserialize = null,
99
        ?bool $validate = null,
100
        ?bool $write = null,
101
        ?bool $serialize = null,
102
        ?bool $fetchPartial = null,
103
        ?bool $forceEager = null,
104
        ?int $priority = null,
105
        ?string $name = null,
106
        $provider = null,
107
        $processor = null,
108
        array $extraProperties = [],
109
        ?OptionsInterface $stateOptions = null,
110
    ) {
111
        parent::__construct(
50✔
112
            method: $method,
50✔
113
            uriTemplate: $uriTemplate,
50✔
114
            types: $types,
50✔
115
            formats: $formats,
50✔
116
            inputFormats: $inputFormats,
50✔
117
            outputFormats: $outputFormats,
50✔
118
            uriVariables: $uriVariables,
50✔
119
            routePrefix: $routePrefix,
50✔
120
            routeName: $routeName,
50✔
121
            defaults: $defaults,
50✔
122
            requirements: $requirements,
50✔
123
            options: $options,
50✔
124
            stateless: $stateless,
50✔
125
            sunset: $sunset,
50✔
126
            acceptPatch: $acceptPatch,
50✔
127
            status: $status,
50✔
128
            host: $host,
50✔
129
            schemes: $schemes,
50✔
130
            condition: $condition,
50✔
131
            controller: $controller,
50✔
132
            headers: $headers,
50✔
133
            cacheHeaders: $cacheHeaders,
50✔
134
            paginationViaCursor: $paginationViaCursor,
50✔
135
            hydraContext: $hydraContext,
50✔
136
            openapi: $openapi,
50✔
137
            exceptionToStatus: $exceptionToStatus,
50✔
138
            queryParameterValidationEnabled: $queryParameterValidationEnabled,
50✔
139
            links: $links,
50✔
140
            errors: $errors,
50✔
141
            shortName: $shortName,
50✔
142
            class: $class,
50✔
143
            paginationEnabled: $paginationEnabled,
50✔
144
            paginationType: $paginationType,
50✔
145
            paginationItemsPerPage: $paginationItemsPerPage,
50✔
146
            paginationMaximumItemsPerPage: $paginationMaximumItemsPerPage,
50✔
147
            paginationPartial: $paginationPartial,
50✔
148
            paginationClientEnabled: $paginationClientEnabled,
50✔
149
            paginationClientItemsPerPage: $paginationClientItemsPerPage,
50✔
150
            paginationClientPartial: $paginationClientPartial,
50✔
151
            paginationFetchJoinCollection: $paginationFetchJoinCollection,
50✔
152
            paginationUseOutputWalkers: $paginationUseOutputWalkers,
50✔
153
            order: $order,
50✔
154
            description: $description,
50✔
155
            normalizationContext: $normalizationContext,
50✔
156
            denormalizationContext: $denormalizationContext,
50✔
157
            collectDenormalizationErrors: $collectDenormalizationErrors,
50✔
158
            security: $security,
50✔
159
            securityMessage: $securityMessage,
50✔
160
            securityPostDenormalize: $securityPostDenormalize,
50✔
161
            securityPostDenormalizeMessage: $securityPostDenormalizeMessage,
50✔
162
            securityPostValidation: $securityPostValidation,
50✔
163
            securityPostValidationMessage: $securityPostValidationMessage,
50✔
164
            deprecationReason: $deprecationReason,
50✔
165
            filters: $filters,
50✔
166
            validationContext: $validationContext,
50✔
167
            input: $input,
50✔
168
            output: $output,
50✔
169
            mercure: $mercure,
50✔
170
            messenger: $messenger,
50✔
171
            urlGenerationStrategy: $urlGenerationStrategy,
50✔
172
            read: $read,
50✔
173
            deserialize: $deserialize,
50✔
174
            validate: $validate,
50✔
175
            write: $write,
50✔
176
            serialize: $serialize,
50✔
177
            fetchPartial: $fetchPartial,
50✔
178
            forceEager: $forceEager,
50✔
179
            priority: $priority,
50✔
180
            name: $name,
50✔
181
            provider: $provider,
50✔
182
            processor: $processor,
50✔
183
            stateOptions: $stateOptions,
50✔
184
            extraProperties: $extraProperties,
50✔
185
        );
50✔
186
    }
187
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc