Skip to content

Use FilterData #1407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
franmomu wants to merge 2 commits into from
Closed

Use FilterData #1407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96525ea
Use FilterData
franmomu Apr 11, 2021
312e0f2
Use dev-master just to test FilterData
franmomu Apr 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"doctrine/doctrine-bundle": "^2.3",
"doctrine/orm": "^2.5",
"doctrine/persistence": "^2.0",
"sonata-project/admin-bundle": "^4.0@alpha",
"sonata-project/admin-bundle": "dev-master",
"sonata-project/exporter": "^2.0",
"sonata-project/form-extensions": "^1.4",
"symfony/config": "^4.4 || ^5.2",
Expand Down
53 changes: 28 additions & 25 deletions src/Filter/AbstractDateFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

namespace Sonata\DoctrineORMAdminBundle\Filter;

use Sonata\AdminBundle\Filter\Model\FilterData;
use Sonata\AdminBundle\Form\Type\Filter\DateRangeType;
use Sonata\AdminBundle\Form\Type\Filter\DateTimeRangeType;
use Sonata\AdminBundle\Form\Type\Filter\DateTimeType;
Expand Down Expand Up @@ -45,95 +46,97 @@ abstract class AbstractDateFilter extends Filter
*/
protected $time = false;

public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
public function filter(ProxyQueryInterface $query, string $alias, string $field, FilterData $data): void
{
// check data sanity
if (!\array_key_exists('value', $data)) {
if (!$data->hasValue()) {
return;
}

$value = $data->getValue();

if ($this->range) {
// additional data check for ranged items
if (!\array_key_exists('start', $data['value']) || !\array_key_exists('end', $data['value'])) {
if (!\array_key_exists('start', $value) || !\array_key_exists('end', $value)) {
return;
}

if (!$data['value']['start'] && !$data['value']['end']) {
if (!$value['start'] && !$value['end']) {
return;
}

// date filter should filter records for the whole days
if (false === $this->time && ($data['value']['end'] instanceof \DateTime || $data['value']['end'] instanceof \DateTimeImmutable)) {
if (false === $this->time && ($value['end'] instanceof \DateTime || $value['end'] instanceof \DateTimeImmutable)) {
// since the received `\DateTime` object uses the model timezone to represent
// the value submitted by the view (which can use a different timezone) and this
// value is intended to contain a time in the begining of a date (IE, if the model
// object is configured to use UTC timezone, the view object "2020-11-07 00:00:00.0-03:00"
// is transformed to "2020-11-07 03:00:00.0+00:00" in the model object), we increment
// the time part by adding "23:59:59" in order to cover the whole end date and get proper
// results from queries like "o.created_at <= :date_end".
$data['value']['end'] = $data['value']['end']->modify('+23 hours 59 minutes 59 seconds');
$value['end'] = $value['end']->modify('+23 hours 59 minutes 59 seconds');
}

// transform types
if ('timestamp' === $this->getOption('input_type')) {
$data['value']['start'] = $data['value']['start'] instanceof \DateTimeInterface ? $data['value']['start']->getTimestamp() : 0;
$data['value']['end'] = $data['value']['end'] instanceof \DateTimeInterface ? $data['value']['end']->getTimestamp() : 0;
$value['start'] = $value['start'] instanceof \DateTimeInterface ? $value['start']->getTimestamp() : 0;
$value['end'] = $value['end'] instanceof \DateTimeInterface ? $value['end']->getTimestamp() : 0;
}

// default type for range filter
$data['type'] = !isset($data['type']) || !is_numeric($data['type']) ? DateRangeOperatorType::TYPE_BETWEEN : $data['type'];
$type = $data->getType() ?? DateRangeOperatorType::TYPE_BETWEEN;

$startDateParameterName = $this->getNewParameterName($query);
$endDateParameterName = $this->getNewParameterName($query);

if (DateRangeOperatorType::TYPE_NOT_BETWEEN === $data['type']) {
if (DateRangeOperatorType::TYPE_NOT_BETWEEN === $type) {
$this->applyWhere($query, sprintf('%s.%s < :%s OR %s.%s > :%s', $alias, $field, $startDateParameterName, $alias, $field, $endDateParameterName));
} else {
if ($data['value']['start']) {
if ($value['start']) {
$this->applyWhere($query, sprintf('%s.%s %s :%s', $alias, $field, '>=', $startDateParameterName));
}

if ($data['value']['end']) {
if ($value['end']) {
$this->applyWhere($query, sprintf('%s.%s %s :%s', $alias, $field, '<=', $endDateParameterName));
}
}

if ($data['value']['start']) {
$query->getQueryBuilder()->setParameter($startDateParameterName, $data['value']['start']);
if ($value['start']) {
$query->getQueryBuilder()->setParameter($startDateParameterName, $value['start']);
}

if ($data['value']['end']) {
$query->getQueryBuilder()->setParameter($endDateParameterName, $data['value']['end']);
if ($value['end']) {
$query->getQueryBuilder()->setParameter($endDateParameterName, $value['end']);
}
} else {
if (!$data['value']) {
if (!$value) {
return;
}

// default type for simple filter
$data['type'] = $data['type'] ?? DateOperatorType::TYPE_EQUAL;
$type = $data->getType() ?? DateOperatorType::TYPE_EQUAL;

// just find an operator and apply query
$operator = $this->getOperator($data['type']);
$operator = $this->getOperator($type);

// transform types
if ('timestamp' === $this->getOption('input_type')) {
$data['value'] = $data['value'] instanceof \DateTimeInterface ? $data['value']->getTimestamp() : 0;
$value = $value instanceof \DateTimeInterface ? $value->getTimestamp() : 0;
}

$parameterName = $this->getNewParameterName($query);

// date filter should filter records for the whole day
if (false === $this->time && DateOperatorType::TYPE_EQUAL === $data['type']) {
if (false === $this->time && DateOperatorType::TYPE_EQUAL === $type) {
$this->applyWhere($query, sprintf('%s.%s %s :%s', $alias, $field, '>=', $parameterName));
$query->getQueryBuilder()->setParameter($parameterName, $data['value']);
$query->getQueryBuilder()->setParameter($parameterName, $value);

$endDateParameterName = $this->getNewParameterName($query);
$this->applyWhere($query, sprintf('%s.%s %s :%s', $alias, $field, '<', $endDateParameterName));
if ('timestamp' === $this->getOption('input_type')) {
$endValue = strtotime('+1 day', $data['value']);
$endValue = strtotime('+1 day', $value);
} else {
$endValue = clone $data['value'];
$endValue = clone $value;
$endValue->add(new \DateInterval('P1D'));
}
$query->getQueryBuilder()->setParameter($endDateParameterName, $endValue);
Expand All @@ -142,7 +145,7 @@ public function filter(ProxyQueryInterface $query, string $alias, string $field,
}

$this->applyWhere($query, sprintf('%s.%s %s :%s', $alias, $field, $operator, $parameterName));
$query->getQueryBuilder()->setParameter($parameterName, $data['value']);
$query->getQueryBuilder()->setParameter($parameterName, $value);
}
}

Expand Down
15 changes: 9 additions & 6 deletions src/Filter/BooleanFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,25 @@

namespace Sonata\DoctrineORMAdminBundle\Filter;

use Sonata\AdminBundle\Filter\Model\FilterData;
use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQueryInterface;
use Sonata\Form\Type\BooleanType;
use Symfony\Component\Form\Extension\Core\Type\HiddenType;

final class BooleanFilter extends Filter
{
public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
public function filter(ProxyQueryInterface $query, string $alias, string $field, FilterData $data): void
{
if (!\array_key_exists('type', $data) || !\array_key_exists('value', $data)) {
if (!$data->hasValue()) {
return;
}

if (\is_array($data['value'])) {
$value = $data->getValue();

if (\is_array($value)) {
$values = [];
foreach ($data['value'] as $v) {
foreach ($value as $v) {
if (!\in_array($v, [BooleanType::TYPE_NO, BooleanType::TYPE_YES], true)) {
continue;
}
Expand All @@ -42,13 +45,13 @@ public function filter(ProxyQueryInterface $query, string $alias, string $field,

$this->applyWhere($query, $query->getQueryBuilder()->expr()->in(sprintf('%s.%s', $alias, $field), $values));
} else {
if (!\in_array($data['value'], [BooleanType::TYPE_NO, BooleanType::TYPE_YES], true)) {
if (!\in_array($value, [BooleanType::TYPE_NO, BooleanType::TYPE_YES], true)) {
return;
}

$parameterName = $this->getNewParameterName($query);
$this->applyWhere($query, sprintf('%s.%s = :%s', $alias, $field, $parameterName));
$query->getQueryBuilder()->setParameter($parameterName, (BooleanType::TYPE_YES === $data['value']) ? 1 : 0);
$query->getQueryBuilder()->setParameter($parameterName, (BooleanType::TYPE_YES === $value) ? 1 : 0);
}
}

Expand Down
5 changes: 3 additions & 2 deletions src/Filter/CallbackFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,15 @@

namespace Sonata\DoctrineORMAdminBundle\Filter;

use Sonata\AdminBundle\Filter\Model\FilterData;
use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQueryInterface;
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
use Symfony\Component\Form\Extension\Core\Type\TextType;

final class CallbackFilter extends Filter
{
public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
public function filter(ProxyQueryInterface $query, string $alias, string $field, FilterData $data): void
{
if (!\is_callable($this->getOption('callback'))) {
throw new \RuntimeException(sprintf('Please provide a valid callback option "filter" for field "%s"', $this->getName()));
Expand Down Expand Up @@ -58,7 +59,7 @@ public function getRenderSettings(): array
]];
}

protected function association(ProxyQueryInterface $query, array $data): array
protected function association(ProxyQueryInterface $query, FilterData $data): array
{
$alias = $query->entityJoin($this->getParentAssociationMappings());

Expand Down
41 changes: 16 additions & 25 deletions src/Filter/ChoiceFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,20 @@

namespace Sonata\DoctrineORMAdminBundle\Filter;

use Sonata\AdminBundle\Filter\Model\FilterData;
use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
use Sonata\AdminBundle\Form\Type\Operator\EqualOperatorType;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQueryInterface;

final class ChoiceFilter extends Filter
{
public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
public function filter(ProxyQueryInterface $query, string $alias, string $field, FilterData $data): void
{
if (!\array_key_exists('type', $data) || !\array_key_exists('value', $data)) {
if (!$data->hasValue()) {
return;
}

if (\is_array($data['value'])) {
if (\is_array($data->getValue())) {
$this->filterWithMultipleValues($query, $alias, $field, $data);
} else {
$this->filterWithSingleValue($query, $alias, $field, $data);
Expand All @@ -51,23 +52,18 @@ public function getRenderSettings(): array
]];
}

/**
* @param mixed[] $data
*
* @phpstan-param array{type: int|null, value: mixed} $data
*/
private function filterWithMultipleValues(ProxyQueryInterface $query, string $alias, string $field, array $data): void
private function filterWithMultipleValues(ProxyQueryInterface $query, string $alias, string $field, FilterData $data): void
{
if (0 === \count($data['value'])) {
if (0 === \count($data->getValue())) {
return;
}

$isNullSelected = \in_array(null, $data['value'], true);
$isNullSelected = \in_array(null, $data->getValue(), true);
$completeField = sprintf('%s.%s', $alias, $field);
$parameterName = $this->getNewParameterName($query);

$or = $query->getQueryBuilder()->expr()->orX();
if (EqualOperatorType::TYPE_NOT_EQUAL === $data['type']) {
if ($data->isType(EqualOperatorType::TYPE_NOT_EQUAL)) {
$or->add($query->getQueryBuilder()->expr()->notIn($completeField, ':'.$parameterName));

if (!$isNullSelected) {
Expand All @@ -82,39 +78,34 @@ private function filterWithMultipleValues(ProxyQueryInterface $query, string $al
}

$this->applyWhere($query, $or);
$query->getQueryBuilder()->setParameter($parameterName, $data['value']);
$query->getQueryBuilder()->setParameter($parameterName, $data->getValue());
}

/**
* @param mixed[] $data
*
* @phpstan-param array{type: int|null, value: mixed} $data
*/
private function filterWithSingleValue(ProxyQueryInterface $query, string $alias, string $field, array $data): void
private function filterWithSingleValue(ProxyQueryInterface $query, string $alias, string $field, FilterData $data): void
{
if ('' === $data['value'] || false === $data['value']) {
if ('' === $data->getValue() || false === $data->getValue()) {
return;
}

$parameterName = $this->getNewParameterName($query);
$completeField = sprintf('%s.%s', $alias, $field);

if (EqualOperatorType::TYPE_NOT_EQUAL === $data['type']) {
if (null === $data['value']) {
if ($data->isType(EqualOperatorType::TYPE_NOT_EQUAL)) {
if (null === $data->getValue()) {
$this->applyWhere($query, $query->getQueryBuilder()->expr()->isNotNull($completeField));
} else {
$this->applyWhere(
$query,
sprintf('%s != :%s OR %s IS NULL', $completeField, $parameterName, $completeField)
);
$query->getQueryBuilder()->setParameter($parameterName, $data['value']);
$query->getQueryBuilder()->setParameter($parameterName, $data->getValue());
}
} else {
if (null === $data['value']) {
if (null === $data->getValue()) {
$this->applyWhere($query, $query->getQueryBuilder()->expr()->isNull($completeField));
} else {
$this->applyWhere($query, sprintf('%s = :%s', $completeField, $parameterName));
$query->getQueryBuilder()->setParameter($parameterName, $data['value']);
$query->getQueryBuilder()->setParameter($parameterName, $data->getValue());
}
}
}
Expand Down
11 changes: 6 additions & 5 deletions src/Filter/ClassFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

namespace Sonata\DoctrineORMAdminBundle\Filter;

use Sonata\AdminBundle\Filter\Model\FilterData;
use Sonata\AdminBundle\Form\Type\Filter\DefaultType;
use Sonata\AdminBundle\Form\Type\Operator\EqualOperatorType;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQueryInterface;
Expand All @@ -25,20 +26,20 @@ final class ClassFilter extends Filter
EqualOperatorType::TYPE_NOT_EQUAL => 'NOT INSTANCE OF',
];

public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
public function filter(ProxyQueryInterface $query, string $alias, string $field, FilterData $data): void
{
if (!\array_key_exists('value', $data)) {
if (!$data->hasValue()) {
return;
}

if (0 === \strlen($data['value'])) {
if (0 === \strlen($data->getValue())) {
return;
}

$type = $data['type'] ?? EqualOperatorType::TYPE_EQUAL;
$type = $data->getType() ?? EqualOperatorType::TYPE_EQUAL;
$operator = $this->getOperator($type);

$this->applyWhere($query, sprintf('%s %s %s', $alias, $operator, $data['value']));
$this->applyWhere($query, sprintf('%s %s %s', $alias, $operator, $data->getValue()));
}

public function getDefaultOptions(): array
Expand Down
9 changes: 5 additions & 4 deletions src/Filter/CountFilter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

namespace Sonata\DoctrineORMAdminBundle\Filter;

use Sonata\AdminBundle\Filter\Model\FilterData;
use Sonata\AdminBundle\Form\Type\Filter\NumberType;
use Sonata\AdminBundle\Form\Type\Operator\NumberOperatorType;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQueryInterface;
Expand All @@ -28,21 +29,21 @@ final class CountFilter extends Filter
NumberOperatorType::TYPE_LESS_THAN => '<',
];

public function filter(ProxyQueryInterface $query, string $alias, string $field, array $data): void
public function filter(ProxyQueryInterface $query, string $alias, string $field, FilterData $data): void
{
if (!\array_key_exists('value', $data) || !is_numeric($data['value'])) {
if (!$data->hasValue() || !is_numeric($data->getValue())) {
return;
}

$type = $data['type'] ?? NumberOperatorType::TYPE_EQUAL;
$type = $data->getType() ?? NumberOperatorType::TYPE_EQUAL;
$operator = $this->getOperator($type);

// c.name > '1' => c.name OPERATOR :FIELDNAME
$parameterName = $this->getNewParameterName($query);
$rootAlias = current($query->getQueryBuilder()->getRootAliases());
$query->getQueryBuilder()->addGroupBy($rootAlias);
$this->applyHaving($query, sprintf('COUNT(%s.%s) %s :%s', $alias, $field, $operator, $parameterName));
$query->getQueryBuilder()->setParameter($parameterName, $data['value']);
$query->getQueryBuilder()->setParameter($parameterName, $data->getValue());
}

public function getDefaultOptions(): array
Expand Down
Loading