ApiPlatform\Doctrine\Common\Filter\SearchFilterTrait

Trait for filtering the collection by given properties.

trait ApiPlatform\Doctrine\Common\Filter\SearchFilterTrait
{
    public getDescription(string $resourceClass): array
    protected getType(string $doctrineType): string
    protected getProperties(): array
    protected getLogger(): Psr\Log\LoggerInterface
    protected getIriConverter(): |`<a href="/docs/main/references/Api/IriConverterInterface">ApiPlatform\Metadata\IriConverterInterface
    protected getPropertyAccessor(): Symfony\Component\PropertyAccess\PropertyAccessorInterface
    protected normalizePropertyName(string $property): string
    protected getIdFromValue(string $value)
    protected normalizeValues(array $values, string $property): array
    protected hasValidValues(array $values, null|string $type): bool
    protected getClassMetadata(string $resourceClass): Doctrine\Persistence\Mapping\ClassMetadata
    protected isPropertyMapped(string $property, string $resourceClass, bool $allowAssociation): bool
    protected isPropertyNested(string $property, string $resourceClass): bool
    protected isPropertyEmbedded(string $property, string $resourceClass): bool
    protected splitPropertyParts(string $property, string $resourceClass): array
    protected getDoctrineFieldType(string $property, string $resourceClass): string
    protected getNestedMetadata(string $resourceClass, array<int, string> $associations): Doctrine\Persistence\Mapping\ClassMetadata
}

Properties

iriConverter

|`<a href="/docs/main/references/Api/IriConverterInterface">ApiPlatform\Api\IriConverterInterface $iriConverter

propertyAccessor

Symfony\Component\PropertyAccess\PropertyAccessorInterface $propertyAccessor

identifiersExtractor

|`<a href="/docs/main/references/Api/IdentifiersExtractorInterface">ApiPlatform\Api\IdentifiersExtractorInterface $identifiersExtractor

Methods

getDescription

public getDescription(string $resourceClass): array

Parameters

resourceClass

string

Returns

array

getType

Converts a Doctrine type in PHP type.

protected getType(string $doctrineType): string

Parameters

doctrineType

string

Returns

string

getProperties

protected getProperties(): array

Returns

array

getLogger

protected getLogger(): Psr\Log\LoggerInterface

Returns

Psr\Log\LoggerInterface

getIriConverter

protected getIriConverter(): |`<a href="/docs/main/references/Api/IriConverterInterface">ApiPlatform\Metadata\IriConverterInterface

Returns

<a href="/docs/main/references/Api/IriConverterInterface">ApiPlatform\Api\IriConverterInterface</a>
<a href="/docs/main/references/Api/IriConverterInterface">ApiPlatform\Metadata\IriConverterInterface</a>

getPropertyAccessor

protected getPropertyAccessor(): Symfony\Component\PropertyAccess\PropertyAccessorInterface

Returns

Symfony\Component\PropertyAccess\PropertyAccessorInterface

normalizePropertyName

protected normalizePropertyName(string $property): string

Parameters

property

string

Returns

string

getIdFromValue

Gets the ID from an IRI or a raw ID.

protected getIdFromValue(string $value)

Parameters

value

string

Returns

normalizeValues

Normalize the values array.

protected normalizeValues(array $values, string $property): array

Parameters

values	array
property	string

Returns

array

hasValidValues

When the field should be an integer, check that the given value is a valid one.

protected hasValidValues(array $values, null|string $type): bool

Parameters

values	array
type	string

Returns

bool

getClassMetadata

Gets class metadata for the given resource.

protected getClassMetadata(string $resourceClass): Doctrine\Persistence\Mapping\ClassMetadata

Parameters

resourceClass

string

Returns

Doctrine\Persistence\Mapping\ClassMetadata

isPropertyMapped

Determines whether the given property is mapped.

protected isPropertyMapped(string $property, string $resourceClass, bool $allowAssociation): bool

Parameters

property	string
resourceClass	string
allowAssociation	bool

Returns

bool

isPropertyNested

Determines whether the given property is nested.

protected isPropertyNested(string $property, string $resourceClass): bool

Parameters

property	string
resourceClass	string

Returns

bool

isPropertyEmbedded

Determines whether the given property is embedded.

protected isPropertyEmbedded(string $property, string $resourceClass): bool

Parameters

property	string
resourceClass	string

Returns

bool

splitPropertyParts

Splits the given property into parts.Returns an array with the following keys:

associations: array of associations according to nesting order
field: string holding the actual field (leaf node)

protected splitPropertyParts(string $property, string $resourceClass): array

Parameters

property	string
resourceClass	string

Returns

array

getDoctrineFieldType

Gets the Doctrine Type of a given property/resourceClass.

protected getDoctrineFieldType(string $property, string $resourceClass): string

Parameters

property	string
resourceClass	string

Returns

string

getNestedMetadata

Gets nested class metadata for the given resource.

protected getNestedMetadata(string $resourceClass, array<int, string> $associations): Doctrine\Persistence\Mapping\ClassMetadata

Parameters

resourceClass	string
associations	array<int, string>

Returns

Doctrine\Persistence\Mapping\ClassMetadata