Symfony count range filter

Содержимое:

1 Пример использования:
2 Код фильтра

Пример использования:

#&#91;ApiFilter(CountRangeFilter::class, properties: &#91;'items.id'])]
private Collection $items;

1 2	#[ApiFilter(CountRangeFilter::class, properties: ['items.id'])] private Collection $items;

Код фильтра

declare(strict_types=1);

namespace App\Filter;

use Doctrine\ORM\QueryBuilder;
use Doctrine\ORM\Query\Expr\Join;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Doctrine\Orm\Filter\AbstractFilter;
use ApiPlatform\Doctrine\Common\Filter\RangeFilterTrait;
use ApiPlatform\Doctrine\Common\Filter\RangeFilterInterface;
use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;

final class CountRangeFilter extends AbstractFilter implements RangeFilterInterface
{
    use RangeFilterTrait;

    public function getDescription(string $resourceClass): array
    {
        $description = &#91;];

        $properties = $this->getProperties();
        if (null === $properties) {
            $properties = array_fill_keys($this->getClassMetadata($resourceClass)->getFieldNames(), null);
        }

        foreach ($properties as $property => $unused) {

            $description += $this->getFilterDescription($property, self::PARAMETER_BETWEEN);
            $description += $this->getFilterDescription($property, self::PARAMETER_GREATER_THAN);
            $description += $this->getFilterDescription($property, self::PARAMETER_GREATER_THAN_OR_EQUAL);
            $description += $this->getFilterDescription($property, self::PARAMETER_LESS_THAN);
            $description += $this->getFilterDescription($property, self::PARAMETER_LESS_THAN_OR_EQUAL);
        }

        return $description;
    }

