Merge pull request #17779 from craftcms/brandon/cms-1551-content-section

Customizable entry index pages

Author: brandonkelly

CHANGELOG-WIP.md

@@ -11,6 +11,7 @@
 - The Image Editor’s focal point tool is now keyboard accessible. ([#17880](https://github.com/craftcms/cms/pull/17880))
 
 ### Administration
+- It’s now possible to divide entry sources into multiple index pages, via the Customize Sources modal. ([#17779](https://github.com/craftcms/cms/pull/17779))
 - Added the “View user” GraphQL schema option for Craft Solo. ([#17863](https://github.com/craftcms/cms/pull/17863))
 - Users’ User Groups settings now show a component select input, and support inline group editing/creation on environments that allow administrative changes.
 - Relational fields now have an “Inline list” view mode. ([#17744](https://github.com/craftcms/cms/pull/17744))
@@ -22,6 +23,7 @@
 - “Field” and “Section” condition rules now show field/section handles for users with the “Show field handles in edit forms” preference enabled. ([#17909](https://github.com/craftcms/cms/pull/17909))
 - “Remove” actions on the Plugins index page now show a confirmation dialog. ([#17922](https://github.com/craftcms/cms/pull/17922))
 - `entrify` commands no longer require a category group/tag group/global set handle to be passed.
+- `entrify` commands now automatically assign newly-created channel/structure sections to “Categories” or “Tags” pages. ([#17779](https://github.com/craftcms/cms/pull/17779))
 - Added the `useIdnaNontransitionalToUnicode` config setting. ([#17946](https://github.com/craftcms/cms/pull/17946))
 
 ### Development
@@ -38,6 +40,7 @@
 - Added `Craft.BaseElementIndex::asyncSelectSource()`.
 - Added `Craft.BaseElementIndex::asyncSelectSourceByKey()`.
 - Added `Craft.BaseElementIndex::ensureSourceAttributeInfo()`.
+- Added `craft\base\ElementIndex::multiPageSources()`. ([#17779](https://github.com/craftcms/cms/pull/17779))
 - Added `craft\base\ElementTrait::$hasProvisionalChanges`. ([#17915](https://github.com/craftcms/cms/pull/17915))
 - Added `craft\elements\conditions\HintableConditionRuleTrait`. ([#17909](https://github.com/craftcms/cms/pull/17909))
 - Added `craft\events\RegisterElementCardAttributesEvent::$fieldLayout`. ([#17920](https://github.com/craftcms/cms/pull/17920))
@@ -48,12 +51,19 @@
 - Added `craft\fields\BaseRelationField::VIEW_MODE_THUMBS`.
 - Added `craft\fields\Matrix::VIEW_MODE_CARDS_GRID`.
 - Added `craft\helpers\ElementHelper::loadProvisionalChanges()`. ([#17915](https://github.com/craftcms/cms/pull/17915))
+- Added `craft\services\ElementSources::getFirstPage()`. ([#17779](https://github.com/craftcms/cms/pull/17779))
+- Added `craft\services\ElementSources::getPageSettings()`. ([#17779](https://github.com/craftcms/cms/pull/17779))
+- Added `craft\services\ElementSources::getPages()`. ([#17779](https://github.com/craftcms/cms/pull/17779))
+- Added `craft\services\ElementSources::pageExists()`. ([#17779](https://github.com/craftcms/cms/pull/17779))
+- Added `craft\services\ElementSources::pageNameId()`. ([#17779](https://github.com/craftcms/cms/pull/17779))
 - Added `craft\web\GqlResponseFormatter`.
 - Added `craft\web\Response::FORMAT_GQL`.
 - Added `craft\web\twig\nodes\BaseNode`.
 - `craft\base\ElementInterface::cardAttributes()` now has a `$fieldLayout` argument. ([#17920](https://github.com/craftcms/cms/pull/17920))
 - `craft\helpers\FileHelper::writeToFile()` now throws an exception if the file path isn’t writable, or there isn’t sufficient free space on the disk. ([#17762](https://github.com/craftcms/cms/pull/17762))
 - `craft\helpers\UrlHelper` now encodes square brackets in generated URLs. ([#17840](https://github.com/craftcms/cms/pull/17840))
+- `craft\services\ElementSources::getSources()` now has a `$page` argument. ([#17779](https://github.com/craftcms/cms/pull/17779))
+- `craft\services\ElementSources::sourceExists()` now has a `$page` argument. ([#17779](https://github.com/craftcms/cms/pull/17779))
 - `craft\web\Request::accepts()` now accepts wildcard characters (`*`) in the `$contentType` argument, to check for a range of MIME types (e.g. `application/*+json`).
 - `craft\web\Request::getAcceptsJson()` now returns `true` for requests with `Content-Type` headers that match `application/*+json`, in addition to `application/json`.
 - Deprecated `craft\fields\BaseRelationField::$showCardsInGrid`.

src/base/Element.php

@@ -975,6 +975,14 @@ public static function createCondition(): ElementConditionInterface
         return Craft::createObject(ElementCondition::class, [static::class]);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public static function multiPageSources(): bool
+    {
+        return false;
+    }
+
     /**
      * @inheritdoc
      */

src/base/ElementInterface.php

@@ -261,12 +261,21 @@ public static function findAll(mixed $criteria = null): array;
      */
     public static function createCondition(): ElementConditionInterface;
 
+    /**
+     * Returns whether the element type’s sources can be split into multiple pages.
+     *
+     * @return bool
+     * @since 5.9.0
+     */
+    public static function multiPageSources(): bool;
+
     /**
      * Returns the source definitions that elements of this type may belong to.
      *
      * This defines what will show up in the source list on element indexes and element selector modals.
      *
      * Each item in the array should be set to an array that has the following keys:
+     * - **`page`** – The source’s page label. (Optional)
      * - **`key`** – The source’s key. This is the string that will be passed into the $source argument of [[actions()]],
      *   [[indexHtml()]], and [[defaultTableAttributes()]].
      * - **`label`** – The human-facing label of the source.

src/config/cproutes/common.php

@@ -17,6 +17,14 @@
     'entries/<section:{handle}>/new' => 'entries/create',
     'entries/<section:{handle}>/<elementId:\d+><slug:(?:-[^\/]*)?>' => 'elements/edit',
     'entries/<section:{handle}>/<elementId:\d+><slug:(?:-[^\/]*)?>/revisions' => 'elements/revisions',
+
+    'content' => 'entries',
+    'content/<page:{slug}>' => ['template' => 'entries'],
+    'content/<page:{slug}>/<sectionHandle:{handle}>' => ['template' => 'entries'],
+    'content/<page:{slug}>/<section:{handle}>/new' => 'entries/create',
+    'content/<page:{slug}>/<section:{handle}>/<elementId:\d+><slug:(?:-[^\/]*)?>' => 'elements/edit',
+    'content/<page:{slug}>/<section:{handle}>/<elementId:\d+><slug:(?:-[^\/]*)?>/revisions' => 'elements/revisions',
+
     'globals' => 'globals',
     'globals/<globalSetHandle:{handle}>' => 'globals/edit-content',
     'graphiql' => 'graphql/graphiql',

src/console/controllers/EntrifyController.php

@@ -145,6 +145,10 @@ public function actionCategories(?string $categoryGroup = null): int
             $this->run('sections/create', [
                 'fromCategoryGroup' => $categoryGroup->handle,
             ]);
+
+            // Add it to a “Categories” page
+            $this->_addSectionToPage('Categories', 'sitemap');
+
             $projectConfigChanged = true;
             $sectionCreated = true;
         }
@@ -371,6 +375,10 @@ public function actionTags(?string $tagGroup = null): int
             $this->run('sections/create', [
                 'fromTagGroup' => $tagGroup->handle,
             ]);
+
+            // Add it to a “Tags” page
+            $this->_addSectionToPage('Tags', 'tags');
+
             $projectConfigChanged = true;
         }
 
@@ -808,4 +816,26 @@ private function _deployTip(string $action, string $handle): void
 ```
 MD);
     }
+
+    private function _addSectionToPage(string $name, string $icon): void
+    {
+        $projectConfig = Craft::$app->getProjectConfig();
+
+        $sourceConfigPath = sprintf('%s.%s', ProjectConfig::PATH_ELEMENT_SOURCES, Entry::class);
+        $sourceConfigs = Collection::make($projectConfig->get($sourceConfigPath))
+            ->map(fn(array $config) => $config + ['page' => 'Entries'])
+            ->all();
+        $sourceConfigs[] = [
+            'key' => sprintf('section:%s', $this->_section()->uid),
+            'page' => $name,
+            'type' => 'native',
+        ];
+        $projectConfig->set($sourceConfigPath, $sourceConfigs);
+
+        $pageSettings = Craft::$app->getElementSources()->getPageSettings(Entry::class);
+        $pageSettings[$name] = [
+            'icon' => $icon,
+        ];
+        $projectConfig->set(sprintf('%s.%s', ProjectConfig::PATH_ELEMENT_SOURCE_PAGES, Entry::class), $pageSettings);
+    }
 }

src/controllers/ElementIndexSettingsController.php

@@ -68,8 +68,17 @@ public function actionGetCustomizeSourcesModalData(): Response
         // Get the source info
         $sourcesService = Craft::$app->getElementSources();
         $sources = $sourcesService->getSources($elementType, ElementSources::CONTEXT_INDEX, true);
+        $multiPage = $elementType::multiPageSources();
 
         foreach ($sources as &$source) {
+            if ($multiPage) {
+                // ensure we're using the EN translation here
+                $language = Craft::$app->language;
+                Craft::$app->language = Craft::$app->sourceLanguage;
+                $source['page'] ??= $elementType::pluralDisplayName();
+                Craft::$app->language = $language;
+            }
+
             if ($source['type'] === ElementSources::TYPE_HEADING) {
                 continue;
             }
@@ -215,8 +224,12 @@ public function actionGetCustomizeSourcesModalData(): Response
             ])
             ->all();
 
+        $pageSettings = $sourcesService->getPageSettings($elementType);
+
         return $this->asJson([
+            'multiPage' => $multiPage,
             'sources' => $sources,
+            'pageSettings' => $pageSettings,
             'viewModes' => $viewModes,
             'baseSortOptions' => $baseSortOptions,
             'defaultSortOptions' => $defaultSortOptions,
@@ -239,6 +252,7 @@ public function actionGetCustomizeSourcesModalData(): Response
     public function actionSaveCustomizeSourcesModalSettings(): Response
     {
         $elementType = $this->elementType();
+        $multiPage = $elementType::multiPageSources();
 
         // Get the old source configs
         $projectConfig = Craft::$app->getProjectConfig();
@@ -252,6 +266,11 @@ public function actionSaveCustomizeSourcesModalSettings(): Response
         $newSourceConfigs = [];
         $disabledSourceKeys = [];
 
+        if ($multiPage) {
+            $sourcePages = $this->request->getBodyParam('sourcePages', []);
+            $pageSettings = $this->request->getBodyParam('pageSettings', []);
+        }
+
         // Normalize to the way it's stored in the DB
         foreach ($sourceOrder as $source) {
             if (isset($source['key'])) {
@@ -267,6 +286,10 @@ public function actionSaveCustomizeSourcesModalSettings(): Response
                     'key' => $source['key'],
                 ];
 
+                if (isset($sourcePages[$source['key']])) {
+                    $sourceConfig['page'] = $sourcePages[$source['key']];
+                }
+
                 // Were new settings posted?
                 if (isset($sourceSettings[$source['key']])) {
                     $postedSettings = $sourceSettings[$source['key']];
@@ -318,7 +341,14 @@ public function actionSaveCustomizeSourcesModalSettings(): Response
             }
         }
 
-        $projectConfig->set(ProjectConfig::PATH_ELEMENT_SOURCES . ".$elementType", $newSourceConfigs);
+        $projectConfig->set(sprintf('%s.%s', ProjectConfig::PATH_ELEMENT_SOURCES, $elementType), $newSourceConfigs);
+
+        if ($multiPage) {
+            $projectConfig->set(
+                sprintf('%s.%s', ProjectConfig::PATH_ELEMENT_SOURCE_PAGES, $elementType),
+                array_map('array_filter', $pageSettings),
+            );
+        }
 
         Craft::$app->getSession()->setSuccess(Craft::t('app', 'Source settings saved'));
 

src/controllers/EntriesController.php

@@ -43,6 +43,16 @@
  */
 class EntriesController extends BaseEntriesController
 {
+    /**
+     * @since 5.9.0
+     */
+    public function actionIndex(): Response
+    {
+        $firstPage = Craft::$app->getElementSources()->getFirstPage(Entry::class);
+        $slug = $firstPage ? StringHelper::toKebabCase($firstPage) : 'entries';
+        return $this->redirect("content/$slug");
+    }
+
     /**
      * Creates a new unpublished draft and redirects to its edit page.
      *

src/elements/Entry.php

@@ -55,6 +55,7 @@
 use craft\helpers\Db;
 use craft\helpers\ElementHelper;
 use craft\helpers\Html;
+use craft\helpers\StringHelper;
 use craft\helpers\UrlHelper;
 use craft\models\EntryType;
 use craft\models\FieldLayout;
@@ -236,6 +237,14 @@ public static function createCondition(): ElementConditionInterface
         return Craft::createObject(EntryCondition::class, [static::class]);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public static function multiPageSources(): bool
+    {
+        return true;
+    }
+
     /**
      * @inheritdoc
      */
@@ -931,6 +940,11 @@ protected static function prepElementQueryForTableAttribute(ElementQueryInterfac
      */
     private ?EntryType $_type = null;
 
+    /**
+     * @see page()
+     */
+    private string|false $page;
+
     /**
      * @inheritdoc
      * @since 3.5.0
@@ -1273,10 +1287,12 @@ protected function crumbs(): array
             return [];
         }
 
+        $page = $this->page();
+
         $crumbs = [
             [
-                'label' => Craft::t('app', 'Entries'),
-                'url' => 'entries',
+                'label' => $page && $page !== 'Entries' ? Craft::t('site', $page) : Craft::t('app', 'Entries'),
+                'url' => sprintf('content/%s', $page ? StringHelper::toKebabCase($page) : 'entries'),
             ],
         ];
 
@@ -2132,7 +2148,13 @@ protected function cpEditUrl(): ?string
             return ElementHelper::elementEditorUrl($this, false);
         }
 
-        $path = sprintf('entries/%s/%s', $section->handle, $this->getCanonicalId());
+        $page = $this->page();
+        $path = sprintf(
+            'content/%s/%s/%s',
+            $page ? StringHelper::toKebabCase($page) : 'entries',
+            $section->handle,
+            $this->getCanonicalId(),
+        );
 
         // Ignore homepage/temp slugs
         if ($this->slug && !str_starts_with($this->slug, '__')) {
@@ -3210,4 +3232,20 @@ protected function partialTemplatePathCandidates(): array
 
         return $templates;
     }
+
+    private function page(): ?string
+    {
+        if (!isset($this->page)) {
+            $section = $this->getSection();
+            if ($section) {
+                $sourceKey = $section->type === Section::TYPE_SINGLE ? 'singles' : "section:$section->uid";
+                $source = ElementHelper::findSource(Entry::class, $sourceKey);
+                $this->page = $source['page'] ?? false;
+            } else {
+                $this->page = false;
+            }
+        }
+
+        return $this->page ?: null;
+    }
 }