Skip to content

Commit 12c4209

Browse files
soyukasoyuka
authored
feat(metadata): ability to hide an hydra class/operation (#6871)
1 parent be98f4e commit 12c4209

22 files changed

+173
-1
lines changed

‎src/Hydra/Serializer/DocumentationNormalizer.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ public function normalize(mixed $object, ?string $format = null, array $context
7575
continue;
7676
}
7777

78+
if (true === $resourceMetadata->getHideHydraOperation()) {
79+
continue;
80+
}
81+
7882
$shortName = $resourceMetadata->getShortName();
7983

8084
$prefixedShortName = $resourceMetadata->getTypes()[0] ?? "#$shortName";
@@ -243,6 +247,10 @@ private function getHydraOperations(bool $collection, ?ResourceMetadataCollectio
243247
$hydraOperations = [];
244248
foreach ($resourceMetadataCollection as $resourceMetadata) {
245249
foreach ($resourceMetadata->getOperations() as $operation) {
250+
if (true === $operation->getHideHydraOperation()) {
251+
continue;
252+
}
253+
246254
if (('POST' === $operation->getMethod() || $operation instanceof CollectionOperationInterface) !== $collection) {
247255
continue;
248256
}

‎src/Hydra/Serializer/EntrypointNormalizer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public function normalize(mixed $object, ?string $format = null, array $context
5656

5757
foreach ($resource->getOperations() as $operation) {
5858
$key = lcfirst($resource->getShortName());
59-
if (!$operation instanceof CollectionOperationInterface || isset($entrypoint[$key])) {
59+
if (true === $operation->getHideHydraOperation() || !$operation instanceof CollectionOperationInterface || isset($entrypoint[$key])) {
6060
continue;
6161
}
6262

‎src/Metadata/ApiResource.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -964,6 +964,7 @@ public function __construct(
964964
array|string|null $middleware = null,
965965
array|Parameters|null $parameters = null,
966966
protected ?bool $strictQueryParameterValidation = null,
967+
protected ?bool $hideHydraOperation = null,
967968
protected array $extraProperties = [],
968969
) {
969970
parent::__construct(
@@ -1009,6 +1010,7 @@ class: $class,
10091010
policy: $policy,
10101011
middleware: $middleware,
10111012
strictQueryParameterValidation: $strictQueryParameterValidation,
1013+
hideHydraOperation: $hideHydraOperation,
10121014
extraProperties: $extraProperties
10131015
);
10141016

‎src/Metadata/Delete.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ public function __construct(
9999
?string $policy = null,
100100
array|string|null $middleware = null,
101101
?bool $strictQueryParameterValidation = null,
102+
protected ?bool $hideHydraOperation = null,
102103
array $extraProperties = [],
103104
) {
104105
parent::__construct(
@@ -180,6 +181,7 @@ class: $class,
180181
collectDenormalizationErrors: $collectDenormalizationErrors,
181182
parameters: $parameters,
182183
strictQueryParameterValidation: $strictQueryParameterValidation,
184+
hideHydraOperation: $hideHydraOperation,
183185
stateOptions: $stateOptions,
184186
);
185187
}

‎src/Metadata/Extractor/XmlResourceExtractor.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ private function buildExtendedBase(\SimpleXMLElement $resource): array
9595
'exceptionToStatus' => $this->buildExceptionToStatus($resource),
9696
'queryParameterValidationEnabled' => $this->phpize($resource, 'queryParameterValidationEnabled', 'bool'),
9797
'strictQueryParameterValidation' => $this->phpize($resource, 'strictQueryParameterValidation', 'bool'),
98+
'hideHydraOperation' => $this->phpize($resource, 'hideHydraOperation', 'bool'),
9899
'stateOptions' => $this->buildStateOptions($resource),
99100
'links' => $this->buildLinks($resource),
100101
'headers' => $this->buildHeaders($resource),

‎src/Metadata/Extractor/YamlResourceExtractor.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,7 @@ private function buildOperations(array $resource, array $root): ?array
339339
'serialize' => $this->phpize($operation, 'serialize', 'bool'),
340340
'queryParameterValidate' => $this->phpize($operation, 'queryParameterValidate', 'bool'),
341341
'strictQueryParameterValidation' => $this->phpize($operation, 'strictQueryParameterValidation', 'bool'),
342+
'hideHydraOperation' => $this->phpize($resource, 'hideHydraOperation', 'bool'),
342343
'priority' => $this->phpize($operation, 'priority', 'integer'),
343344
'name' => $this->phpize($operation, 'name', 'string'),
344345
'class' => (string) $class,

‎src/Metadata/Extractor/schema/resources.xsd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,7 @@
516516
<xsd:attributeGroup name="extendedBase">
517517
<xsd:attributeGroup ref="base"/>
518518
<xsd:attribute type="xsd:boolean" name="strictQueryParameterValidation"/>
519+
<xsd:attribute type="xsd:boolean" name="hideHydraOperation"/>
519520
<xsd:attribute type="xsd:boolean" name="queryParameterValidationEnabled"/>
520521
<xsd:attribute type="xsd:string" name="routePrefix"/>
521522
<xsd:attribute type="xsd:boolean" name="stateless"/>

‎src/Metadata/Get.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ public function __construct(
9999
?string $policy = null,
100100
array|string|null $middleware = null,
101101
?bool $strictQueryParameterValidation = null,
102+
protected ?bool $hideHydraOperation = null,
102103
array $extraProperties = [],
103104
) {
104105
parent::__construct(
@@ -179,6 +180,7 @@ class: $class,
179180
policy: $policy,
180181
middleware: $middleware,
181182
strictQueryParameterValidation: $strictQueryParameterValidation,
183+
hideHydraOperation: $hideHydraOperation,
182184
extraProperties: $extraProperties,
183185
);
184186
}

‎src/Metadata/GetCollection.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ public function __construct(
9999
?string $policy = null,
100100
array|string|null $middleware = null,
101101
?bool $strictQueryParameterValidation = null,
102+
protected ?bool $hideHydraOperation = null,
102103
array $extraProperties = [],
103104
private ?string $itemUriTemplate = null,
104105
) {
@@ -180,6 +181,7 @@ class: $class,
180181
policy: $policy,
181182
middleware: $middleware,
182183
strictQueryParameterValidation: $strictQueryParameterValidation,
184+
hideHydraOperation: $hideHydraOperation,
183185
stateOptions: $stateOptions,
184186
);
185187
}

‎src/Metadata/HttpOperation.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ public function __construct(
156156
protected ?array $links = null,
157157
protected ?array $errors = null,
158158
protected ?bool $strictQueryParameterValidation = null,
159+
protected ?bool $hideHydraOperation = null,
159160

160161
?string $shortName = null,
161162
?string $class = null,
@@ -259,6 +260,7 @@ class: $class,
259260
middleware: $middleware,
260261
queryParameterValidationEnabled: $queryParameterValidationEnabled,
261262
strictQueryParameterValidation: $strictQueryParameterValidation,
263+
hideHydraOperation: $hideHydraOperation,
262264
extraProperties: $extraProperties
263265
);
264266
}

0 commit comments

Comments
 (0)