Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sortable columns in module index, avoid [400] Unsupported sorting field #1213

Merged
merged 1 commit into from
Jan 2, 2025
+37 −80
Merged

Sortable columns in module index, avoid [400] Unsupported sorting field #1213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions src/View/Helper/SchemaHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,23 +312,22 @@ function ($carry, $item) {
*/
public function sortable(string $field): bool
{
// exception 'date_ranges' default sortable
if ($field === 'date_ranges') {
// default sortable fields
if (in_array($field, ['date_ranges', 'modified', 'id', 'title'])) {
return true;
}
$schema = (array)$this->_View->get('schema');
$schema = Hash::get($schema, sprintf('properties.%s', $field), []);

// empty schema, then not sortable
if (empty($schema)) {
return false;
}
$type = self::typeFromSchema($schema);

// not sortable: 'array', 'object'
// other types are sortable: 'string', 'number', 'integer', 'boolean', 'date-time', 'date'
// check from configuration Properties.%s.sortable
$name = Hash::get((array)$this->_View->get('currentModule'), 'name');
$sortable = (array)Configure::read(sprintf('Properties.%s.sortable', $name));

return !in_array($type, ['array', 'object']);
return in_array($field, $sortable);
}

/**
Expand Down
104 changes: 31 additions & 73 deletions tests/TestCase/View/Helper/SchemaHelperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -770,91 +770,47 @@ public function sortableProvider(): array
[],
false,
],
'string: sortable' => [
'dummy_string',
['type' => 'string'],
true,
],
'number: sortable' => [
'dummy_number',
['type' => 'number'],
true,
],
'integer: sortable' => [
'dummy_integer',
['type' => 'integer'],
true,
],
'boolean: sortable' => [
'dummy_boolean',
['type' => 'boolean'],
true,
],
'date-time: sortable' => [
'dummy_date-time',
['type' => 'date-time'],
true,
],
'date: sortable' => [
'dummy_date',
['type' => 'date'],
true,
],
'array: not sortable' => [
'dummy_array',
['type' => 'array'],
false,
],
'object: not sortable' => [
'dummy_object',
['type' => 'object'],
false,
],
'oneOf, string: sortable' => [
'dummy_oneof_string',
['oneOf' => [['type' => 'null'], ['type' => 'string']]],
true,
],
'oneOf, number: sortable' => [
'dummy_oneof_number',
['oneOf' => [['type' => 'null'], ['type' => 'number']]],
'date_ranges' => [
'date_ranges',
[],
true,
],
'oneOf, integer: sortable' => [
'dummy_oneof_integer',
['oneOf' => [['type' => 'null'], ['type' => 'integer']]],
'modified' => [
'modified',
[
'type' => 'string',
'format' => 'date-time',
],
true,
],
'oneOf, boolean: sortable' => [
'dummy_oneof_boolean',
['oneOf' => [['type' => 'null'], ['type' => 'boolean']]],
'id' => [
'id',
[
'type' => 'integer',
],
true,
],
'oneOf, date-time: sortable' => [
'dummy_oneof_date-time',
['oneOf' => [['type' => 'null'], ['type' => 'date-time']]],
'title' => [
'title',
[
'type' => 'string',
],
true,
],
'oneOf, date: sortable' => [
'dummy_oneof_date',
['oneOf' => [['type' => 'null'], ['type' => 'date']]],
'sortable from conf' => [
'dummy',
[
'type' => 'string',
],
true,
],
'oneOf, array: not sortable' => [
'dummy_oneof_array',
['oneOf' => [['type' => 'null'], ['type' => 'array']]],
false,
],
'oneOf, object: not sortable' => [
'dummy_oneof_object',
['oneOf' => [['type' => 'null'], ['type' => 'object']]],
'not sortable from conf' => [
'dummy2',
[
'type' => 'string',
],
false,
],
'date_ranges' => [
'date_ranges',
[],
true,
],
];
}

Expand All @@ -870,7 +826,9 @@ public function sortableProvider(): array
*/
public function testSortable(string $field, array $schema, bool $expected): void
{
Configure::write('Properties.dummies.sortable', ['dummy']);
$view = $this->Schema->getView();
$view->set('currentModule', ['name' => 'dummies']);
$view->set('schema', [
'properties' => [
$field => $schema,
Expand Down
Loading