Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Metadata/HeaderParameter.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

namespace ApiPlatform\Metadata;

#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE | \Attribute::TARGET_PROPERTY)]
class HeaderParameter extends Parameter implements HeaderParameterInterface
{
}
21 changes: 21 additions & 0 deletions src/Metadata/Parameter.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ abstract class Parameter
* @param ?bool $castToNativeType whether API Platform should cast your parameter to the nativeType declared
* @param ?callable(mixed): mixed $castFn the closure used to cast your parameter, this gets called only when $castToNativeType is set
* @param ?string $filterClass the class to use when resolving filter properties (from stateOptions)
* @param list<Operation>|null $operations a list of operations this parameter applies to (if null, applies to all operations)
*
* @phpstan-param array<string, mixed>|null $schema
*
Expand Down Expand Up @@ -70,6 +71,7 @@ public function __construct(
protected mixed $castFn = null,
protected mixed $default = null,
protected ?string $filterClass = null,
protected ?array $operations = null,
) {
}

Expand Down Expand Up @@ -410,4 +412,23 @@ public function withFilterClass(?string $filterClass): self

return $self;
}

/**
* @return list<Operation>|null
*/
public function getOperations(): ?array
{
return $this->operations;
}

/**
* @param list<Operation>|null $operations
*/
public function withOperations(?array $operations): self
{
$self = clone $this;
$self->operations = $operations;

return $self;
}
}
2 changes: 1 addition & 1 deletion src/Metadata/QueryParameter.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

namespace ApiPlatform\Metadata;

#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE | \Attribute::TARGET_PROPERTY)]
class QueryParameter extends Parameter implements QueryParameterInterface
{
}
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,10 @@ private function getDefaultParameters(Operation $operation, string $resourceClas
$propertyNames = $properties = [];
$parameters = $operation->getParameters() ?? new Parameters();

foreach ($this->createParametersFromAttributes($operation) as $key => $parameter) {
$parameters->add($key, $parameter);
}

// First loop we look for the :property placeholder and replace its key
foreach ($parameters as $key => $parameter) {
if (!str_contains($key, ':property')) {
Expand Down Expand Up @@ -470,4 +474,49 @@ private function getFilterInstance(object|string|null $filter): ?object

return $this->filterLocator->get($filter);
}

private function createParametersFromAttributes(Operation $operation): Parameters
{
$parameters = new Parameters();

if (null === $resourceClass = $operation->getClass()) {
return $parameters;
}

foreach ((new \ReflectionClass($resourceClass))->getProperties() as $reflectionProperty) {
foreach ($reflectionProperty->getAttributes(Parameter::class, \ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
$parameter = $attribute->newInstance();

if (
null !== ($parameterOperations = $parameter->getOperations())
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure about this, how would it work? Should we declare the parameter on all operations or maybe just GetCollection? Or is it that you give an array of operations to the parameter Parameter(operations: [GetCollection::class]) ? I haven't seen any functional test showing this functionality.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an array of operations to the parameter Parameter(operations: [GetCollection::class]). The operation must also be declared in the ApiResource operations array.

&& !\in_array(
$operation::class,
array_map(static fn ($parameterOperation) => $parameterOperation::class, $parameterOperations),
true
)
) {
continue;
}

$propertyName = $reflectionProperty->getName();
$key = $parameter->getKey() ?? $propertyName;
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no functional test for the default propertyName value can you add one?


if (null === $parameterPropertyName = $parameter->getProperty()) {
$parameter = $parameter->withProperty($propertyName);
} elseif ($parameterPropertyName !== $propertyName) {
throw new RuntimeException(\sprintf('Parameter attribute on property "%s" must target itself or have no explicit property. Got "property: \'%s\'" instead.', $propertyName, $parameterPropertyName));
}

if (null === ($parameterProperties = $parameter->getProperties()) || \in_array($propertyName, $parameterProperties, true)) {
$parameter = $parameter->withProperties([$propertyName]);
} elseif (!\in_array($propertyName, $parameterProperties, true)) {
throw new RuntimeException(\sprintf('Parameter attribute on property "%s" must target itself or have no explicit properties. Got "properties: [%s]" instead.', $propertyName, implode(', ', $parameterProperties)));
}

$parameters->add($key, $parameter);
}
}

return $parameters;
}
}
Loading
Loading