/**
* {@inheritdoc}
*/
public function sort(DataSourceInterface $dataSource, Grid $grid, Parameters $parameters)
{
$expressionBuilder = $dataSource->getExpressionBuilder();
$sorting = $parameters->get('sorting', $grid->getSorting());
foreach ($sorting as $field => $order) {
$gridField = $grid->getField($field);
$property = $gridField->getSortable();
$expressionBuilder->addOrderBy($property, $order);
}
}
function it_throws_exception_when_trying_to_sort_by_a_non_sortable_field(Grid $gridDefinition, Field $nameField)
{
$gridDefinition->hasField('code')->willReturn(true);
$gridDefinition->hasField('name')->willReturn(true);
$gridDefinition->getField('name')->willReturn($nameField);
$nameField->isSortable()->willReturn(false);
$gridDefinition->getSorting()->willReturn(['code' => ['order' => 'asc']]);
$this->shouldThrow(\InvalidArgumentException::class)->during('isSortedBy', ['name']);
$this->shouldThrow(\InvalidArgumentException::class)->during('getSortingOrder', ['name']);
}
function it_sorts_the_data_source_via_expression_builder_based_on_sorting_parameter(Grid $grid, Field $nameField, DataSourceInterface $dataSource, ExpressionBuilderInterface $expressionBuilder)
{
$parameters = new Parameters(['sorting' => ['name' => 'asc']]);
$dataSource->getExpressionBuilder()->willReturn($expressionBuilder);
$grid->getSorting()->willReturn(['code' => 'desc']);
$grid->hasField('name')->willReturn(true);
$grid->getField('name')->willReturn($nameField);
$nameField->isSortable()->willReturn(true);
$nameField->getSortable()->willReturn('translation.name');
$expressionBuilder->addOrderBy('translation.name', 'asc')->shouldBeCalled();
$this->sort($dataSource, $grid, $parameters);
}
/**
* @param string $fieldName
*
* @throws \InvalidArgumentException
*/
private function assertFieldIsSortable($fieldName)
{
Assert::true($this->definition->hasField($fieldName), sprintf('Field "%s" does not exist.', $fieldName));
Assert::true($this->definition->getField($fieldName)->isSortable(), sprintf('Field "%s" is not sortable.', $fieldName));
}
