ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\OrderFilter::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 => $defaultDirection) {
            if (!$this->isPropertyMapped($property, $resourceClass)) {
                continue;
            }
            $description[sprintf('%s[%s]', $this->orderParameterName, $property)] = ['property' => $property, 'type' => 'string', 'required' => false];
        }
        return $description;
    }

Usage Example

Ejemplo n.º 1
0
 public function testGetDescriptionDefaultFields()
 {
     $filter = new OrderFilter($this->managerRegistry, new RequestStack(), 'order');
     $this->assertEquals(['order[id]' => ['property' => 'id', 'type' => 'string', 'required' => false], 'order[name]' => ['property' => 'name', 'type' => 'string', 'required' => false], 'order[alias]' => ['property' => 'alias', 'type' => 'string', 'required' => false], 'order[description]' => ['property' => 'description', 'type' => 'string', 'required' => false], 'order[dummy]' => ['property' => 'dummy', 'type' => 'string', 'required' => false], 'order[dummyDate]' => ['property' => 'dummyDate', 'type' => 'string', 'required' => false], 'order[dummyFloat]' => ['property' => 'dummyFloat', 'type' => 'string', 'required' => false], 'order[dummyPrice]' => ['property' => 'dummyPrice', 'type' => 'string', 'required' => false], 'order[jsonData]' => ['property' => 'jsonData', 'type' => 'string', 'required' => false], 'order[nameConverted]' => ['property' => 'nameConverted', 'type' => 'string', 'required' => false], 'order[dummyBoolean]' => ['property' => 'dummyBoolean', 'type' => 'string', 'required' => false]], $filter->getDescription($this->resourceClass));
 }