    protected function getFilterDescription(string $fieldName, string $operator): array
    {
        $propertyName = $this->normalizePropertyName($fieldName);

        return &#91;
            sprintf('%s&#91;%s]', $propertyName . '_count', $operator) => &#91;
                'property' => $propertyName,
                'type' => 'string',
                'required' => false,
            ],
        ];
    }

    protected function filterProperty(string $property, $values, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, Operation $operation = null, array $context = &#91;]): void
    {
        $property = str_replace(&#91;"_count", "_"], &#91;"", "."], $property);
        if (
            !\is_array($values)
            || !$this->isPropertyEnabled($property, $resourceClass)
            || !$this->isPropertyMapped($property, $resourceClass)
        ) {
            return;
        }

        $values = $this->normalizeValues($values, $property);
        if (null === $values) {
            return;
        }

        $alias = $queryBuilder->getRootAliases()&#91;0];
        $field = $property;

        $queryBuilder->groupBy(sprintf('%s.id', $alias));

        if ($this->isPropertyNested($property, $resourceClass)) {
            &#91;$alias, $field] = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator, $resourceClass, Join::INNER_JOIN);
        }

        foreach ($values as $operator => $value) {
            $this->addWhere(
                $queryBuilder,
                $queryNameGenerator,
                $alias,
                $field,
                $operator,
                $value
            );
        }
    }

    /**
     * Adds the where clause according to the operator.
     */
    protected function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, string $operator, string $value): void
    {
        $valueParameter = $queryNameGenerator->generateParameterName($field);

        switch ($operator) {
            case self::PARAMETER_BETWEEN:
                $rangeValue = explode('..', $value);

                $rangeValue = $this->normalizeBetweenValues($rangeValue);
                if (null === $rangeValue) {
                    return;
                }

                if ($rangeValue&#91;0] === $rangeValue&#91;1]) {
                    $queryBuilder
                        ->andHaving(sprintf('COUNT(%s.%s) = :%s', $alias, $field, $valueParameter))
                        ->setParameter($valueParameter, $rangeValue&#91;0]);

                    return;
                }

                $queryBuilder
                    ->andHaving(sprintf('COUNT(%1$s.%2$s) BETWEEN :%3$s_1 AND :%3$s_2', $alias, $field, $valueParameter))
                    ->setParameter(sprintf('%s_1', $valueParameter), $rangeValue&#91;0])
                    ->setParameter(sprintf('%s_2', $valueParameter), $rangeValue&#91;1]);

                break;
            case self::PARAMETER_GREATER_THAN:
                $value = $this->normalizeValue($value, $operator);
                if (null === $value) {
                    return;
                }

                $queryBuilder
                    ->andHaving(sprintf('COUNT(%s.%s) > :%s', $alias, $field, $valueParameter))
                    ->setParameter($valueParameter, $value);

                break;
            case self::PARAMETER_GREATER_THAN_OR_EQUAL:
                $value = $this->normalizeValue($value, $operator);
                if (null === $value) {
                    return;
                }

                $queryBuilder
                    ->andHaving(sprintf('count(%s.%s) >= :%s', $alias, $field, $valueParameter))
                    ->setParameter($valueParameter, $value);

                break;
            case self::PARAMETER_LESS_THAN:
                $value = $this->normalizeValue($value, $operator);
                if (null === $value) {
                    return;
                }

                $queryBuilder
                    ->andHaving(sprintf('count(%s.%s) &lt; :%s', $alias, $field, $valueParameter))
                    ->setParameter($valueParameter, $value);

                break;
            case self::PARAMETER_LESS_THAN_OR_EQUAL:
                $value = $this->normalizeValue($value, $operator);
                if (null === $value) {
                    return;
                }

                $queryBuilder
                    ->andHaving(sprintf('count(%s.%s) &lt;= :%s', $alias, $field, $valueParameter))
                    ->setParameter($valueParameter, $value);

                break;
        }
    }

}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

declare(strict_types=1);

namespace App\Filter;

use Doctrine\ORM\QueryBuilder;

use Doctrine\ORM\Query\Expr\Join;

use ApiPlatform\Metadata\Operation;

use ApiPlatform\Doctrine\Orm\Filter\AbstractFilter;

use ApiPlatform\Doctrine\Common\Filter\RangeFilterTrait;

use ApiPlatform\Doctrine\Common\Filter\RangeFilterInterface;

use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;

final class CountRangeFilter extends AbstractFilter implements RangeFilterInterface

{

use RangeFilterTrait;

public function getDescription(string $resourceClass): array

{

$description = [];

$properties = $this->getProperties();

if (null === $properties) {

$properties = array_fill_keys($this->getClassMetadata($resourceClass)->getFieldNames(), null);

}

foreach ($properties as $property => $unused) {

$description += $this->getFilterDescription($property, self::PARAMETER_BETWEEN);

$description += $this->getFilterDescription($property, self::PARAMETER_GREATER_THAN);

$description += $this->getFilterDescription($property, self::PARAMETER_GREATER_THAN_OR_EQUAL);

$description += $this->getFilterDescription($property, self::PARAMETER_LESS_THAN);

$description += $this->getFilterDescription($property, self::PARAMETER_LESS_THAN_OR_EQUAL);

}

return $description;

}

protected function getFilterDescription(string $fieldName, string $operator): array

{

$propertyName = $this->normalizePropertyName($fieldName);

return [

sprintf('%s[%s]', $propertyName . '_count', $operator) => [

'property' => $propertyName,

'type' => 'string',

'required' => false,

];

}

protected function filterProperty(string $property, $values, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, Operation $operation = null, array $context = []): void

{

$property = str_replace(["_count", "_"], ["", "."], $property);

if (

!\is_array($values)

|| !$this->isPropertyEnabled($property, $resourceClass)

|| !$this->isPropertyMapped($property, $resourceClass)

) {

return;

}

$values = $this->normalizeValues($values, $property);

if (null === $values) {

return;

}

$alias = $queryBuilder->getRootAliases()[0];

$field = $property;

$queryBuilder->groupBy(sprintf('%s.id', $alias));

if ($this->isPropertyNested($property, $resourceClass)) {

[$alias, $field] = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator, $resourceClass, Join::INNER_JOIN);

}

foreach ($values as $operator => $value) {

$this->addWhere(

$queryBuilder,

$queryNameGenerator,

$alias,

$field,

$operator,

$value

);

}

/**

* Adds the where clause according to the operator.

protected function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, string $operator, string $value): void

{

$valueParameter = $queryNameGenerator->generateParameterName($field);

switch ($operator) {

case self::PARAMETER_BETWEEN:

$rangeValue = explode('..', $value);

$rangeValue = $this->normalizeBetweenValues($rangeValue);

if (null === $rangeValue) {

return;

}

if ($rangeValue[0] === $rangeValue[1]) {

$queryBuilder

->andHaving(sprintf('COUNT(%s.%s) = :%s', $alias, $field, $valueParameter))

->setParameter($valueParameter, $rangeValue[0]);

return;

}

$queryBuilder

->andHaving(sprintf('COUNT(%1$s.%2$s) BETWEEN :%3$s_1 AND :%3$s_2', $alias, $field, $valueParameter))

->setParameter(sprintf('%s_1', $valueParameter), $rangeValue[0])

->setParameter(sprintf('%s_2', $valueParameter), $rangeValue[1]);

break;

case self::PARAMETER_GREATER_THAN:

$value = $this->normalizeValue($value, $operator);

if (null === $value) {

return;

}

$queryBuilder

->andHaving(sprintf('COUNT(%s.%s) > :%s', $alias, $field, $valueParameter))

->setParameter($valueParameter, $value);

break;

case self::PARAMETER_GREATER_THAN_OR_EQUAL:

$value = $this->normalizeValue($value, $operator);

if (null === $value) {

return;

}

$queryBuilder

->andHaving(sprintf('count(%s.%s) >= :%s', $alias, $field, $valueParameter))

->setParameter($valueParameter, $value);

break;

case self::PARAMETER_LESS_THAN:

$value = $this->normalizeValue($value, $operator);

if (null === $value) {

return;

}

$queryBuilder

->andHaving(sprintf('count(%s.%s) < :%s', $alias, $field, $valueParameter))

->setParameter($valueParameter, $value);

break;

case self::PARAMETER_LESS_THAN_OR_EQUAL:

$value = $this->normalizeValue($value, $operator);

if (null === $value) {

return;

}

$queryBuilder

->andHaving(sprintf('count(%s.%s) <= :%s', $alias, $field, $valueParameter))

->setParameter($valueParameter, $value);

break;

}

Пример использования:

Код фильтра

Похожие записи: