ApiPlatform\Doctrine\Common\Filter\DateFilterTrait

Trait for filtering the collection by date intervals.

trait ApiPlatform\Doctrine\Common\Filter\DateFilterTrait
{
    public getDescription(string $resourceClass): array
    protected getProperties(): array
    protected normalizePropertyName(string $property): string
    protected isDateField(string $property, string $resourceClass): bool
    protected getFilterDescription(string $property, string $period): array
    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
}

Methods

getDescription

public getDescription(string $resourceClass): array

Parameters

resourceClass

string

Returns

array

getProperties

protected getProperties(): array

Returns

array

normalizePropertyName

protected normalizePropertyName(string $property): string

Parameters

property

string

Returns

string

isDateField

Determines whether the given property refers to a date field.

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

Parameters

property	string
resourceClass	string

Returns

bool

getFilterDescription

Gets filter description.

protected getFilterDescription(string $property, string $period): array

Parameters

property	string
period	string

Returns

array

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