Skip to content

Commit 7b5b664

Browse files
brandonkellybrandonkelly
committed
Sortable entry types and fields
1 parent e121d28 commit 7b5b664

File tree

8 files changed

+74
-18
lines changed

8 files changed

+74
-18
lines changed

‎CHANGELOG-WIP.md

+2
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@
2929
- Entry types are no longer required to have unique names. ([#14774](https://github.com/craftcms/cms/issues/14774), [#15438](https://github.com/craftcms/cms/pull/15438))
3030
- Entry type selects within section and Matrix/CKEditor field settings now display entry types’ handles in addition to their names, to avoid ambiguity. ([#15438](https://github.com/craftcms/cms/pull/15438))
3131
- The Entry Types index page now displays entry type chips in place of plain text labels, so their custom colors are shown. ([#15432](https://github.com/craftcms/cms/discussions/15432))
32+
- The Entry Types index table can now be sorted by Name and Handle.
33+
- The Fields index table can now be sorted by Name, Handle, and Type.
3234
- Icon fields now have an “Include Pro icons” setting, which determines whether Font Awesome Pro icon should be selectable. ([#15242](https://github.com/craftcms/cms/issues/15242))
3335
- New sites’ Base URL settings now default to an environment variable name based on the site name. ([#15347](https://github.com/craftcms/cms/pull/15347))
3436
- Craft now warns against using the `@web` alias for URL settings, regardless of whether it was explicitly defined. ([#15347](https://github.com/craftcms/cms/pull/15347))

‎CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
## Unreleased (5.3.0)
44

55
- Double-clicking on element index rows no longer opens the element editor slideout, when inline editing is active. ([#15441](https://github.com/craftcms/cms/discussions/15441))
6+
- The Entry Types index table can now be sorted by Name and Handle.
7+
- The Fields index table can now be sorted by Name, Handle, and Type.
68
- Country field values are now set to `CommerceGuys\Addressing\Country\Country` objects. ([#15455](https://github.com/craftcms/cms/issues/15455), [#15463](https://github.com/craftcms/cms/pull/15463))
79
- `x-craft-preview`/`x-craft-live-preview` URL query string params are now added to generated URLs for Live Preview requests, so `craft\web\Request::getIsPreview()` continues to return `true` on subsequent pages loaded within the iframe. ([#15447](https://github.com/craftcms/cms/discussions/15447))
810
- The `fields/merge` command now clears out Label, Handle, and Instructions overrides, if the persisting field’s values match the overridden values.

‎src/controllers/EntryTypesController.php

+10-2
Original file line numberDiff line numberDiff line change
@@ -233,8 +233,16 @@ public function actionTableData(): Response
233233
$page = (int)$this->request->getParam('page', 1);
234234
$limit = (int)$this->request->getParam('per_page', 100);
235235
$searchTerm = $this->request->getParam('search');
236-
237-
[$pagination, $tableData] = $entriesService->getTableData($page, $limit, $searchTerm);
236+
$orderBy = match ($this->request->getParam('sort.0.field')) {
237+
'__slot:handle' => 'handle',
238+
default => 'name',
239+
};
240+
$sortDir = match ($this->request->getParam('sort.0.direction')) {
241+
'desc' => SORT_DESC,
242+
default => SORT_ASC,
243+
};
244+
245+
[$pagination, $tableData] = $entriesService->getTableData($page, $limit, $searchTerm, $orderBy, $sortDir);
238246

239247
return $this->asSuccess(data: [
240248
'pagination' => $pagination,

‎src/controllers/FieldsController.php

+11-2
Original file line numberDiff line numberDiff line change
@@ -517,8 +517,17 @@ public function actionTableData(): Response
517517
$page = (int)$this->request->getParam('page', 1);
518518
$limit = (int)$this->request->getParam('per_page', 100);
519519
$searchTerm = $this->request->getParam('search');
520-
521-
[$pagination, $tableData] = $fieldsService->getTableData($page, $limit, $searchTerm);
520+
$orderBy = match ($this->request->getParam('sort.0.field')) {
521+
'__slot:handle' => 'handle',
522+
'type' => 'type',
523+
default => 'name',
524+
};
525+
$sortDir = match ($this->request->getParam('sort.0.direction')) {
526+
'desc' => SORT_DESC,
527+
default => SORT_ASC,
528+
};
529+
530+
[$pagination, $tableData] = $fieldsService->getTableData($page, $limit, $searchTerm, $orderBy, $sortDir);
522531

523532
return $this->asSuccess(data: [
524533
'pagination' => $pagination,

‎src/services/Entries.php

+15-7
Original file line numberDiff line numberDiff line change
@@ -1657,16 +1657,28 @@ public function refreshEntryTypes(): void
16571657
* @param int $page
16581658
* @param int $limit
16591659
* @param string|null $searchTerm
1660+
* @param string $orderBy
1661+
* @param int $sortDir
16601662
* @return array
16611663
* @since 5.0.0
16621664
* @internal
16631665
*/
1664-
public function getTableData(int $page, int $limit, ?string $searchTerm): array
1665-
{
1666+
public function getTableData(
1667+
int $page,
1668+
int $limit,
1669+
?string $searchTerm,
1670+
string $orderBy = 'name',
1671+
int $sortDir = SORT_ASC,
1672+
): array {
16661673
$searchTerm = $searchTerm ? trim($searchTerm) : $searchTerm;
16671674

16681675
$offset = ($page - 1) * $limit;
1669-
$query = $this->_createEntryTypeQuery();
1676+
$query = $this->_createEntryTypeQuery()
1677+
->orderBy([$orderBy => $sortDir]);
1678+
1679+
if ($orderBy === 'name') {
1680+
$query->addOrderBy(['name' => $sortDir]);
1681+
}
16701682

16711683
if ($searchTerm !== null && $searchTerm !== '') {
16721684
$searchParams = $this->_getSearchParams($searchTerm);
@@ -1687,10 +1699,6 @@ public function getTableData(int $page, int $limit, ?string $searchTerm): array
16871699
array_map(fn(array $result) => $this->_entryTypes()->firstWhere('id', $result['id']), $results)
16881700
));
16891701

1690-
usort($entryTypes,
1691-
fn(EntryType $a, EntryType $b) => Craft::t('site', $a->name) <=> Craft::t('site', $b->name)
1692-
);
1693-
16941702
$tableData = [];
16951703
foreach ($entryTypes as $entryType) {
16961704
$label = $entryType->getUiLabel();

‎src/services/Fields.php

+28-2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
use craft\base\FieldLayoutElement;
1616
use craft\base\MemoizableArray;
1717
use craft\behaviors\CustomFieldBehavior;
18+
use craft\db\FixedOrderExpression;
1819
use craft\db\Query;
1920
use craft\db\Table;
2021
use craft\errors\MissingComponentException;
@@ -63,6 +64,7 @@
6364
use craft\records\Field as FieldRecord;
6465
use craft\records\FieldLayout as FieldLayoutRecord;
6566
use DateTime;
67+
use Illuminate\Support\Collection;
6668
use Throwable;
6769
use yii\base\Component;
6870
use yii\base\Exception;
@@ -1406,18 +1408,42 @@ public function applyFieldSave(string $fieldUid, array $data, string $context):
14061408
* @param int $page
14071409
* @param int $limit
14081410
* @param string|null $searchTerm
1411+
* @param string $orderBy
1412+
* @param int $sortDir
14091413
* @return array
14101414
* @since 5.0.0
14111415
* @internal
14121416
*/
1413-
public function getTableData(int $page, int $limit, ?string $searchTerm): array
1414-
{
1417+
public function getTableData(
1418+
int $page,
1419+
int $limit,
1420+
?string $searchTerm,
1421+
string $orderBy = 'name',
1422+
int $sortDir = SORT_ASC,
1423+
): array {
14151424
$searchTerm = $searchTerm ? trim($searchTerm) : $searchTerm;
14161425

14171426
$offset = ($page - 1) * $limit;
14181427
$query = $this->_createFieldQuery()
14191428
->andWhere(['context' => 'global']);
14201429

1430+
if ($orderBy === 'type') {
1431+
/** @var Collection<class-string<FieldInterface>> $types */
1432+
$types = Collection::make($this->getAllFieldTypes())
1433+
->sortBy(fn(string $class) => $class::displayName());
1434+
if ($sortDir === SORT_DESC) {
1435+
$types = $types->reverse();
1436+
}
1437+
$query->orderBy(new FixedOrderExpression('type', $types->all(), Craft::$app->getDb()))
1438+
->addOrderBy(['name' => $sortDir])
1439+
->addOrderBy(['handle' => $sortDir]);
1440+
} else {
1441+
$query->orderBy([$orderBy => $sortDir]);
1442+
if ($orderBy === 'name') {
1443+
$query->addOrderBy(['handle' => $sortDir]);
1444+
}
1445+
}
1446+
14211447
if ($searchTerm !== null && $searchTerm !== '') {
14221448
$searchParams = $this->_getSearchParams($searchTerm);
14231449
if (!empty($searchParams)) {

‎src/templates/settings/entry-types/index.twig

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@
3131

3232
{% js %}
3333
var columns = [
34-
{ name: 'chip', title: Craft.t('app', 'Entry Type') },
35-
{ name: '__slot:handle', title: Craft.t('app', 'Handle') },
34+
{ name: 'chip', title: Craft.t('app', 'Entry Type'), sortField: true },
35+
{ name: '__slot:handle', title: Craft.t('app', 'Handle'), sortField: true },
3636
];
3737

3838
new Craft.VueAdminTable({

‎src/templates/settings/fields/index.twig

+4-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
{% js %}
3535
var columns = [
36-
{ name: '__slot:title', title: Craft.t('app', 'Name') },
36+
{ name: '__slot:title', title: Craft.t('app', 'Name'), sortField: true },
3737
{
3838
name: 'searchable',
3939
titleClass: 'thin',
@@ -56,7 +56,7 @@
5656
}
5757
},
5858
{% endif %}
59-
{ name: '__slot:handle', title: Craft.t('app', 'Handle') },
59+
{ name: '__slot:handle', title: Craft.t('app', 'Handle'), sortField: true },
6060
{
6161
name: 'type',
6262
title: Craft.t('app', 'Type'),
@@ -70,7 +70,8 @@
7070
}
7171
label += '</div>';
7272
return label;
73-
}
73+
},
74+
sortField: true,
7475
},
7576
];
7677

0 commit comments

Comments
 (0)