class ApiPlatform\Doctrine\Orm\Filter\AbstractFilter implements , `<a href="/docs/main/references/Doctrine/Common/Filter/PropertyAwareFilterInterface">ApiPlatform\Doctrine\Common\Filter\PropertyAwareFilterInterface</a>`, `<a href="/docs/main/references/Metadata/FilterInterface">ApiPlatform\Metadata\FilterInterface
{
public __construct(Doctrine\Persistence\ManagerRegistry $managerRegistry, null|Psr\Log\LoggerInterface $logger, null|array $properties, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter)
public apply(Doctrine\ORM\QueryBuilder $queryBuilder, $queryNameGenerator, string $resourceClass, null|`<a href="/docs/main/references/Metadata/Operation">ApiPlatform\Metadata\Operation $operation, array $context): null
protected filterProperty(string $property, $value, Doctrine\ORM\QueryBuilder $queryBuilder, $queryNameGenerator, string $resourceClass, null|`<a href="/docs/main/references/Metadata/Operation">ApiPlatform\Metadata\Operation $operation, array $context): null
protected getManagerRegistry(): Doctrine\Persistence\ManagerRegistry
protected getProperties(): array
protected getLogger(): Psr\Log\LoggerInterface
public setProperties(array<int, string> $properties): null
protected isPropertyEnabled(string $property, string $resourceClass): bool
protected denormalizePropertyName(string|int $property): string
protected normalizePropertyName(string $property): string
protected splitPropertyParts(string $property, string $resourceClass): array
protected getClassMetadata(string $resourceClass): Doctrine\Persistence\Mapping\ClassMetadata
protected addJoinsForNestedProperty(string $property, string $rootAlias, Doctrine\ORM\QueryBuilder $queryBuilder, ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $joinType): array
protected isPropertyMapped(string $property, string $resourceClass, bool $allowAssociation): bool
protected isPropertyNested(string $property, string $resourceClass): bool
protected isPropertyEmbedded(string $property, string $resourceClass): bool
protected getDoctrineFieldType(string $property, string $resourceClass): string
protected getNestedMetadata(string $resourceClass, array<int, string> $associations): Doctrine\Persistence\Mapping\ClassMetadata
public getDescription(string $resourceClass): array<string, array>
}
Psr\Log\LoggerInterface $logger
Doctrine\Persistence\ManagerRegistry $managerRegistry
array $properties
Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter
public __construct(Doctrine\Persistence\ManagerRegistry $managerRegistry, null|Psr\Log\LoggerInterface $logger, null|array $properties, null|Symfony\Component\Serializer\NameConverter\NameConverterInterface $nameConverter)
managerRegistry | Doctrine\Persistence\ManagerRegistry | |
logger | Psr\Log\LoggerInterface | |
properties | array | |
nameConverter | Symfony\Component\Serializer\NameConverter\NameConverterInterface |
Applies the filter.
public apply(Doctrine\ORM\QueryBuilder $queryBuilder, $queryNameGenerator, string $resourceClass, null|`<a href="/docs/main/references/Metadata/Operation">ApiPlatform\Metadata\Operation $operation, array $context): null
queryBuilder | Doctrine\ORM\QueryBuilder | |
queryNameGenerator | `ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface` | |
resourceClass | string | |
operation | `ApiPlatform\Metadata\Operation` | |
context | array |
null
Passes a property through the filter.
protected filterProperty(string $property, $value, Doctrine\ORM\QueryBuilder $queryBuilder, $queryNameGenerator, string $resourceClass, null|`<a href="/docs/main/references/Metadata/Operation">ApiPlatform\Metadata\Operation $operation, array $context): null
property | string | |
value | ||
queryBuilder | Doctrine\ORM\QueryBuilder | |
queryNameGenerator | `ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface` | |
resourceClass | string | |
operation | `ApiPlatform\Metadata\Operation` | |
context | array |
null
protected getManagerRegistry(): Doctrine\Persistence\ManagerRegistry
Doctrine\Persistence\ManagerRegistry
protected getProperties(): array
array
protected getLogger(): Psr\Log\LoggerInterface
Psr\Log\LoggerInterface
public setProperties(array<int, string> $properties): null
properties | array<int, string> |
null
Determines whether the given property is enabled.
protected isPropertyEnabled(string $property, string $resourceClass): bool
property | string | |
resourceClass | string |
bool
protected denormalizePropertyName(string|int $property): string
property | string int |
string
protected normalizePropertyName(string $property): string
property | string |
string
Splits the given property into parts.Returns an array with the following keys:
protected splitPropertyParts(string $property, string $resourceClass): array
property | string | |
resourceClass | string |
array
Gets class metadata for the given resource.
protected getClassMetadata(string $resourceClass): Doctrine\Persistence\Mapping\ClassMetadata
resourceClass | string |
Doctrine\Persistence\Mapping\ClassMetadata
Adds the necessary joins for a nested property.
protected addJoinsForNestedProperty(string $property, string $rootAlias, Doctrine\ORM\QueryBuilder $queryBuilder, ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $joinType): array
property | string | |
rootAlias | string | |
queryBuilder | Doctrine\ORM\QueryBuilder | |
queryNameGenerator | `ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface` | |
resourceClass | string | |
joinType | string |
array
Determines whether the given property is mapped.
protected isPropertyMapped(string $property, string $resourceClass, bool $allowAssociation): bool
property | string | |
resourceClass | string | |
allowAssociation | bool |
bool
Determines whether the given property is nested.
protected isPropertyNested(string $property, string $resourceClass): bool
property | string | |
resourceClass | string |
bool
Determines whether the given property is embedded.
protected isPropertyEmbedded(string $property, string $resourceClass): bool
property | string | |
resourceClass | string |
bool
Gets the Doctrine Type of a given property/resourceClass.
protected getDoctrineFieldType(string $property, string $resourceClass): string
property | string | |
resourceClass | string |
string
Gets nested class metadata for the given resource.
protected getNestedMetadata(string $resourceClass, array<int, string> $associations): Doctrine\Persistence\Mapping\ClassMetadata
resourceClass | string | |
associations | array<int, string> |
Doctrine\Persistence\Mapping\ClassMetadata
Made with love by
Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.
Learn more