Entry type sorting

Fully resolves #9192
Resolves #11335

Author: brandonkelly

CHANGELOG-WIP.md

@@ -19,6 +19,7 @@
 - Live Preview now always shows a “Refresh” button, regardless of whether the preview target has auto-refresh enabled. ([#11160](https://github.com/craftcms/cms/discussions/11160)) 
 - Entry Type condition rules now allow multiple selections. ([#11124](https://github.com/craftcms/cms/pull/11124))
 - Element index filters now only show condition rules for the custom fields that are used by the field layouts in the selected source, if a native source is selected. ([#11187](https://github.com/craftcms/cms/discussions/11187))
+- It’s now possible to sort entries by their type. ([#9192](https://github.com/craftcms/cms/discussions/9192), [#11335](https://github.com/craftcms/cms/discussions/11335))
 - Sites’ Language settings now display the locale IDs as option hints, rather than the languages’ native names. ([#11195](https://github.com/craftcms/cms/discussions/11195))
 - Selectize options can now specify searchable `keywords` that won’t be visible in the UI.
 - Selectize inputs will now include their options’ values as search keywords.
@@ -27,6 +28,7 @@
 - The control panel’s JavaScript queue is now paused when the browser tab isn’t visible. ([#10632](https://github.com/craftcms/cms/issues/10632))
 - The `users/create` command now asks whether the user should be activated when saved.
 - Deprecation messages are now consistently referred to as “deprecation warnings” in the control panel.
+- Callback functions returned by elements’ `sortOptions()`/`defineSortOptions()` methods are now passed a `yii\db\Connection` object as a second argument.
 
 ### Removed
 - Removed `craft\elements\conditions\entries\EntryTypeCondition::$sectionUid`.

src/base/Element.php

@@ -73,6 +73,7 @@
 use yii\base\InvalidConfigException;
 use yii\base\NotSupportedException;
 use yii\base\UnknownPropertyException;
+use yii\db\Connection;
 use yii\db\ExpressionInterface;
 use yii\validators\BooleanValidator;
 use yii\validators\NumberValidator;
@@ -939,6 +940,8 @@ public static function indexHtml(ElementQueryInterface $elementQuery, ?array $di
             'tableName' => static::pluralDisplayName(),
         ];
 
+        $db = Craft::$app->getDb();
+
         if (!empty($viewState['order'])) {
             // Special case for sorting by structure
             if (isset($viewState['order']) && $viewState['order'] === 'structure') {
@@ -958,12 +961,12 @@ public static function indexHtml(ElementQueryInterface $elementQuery, ?array $di
                 } else {
                     unset($viewState['order']);
                 }
-            } elseif ($orderBy = self::_indexOrderBy($sourceKey, $viewState['order'], $viewState['sort'] ?? 'asc')) {
+            } elseif ($orderBy = self::_indexOrderBy($sourceKey, $viewState['order'], $viewState['sort'] ?? 'asc', $db)) {
                 $elementQuery->orderBy($orderBy);
 
                 if ((!is_array($orderBy) || !isset($orderBy['score'])) && !empty($viewState['orderHistory'])) {
                     foreach ($viewState['orderHistory'] as $order) {
-                        if ($order[0] && $orderBy = self::_indexOrderBy($sourceKey, $order[0], $order[1])) {
+                        if ($order[0] && $orderBy = self::_indexOrderBy($sourceKey, $order[0], $order[1], $db)) {
                             $elementQuery->addOrderBy($orderBy);
                         } else {
                             break;
@@ -992,7 +995,7 @@ public static function indexHtml(ElementQueryInterface $elementQuery, ?array $di
             }
         }
 
-        $variables['elements'] = $elementQuery->cache()->all();
+        $variables['elements'] = $elementQuery->cache()->all($db);
 
         $template = '_elements/' . $viewState['mode'] . 'view/' . ($includeContainer ? 'container' : 'elements');
 
@@ -1554,12 +1557,17 @@ public static function gqlScopesByContext(mixed $context): array
      * @param string $sourceKey
      * @param string $attribute
      * @param string $dir `asc` or `desc`
+     * @param Connection $db
      * @return array|ExpressionInterface|false
      */
-    private static function _indexOrderBy(string $sourceKey, string $attribute, string $dir): ExpressionInterface|array|false
-    {
+    private static function _indexOrderBy(
+        string $sourceKey,
+        string $attribute,
+        string $dir,
+        Connection $db,
+    ): ExpressionInterface|array|false {
         $dir = strcasecmp($dir, 'desc') === 0 ? SORT_DESC : SORT_ASC;
-        $columns = self::_indexOrderByColumns($sourceKey, $attribute, $dir);
+        $columns = self::_indexOrderByColumns($sourceKey, $attribute, $dir, $db);
 
         if ($columns === false || $columns instanceof ExpressionInterface) {
             return $columns;
@@ -1590,10 +1598,15 @@ private static function _indexOrderBy(string $sourceKey, string $attribute, stri
      * @param string $sourceKey
      * @param string $attribute
      * @param int $dir
+     * @param Connection $db
      * @return bool|string|array|ExpressionInterface
      */
-    private static function _indexOrderByColumns(string $sourceKey, string $attribute, int $dir): ExpressionInterface|bool|array|string
-    {
+    private static function _indexOrderByColumns(
+        string $sourceKey,
+        string $attribute,
+        int $dir,
+        Connection $db,
+    ): ExpressionInterface|bool|array|string {
         if (!$attribute) {
             return false;
         }
@@ -1607,7 +1620,7 @@ private static function _indexOrderByColumns(string $sourceKey, string $attribut
                 $a = $sortOption['attribute'] ?? $sortOption['orderBy'];
                 if ($a === $attribute) {
                     if (is_callable($sortOption['orderBy'])) {
-                        return $sortOption['orderBy']($dir);
+                        return $sortOption['orderBy']($dir, $db);
                     }
                     return $sortOption['orderBy'];
                 }

src/base/ElementInterface.php

@@ -394,8 +394,8 @@ public static function indexHtml(ElementQueryInterface $elementQuery, ?array $di
      *
      * - `label` – The sort option label
      * - `orderBy` – An array, comma-delimited string, or a callback function that defines the columns to order the query by. If set to a callback
-     *   function, the function will be passed a single argument, `$dir`, set to either `SORT_ASC` or `SORT_DESC`, and it should return an array of
-     *   column names or an [[\yii\db\ExpressionInterface]] object.
+     *   function, the function will be passed two arguments: `$dir` (either `SORT_ASC` or `SORT_DESC`) and `$db` (a [[\yii\db\Connection]] object),
+     *   and it should return an array of column names or an [[\yii\db\ExpressionInterface]] object.
      * - `attribute` _(optional)_ – The [[tableAttributes()|table attribute]] name that this option is associated
      *   with (required if `orderBy` is an array or more than one column name)
      * - `defaultDir` _(optional)_ – The default sort direction that should be used when sorting by this option

src/elements/Entry.php

@@ -14,6 +14,7 @@
 use craft\behaviors\DraftBehavior;
 use craft\behaviors\RevisionBehavior;
 use craft\controllers\ElementIndexesController;
+use craft\db\FixedOrderExpression;
 use craft\db\Table;
 use craft\elements\actions\Delete;
 use craft\elements\actions\DeleteForSite;
@@ -51,8 +52,10 @@
 use craft\validators\DateTimeValidator;
 use craft\web\CpScreenResponseBehavior;
 use DateTime;
+use Illuminate\Support\Collection;
 use yii\base\Exception;
 use yii\base\InvalidConfigException;
+use yii\db\Connection;
 use yii\db\Expression;
 use yii\web\Response;
 
@@ -513,6 +516,19 @@ protected static function defineSortOptions(): array
             'title' => Craft::t('app', 'Title'),
             'slug' => Craft::t('app', 'Slug'),
             'uri' => Craft::t('app', 'URI'),
+            [
+                'label' => Craft::t('app', 'Entry Type'),
+                'orderBy' => function(int $dir, Connection $db) {
+                    $entryTypeIds = Collection::make(Craft::$app->getSections()->getAllEntryTypes())
+                        ->sort(fn(EntryType $a, EntryType $b) => $dir === SORT_ASC
+                            ? $a->name <=> $b->name
+                            : $b->name <=> $a->name)
+                        ->map(fn(EntryType $type) => $type->id)
+                        ->all();
+                    return new FixedOrderExpression('entries.typeId', $entryTypeIds, $db);
+                },
+                'attribute' => 'type',
+            ],
             [
                 'label' => Craft::t('app', 'Post Date'),
                 'orderBy' => function(int $dir) {