api-platform / core

src/Bridge/Doctrine/Common/Filter/DateFilterTrait.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Bridge\Doctrine\Common\Filter;

use ApiPlatform\Core\Bridge\Doctrine\Common\PropertyHelperTrait;

/**
 * Trait for filtering the collection by date intervals.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Théo FIDRY <theo.fidry@gmail.com>
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
trait DateFilterTrait
{
    use PropertyHelperTrait;

    /**
     * {@inheritdoc}
     */
    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 => $nullManagement) {
            if (!$this->isPropertyMapped($property, $resourceClass) || !$this->isDateField($property, $resourceClass)) {
                continue;
            }

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

The constant ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterTrait::PARAMETER_BEFORE was not found. Maybe you did not declare it correctly or list all dependencies?

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

The constant ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterTrait::PARAMETER_STRICTLY_BEFORE was not found. Maybe you did not declare it correctly or list all dependencies?

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

The constant ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterTrait::PARAMETER_AFTER was not found. Maybe you did not declare it correctly or list all dependencies?

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

The constant ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterTrait::PARAMETER_STRICTLY_AFTER was not found. Maybe you did not declare it correctly or list all dependencies?

        }

        return $description;
    }

    abstract protected function getProperties(): ?array;

    abstract protected function normalizePropertyName($property);

    /**
     * Determines whether the given property refers to a date field.
     */
    protected function isDateField(string $property, string $resourceClass): bool
    {
        return isset(self::DOCTRINE_DATE_TYPES[(string) $this->getDoctrineFieldType($property, $resourceClass)]);

The constant ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterTrait::DOCTRINE_DATE_TYPES was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * Gets filter description.
     */
    protected function getFilterDescription(string $property, string $period): array
    {
        $propertyName = $this->normalizePropertyName($property);

        return [
            sprintf('%s[%s]', $propertyName, $period) => [
                'property' => $propertyName,
                'type' => \DateTimeInterface::class,
                'required' => false,
            ],
        ];
    }
}