PHP Класс ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\OrderFilter

The ordering is done in the same sequence as they are specified in the query, and for each property a direction value can be specified. For each property passed, if the resource does not have such property or if the direction value is different from "asc" or "desc" (case insensitive), the property is ignored.

Автор: Kévin Dunglas ([email protected])

Автор: Théo FIDRY ([email protected])

Наследование: extends AbstractFilter

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$orderParameterName		Keyword used to retrieve the value

Открытые методы

Метод	Описание
__construct ( Doctrine\Common\Persistence\ManagerRegistry $managerRegistry, Symfony\Component\HttpFoundation\RequestStack $requestStack, string $orderParameterName, Psr\Log\LoggerInterface $logger = null, array $properties = null )
getDescription ( string $resourceClass ) : array

Защищенные методы

Метод	Описание
extractProperties ( Request $request ) : array
filterProperty ( string $property, $direction, Doctrine\ORM\QueryBuilder $queryBuilder, ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null )

Описание методов

__construct() публичный метод

public __construct ( Doctrine\Common\Persistence\ManagerRegistry $managerRegistry, Symfony\Component\HttpFoundation\RequestStack $requestStack, string $orderParameterName, Psr\Log\LoggerInterface $logger = null, array $properties = null )
$managerRegistry	Doctrine\Common\Persistence\ManagerRegistry
$requestStack	Symfony\Component\HttpFoundation\RequestStack
$orderParameterName	string
$logger	Psr\Log\LoggerInterface
$properties	array

extractProperties() защищенный метод

protected extractProperties ( Request $request ) : array
$request	Symfony\Component\HttpFoundation\Request
Результат	array

filterProperty() защищенный метод

protected filterProperty ( string $property, $direction, Doctrine\ORM\QueryBuilder $queryBuilder, ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null )
$property	string
$queryBuilder	Doctrine\ORM\QueryBuilder
$queryNameGenerator	ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface
$resourceClass	string
$operationName	string

getDescription() публичный метод

public getDescription ( string $resourceClass ) : array
$resourceClass	string
Результат	array

Описание свойств

$orderParameterName защищенное свойство

Keyword used to retrieve the value

protected $orderParameterName