PHP Interface ApiPlatform\Core\Api\FilterInterface

Author: Kévin Dunglas ([email protected])
Show file Open project: api-platform/core

Public Methods

Method Description
getDescription ( string $resourceClass ) : array Gets the description of this filter for the given resource.

Method Details

getDescription() public method

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: the used strategy - swagger (optional): additional parameters for the path operation, e.g. 'swagger' => ['description' => 'My Description'] The description can contain additional data specific to a filter.
public getDescription ( string $resourceClass ) : array
$resourceClass string
return array