-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2062 from carlobeltrame/filter-schedule-entries-b…
…y-day Filter schedule entries by day
- Loading branch information
Showing
31 changed files
with
1,775 additions
and
404 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| <?php | ||
|
|
||
| namespace App\Doctrine\Filter; | ||
|
|
||
| use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterInterface; | ||
| use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterTrait; | ||
| use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter; | ||
| use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface; | ||
| use ApiPlatform\Core\Exception\InvalidArgumentException; | ||
| use Doctrine\ORM\QueryBuilder; | ||
|
|
||
| /** | ||
| * Filters a computed property on the collection by date intervals. | ||
| */ | ||
| class ExpressionDateFilter extends AbstractContextAwareFilter implements DateFilterInterface { | ||
| use DateFilterTrait; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getDescription(string $resourceClass): array { | ||
| $description = []; | ||
|
|
||
| $properties = $this->getProperties(); | ||
| if (null === $properties) { | ||
| $properties = []; | ||
| } | ||
|
|
||
| foreach ($properties as $property => $expression) { | ||
| if (!$expression) { | ||
| continue; | ||
| } | ||
|
|
||
| $description += $this->getFilterDescription($property, DateFilterInterface::PARAMETER_BEFORE); | ||
| $description += $this->getFilterDescription($property, DateFilterInterface::PARAMETER_STRICTLY_BEFORE); | ||
| $description += $this->getFilterDescription($property, DateFilterInterface::PARAMETER_AFTER); | ||
| $description += $this->getFilterDescription($property, DateFilterInterface::PARAMETER_STRICTLY_AFTER); | ||
| } | ||
|
|
||
| return $description; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function filterProperty( | ||
| string $property, | ||
| $values, | ||
| QueryBuilder $queryBuilder, | ||
| QueryNameGeneratorInterface $queryNameGenerator, | ||
| string $resourceClass, | ||
| string $operationName = null | ||
| ) { | ||
| if ( | ||
| !\is_array($values) | ||
| || !$this->isPropertyEnabled($property, $resourceClass) | ||
| ) { | ||
| return; | ||
| } | ||
|
|
||
| $alias = $queryBuilder->getRootAliases()[0]; | ||
| $field = $property; | ||
|
|
||
| $expression = $this->properties[$property] ?? null; | ||
|
|
||
| if (isset($values[DateFilterInterface::PARAMETER_BEFORE])) { | ||
| $this->addWhere( | ||
| $queryBuilder, | ||
| $queryNameGenerator, | ||
| $alias, | ||
| $field, | ||
| DateFilterInterface::PARAMETER_BEFORE, | ||
| $values[DateFilterInterface::PARAMETER_BEFORE], | ||
| $expression | ||
| ); | ||
| } | ||
|
|
||
| if (isset($values[DateFilterInterface::PARAMETER_STRICTLY_BEFORE])) { | ||
| $this->addWhere( | ||
| $queryBuilder, | ||
| $queryNameGenerator, | ||
| $alias, | ||
| $field, | ||
| DateFilterInterface::PARAMETER_STRICTLY_BEFORE, | ||
| $values[DateFilterInterface::PARAMETER_STRICTLY_BEFORE], | ||
| $expression | ||
| ); | ||
| } | ||
|
|
||
| if (isset($values[DateFilterInterface::PARAMETER_AFTER])) { | ||
| $this->addWhere( | ||
| $queryBuilder, | ||
| $queryNameGenerator, | ||
| $alias, | ||
| $field, | ||
| DateFilterInterface::PARAMETER_AFTER, | ||
| $values[DateFilterInterface::PARAMETER_AFTER], | ||
| $expression | ||
| ); | ||
| } | ||
|
|
||
| if (isset($values[DateFilterInterface::PARAMETER_STRICTLY_AFTER])) { | ||
| $this->addWhere( | ||
| $queryBuilder, | ||
| $queryNameGenerator, | ||
| $alias, | ||
| $field, | ||
| DateFilterInterface::PARAMETER_STRICTLY_AFTER, | ||
| $values[DateFilterInterface::PARAMETER_STRICTLY_AFTER], | ||
| $expression | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Adds the where clause based on the chosen expression. | ||
| */ | ||
| protected function addWhere( | ||
| QueryBuilder $queryBuilder, | ||
| QueryNameGeneratorInterface $queryNameGenerator, | ||
| string $alias, | ||
| string $field, | ||
| string $operator, | ||
| string $value, | ||
| string $expression | ||
| ) { | ||
| try { | ||
| $value = new \DateTime($value); | ||
| } catch (\Exception $e) { | ||
| // Silently ignore this filter if it can not be transformed to a \DateTime | ||
| $this->logger->notice('Invalid filter ignored', [ | ||
| 'exception' => new InvalidArgumentException(sprintf('The field "%s" has a wrong date format. Use one accepted by the \DateTime constructor', $field)), | ||
| ]); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| $valueParameter = $queryNameGenerator->generateParameterName($field); | ||
| $operatorValue = [ | ||
| DateFilterInterface::PARAMETER_BEFORE => '<=', | ||
| DateFilterInterface::PARAMETER_STRICTLY_BEFORE => '<', | ||
| DateFilterInterface::PARAMETER_AFTER => '>=', | ||
| DateFilterInterface::PARAMETER_STRICTLY_AFTER => '>', | ||
| ]; | ||
| $compiledExpression = $this->compileExpression($queryBuilder, $queryNameGenerator, $alias, $expression); | ||
| $baseWhere = sprintf('(%s) %s :%s', $compiledExpression, $operatorValue[$operator], $valueParameter); | ||
|
|
||
| $queryBuilder->andWhere($baseWhere); | ||
|
|
||
| $queryBuilder->setParameter($valueParameter, $value); | ||
| } | ||
|
|
||
| /** | ||
| * Replaces placeholders in the given expression and adds joins for them. | ||
| */ | ||
| protected function compileExpression( | ||
| QueryBuilder $queryBuilder, | ||
| QueryNameGeneratorInterface $queryNameGenerator, | ||
| string $alias, | ||
| string $expression | ||
| ): string { | ||
| // Replace {} with the alias of the current entity | ||
| $expression = preg_replace('/\{\}/', $alias, $expression); | ||
|
|
||
| // Add joins for all {xyz.abc} property references in the expression | ||
| $matches = []; | ||
| if (preg_match_all('/\{([^\}]+\.[^\}]+)\}/', $expression, $matches)) { | ||
| $relations = array_unique($matches[1] ?? []); | ||
|
|
||
| // Replace each instance of {xyz.abc} with its respective joined alias | ||
| foreach ($relations as $relation) { | ||
| [$joinAlias, $property] = $this->addJoinsForNestedProperty($relation, $alias, $queryBuilder, $queryNameGenerator); | ||
| $expression = preg_replace('/\{'.preg_quote($relation, '/').'\}/', "{$joinAlias}.{$property}", $expression); | ||
| } | ||
| } | ||
|
|
||
| return $expression; | ||
| } | ||
| } |
Oops, something went wrong.