ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\DateFilter::getDescription PHP Method

getDescription() public method

public getDescription ( string $resourceClass ) : array
$resourceClass string
return array
    public function getDescription(string $resourceClass) : array
    {
        $description = [];
        $properties = $this->properties;
        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);
            $description += $this->getFilterDescription($property, self::PARAMETER_AFTER);
        }
        return $description;
    }

Usage Example

Beispiel #1
0
 public function testGetDescription()
 {
     $filter = new DateFilter($this->managerRegistry, new RequestStack());
     $this->assertEquals(['dummyDate[before]' => ['property' => 'dummyDate', 'type' => 'DateTimeInterface', 'required' => false], 'dummyDate[after]' => ['property' => 'dummyDate', 'type' => 'DateTimeInterface', 'required' => false]], $filter->getDescription($this->resourceClass));
 }