ApiPlatform\Doctrine\Common\Filter\BooleanFilterTrait

Trait for filtering the collection by boolean values.

Filters collection on equality of boolean properties. The value is specified as one of ( “true” | “false” | “1” | “0” ) in the query.

For each property passed, if the resource does not have such property or if the value is not one of ( “true” | “false” | “1” | “0” ) the property is ignored.

trait ApiPlatform\Doctrine\Common\Filter\BooleanFilterTrait
{
    public getDescription(string $resourceClass): array
    protected getProperties(): array
    protected getLogger(): Psr\Log\LoggerInterface
    protected normalizePropertyName(string $property): string
    protected isBooleanField(string $property, string $resourceClass): 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
}

Methods

getDescription

public getDescription(string $resourceClass): array

Parameters

resourceClass

string

Returns

array

getProperties

protected getProperties(): array

Returns

array

getLogger

protected getLogger(): Psr\Log\LoggerInterface

Returns

Psr\Log\LoggerInterface

normalizePropertyName

protected normalizePropertyName(string $property): string

Parameters

property

string

Returns

string

isBooleanField

Determines whether the given property refers to a boolean field.

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

Parameters

property	string
resourceClass	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