Feature/entries with category features

src/controllers/ElementsController.php

@@ -1448,6 +1448,57 @@ public function actionGetElementHtml(): Response
         return $this->asJson(compact('html', 'headHtml'));
     }
 
+    /**
+     * Returns HTML for the elements field input that has "relateAncestors" set to true,
+     * based on a given list of selected element ids.
+     *
+     * @return Response
+     * @throws BadRequestHttpException
+     * @throws ForbiddenHttpException
+     * @since 4.0.0
+     */
+    public function actionInputHtml(): Response
+    {
+        $this->requireAcceptsJson();
+
+        $elementType = $this->request->getRequiredParam('elementType', null);
+        $elementIds = $this->request->getParam('elementIds', []);
+
+        $elements = [];
+
+        if (!empty($elementIds)) {
+            /** @var ElementInterface[] $elements */
+            $elements = $elementType::find()
+                ->id($elementIds)
+                ->siteId($this->request->getParam('siteId'))
+                ->status(null)
+                ->all();
+
+            // Fill in the gaps
+            $structuresService = Craft::$app->getStructures();
+            $structuresService->fillGapsInElements($elements);
+
+            // Enforce the branch limit
+            if ($branchLimit = $this->request->getParam('branchLimit')) {
+                $structuresService->applyBranchLimitToElements($elements, $branchLimit);
+            }
+        }
+
+        $html = $this->getView()->renderTemplate('_includes/forms/elementselect',
+            [
+                'elements' => $elements,
+                'id' => $this->request->getParam('containerId'),
+                'name' => $this->request->getParam('name'),
+                'selectionLabel' => $this->request->getParam('selectionLabel'),
+                'elementType' => $elementType,
+                'relateAncestors' => true
+            ]);
+
+        return $this->asJson([
+            'html' => $html,
+        ]);
+    }
+
     /**
      * Returns the requested element, populated with any posted attributes.
      *

src/fields/BaseRelationField.php

@@ -135,6 +135,20 @@ public static function valueType(): string
      */
     public bool $showSiteMenu = false;
 
+    /**
+     * @var bool Whether to automatically relate structural ancestors.
+     *
+     * @since 4.0.0
+     */
+    public bool $relateAncestors = false;
+
+    /**
+     * @var int|null Branch limit
+     *
+     * @since 4.0.0
+     */
+    public ?int $branchLimit = null;
+
     /**
      * @var string|null The view mode
      */
@@ -280,6 +294,9 @@ public function settingsAttributes(): array
         $attributes[] = 'targetSiteId';
         $attributes[] = 'validateRelatedElements';
         $attributes[] = 'viewMode';
+        $attributes[] = 'allowSelfRelations';
+        $attributes[] = 'relateAncestors';
+        $attributes[] = 'branchLimit';
 
         return $attributes;
     }
@@ -361,7 +378,7 @@ public function validateRelationCount(ElementInterface $element): void
      */
     public function validateRelatedElements(ElementInterface $element): void
     {
-        // Prevent circular relations from worrying about this entry
+        // Prevent circular relations from worrying about this element
         $sourceId = $element->getCanonicalId();
         $sourceValidates = self::$_relatedElementValidates[$sourceId][$element->siteId] ?? null;
         self::$_relatedElementValidates[$sourceId][$element->siteId] = true;
@@ -489,6 +506,27 @@ public function normalizeValue(mixed $value, ?ElementInterface $element = null):
                     Craft::configure($query, $source['criteria']);
                 }
             }
+
+            if ($this->relateAncestors || $this->branchLimit) {
+                $structuresService = Craft::$app->getStructures();
+
+                /** @var ElementInterface[] $structureElements */
+                $structureElements = (clone($query))
+                    ->status(null)
+                    ->all();
+
+                // Fill in any gaps
+                if ($this->relateAncestors) {
+                    $structuresService->fillGapsInElements($structureElements);
+                }
+
+                // Enforce the branch limit
+                if ($this->branchLimit) {
+                    $structuresService->applyBranchLimitToElements($structureElements, $this->branchLimit);
+                }
+
+                $query->id(ArrayHelper::getColumn($structureElements, 'id'));
+            }
         } else {
             $query->id(false);
         }
@@ -757,6 +795,10 @@ public function getEagerLoadingMap(array $sourceElements): array|null|false
             }
         }
 
+        if ($this->relateAncestors) {
+            $criteria['orderBy'] = ['structureelements.lft' => SORT_ASC];
+        }
+
         return [
             'elementType' => static::elementType(),
             'map' => $map,
@@ -1065,7 +1107,9 @@ protected function inputTemplateVariables(array|ElementQueryInterface $value = n
             'condition' => $this->getSelectionCondition(),
             'criteria' => $selectionCriteria,
             'showSiteMenu' => ($this->targetSiteId || !$this->showSiteMenu) ? false : 'auto',
-            'allowSelfRelations' => $this->allowSelfRelations,
+            'allowSelfRelations' => (bool)$this->allowSelfRelations,
+            'relateAncestors' => (bool)$this->relateAncestors,
+            'branchLimit' => (int)$this->branchLimit,
             'sourceElementId' => !empty($element->id) ? $element->id : null,
             'disabledElementIds' => $disabledElementIds,
             'limit' => $this->allowLimit ? $this->maxRelations : null,

src/fields/Categories.php

@@ -11,7 +11,6 @@
 use craft\base\ElementInterface;
 use craft\elements\Category;
 use craft\elements\db\CategoryQuery;
-use craft\elements\db\ElementQueryInterface;
 use craft\gql\arguments\elements\Category as CategoryArguments;
 use craft\gql\interfaces\elements\Category as CategoryInterface;
 use craft\gql\resolvers\elements\Category as CategoryResolver;
@@ -74,11 +73,6 @@ public static function valueType(): string
      */
     public bool $allowMultipleSources = false;
 
-    /**
-     * @var int|null Branch limit
-     */
-    public ?int $branchLimit = null;
-
     /**
      * @inheritdoc
      */
@@ -87,17 +81,22 @@ public static function valueType(): string
     /**
      * @inheritdoc
      */
-    protected string $inputTemplate = '_components/fieldtypes/Categories/input';
+    protected bool $sortable = false;
 
     /**
+     * Force relateAncestors to true.
+     *
      * @inheritdoc
+     * @since 4.0.0
      */
-    protected ?string $inputJsClass = 'Craft.CategorySelectInput';
+    public function __construct($config)
+    {
+        if (isset($config['relateAncestors'])) {
+            $config['relateAncestors'] = true;
+        }
 
-    /**
-     * @inheritdoc
-     */
-    protected bool $sortable = false;
+        parent::__construct($config);
+    }
 
     /**
      * @inheritdoc
@@ -144,17 +143,6 @@ protected function inputHtml(mixed $value, ?ElementInterface $element = null): s
         return parent::inputHtml($value, $element);
     }
 
-    /**
-     * @inheritdoc
-     */
-    protected function inputTemplateVariables(array|ElementQueryInterface $value = null, ?ElementInterface $element = null): array
-    {
-        $variables = parent::inputTemplateVariables($value, $element);
-        $variables['branchLimit'] = $this->branchLimit;
-
-        return $variables;
-    }
-
     public function getEagerLoadingMap(array $sourceElements): array|null|false
     {
         $map = parent::getEagerLoadingMap($sourceElements);

src/templates/_components/fieldtypes/elementfieldsettings.twig

@@ -91,6 +91,28 @@
         }) }}
     {% endblock %}
 
+    {% block relateAncestors %}
+        {{ forms.checkboxField({
+            label: 'Relate ancestors',
+            instructions: 'Whether structural ancestors of {type} should be added to the selection.'|t('app', { type: pluralElementType }),
+            id: 'relate-ancestors',
+            name: 'relateAncestors',
+            checked: field.relateAncestors
+        }) }}
+    {% endblock %}
+
+    {% block branchLimitField %}
+        {{ forms.textField({
+            label: "Branch Limit"|t('app'),
+            instructions: "Limit the number of selectable {type} branches."|t('app', { type: elementType }),
+            id: 'branchLimit',
+            name: 'branchLimit',
+            value: field.branchLimit,
+            size: 2,
+            errors: field.getErrors('branchLimit')
+        }) }}
+    {% endblock %}
+
     {% block advancedSettings %}
         <hr>
 

src/templates/_elements/list.twig

@@ -0,0 +1,16 @@
+{% set elements = elements ?? [] %}
+{% set disabled = disabled ?? null %}
+{% set viewMode = viewMode ?? null %}
+
+<div class="elements">
+    {% for element in elements %}
+        {% set element = include('_elements/element', {
+            context: 'field',
+            size: (viewMode == 'large' ? 'large' : 'small')
+        }) %}
+        {% if disabled %}
+            {% set element = element|removeClass('removable') %}
+        {% endif %}
+        {{ element|raw }}
+    {% endfor %}
+</div>

src/templates/_elements/structurelist.twig

@@ -0,0 +1,19 @@
+{% set elements = elements ?? [] %}
+{% set id = id ?? null %}
+
+<ul class="elements structure">
+    {% nav element in elements %}
+        <li id="{{ id }}-element-{{ element.id }}">
+            {% set indent = (element.level - 1) * 35 %}
+            <div class="row" style="margin-left: -{{ indent }}px; padding-left: {{ indent }}px;">
+                {%- include "_elements/element" with { element: element, context: 'field' } -%}
+            </div>
+
+            {% ifchildren %}
+                <ul>
+                    {% children %}
+                </ul>
+            {% endifchildren %}
+        </li>
+    {% endnav %}
+</ul>

src/templates/_includes/forms/elementSelect.twig

@@ -17,6 +17,7 @@
 {% set single = single ?? false %}
 {% set limit = single ? 1 : (limit ?? null) %}
 {% set disabled = (disabled ?? false) ? true : false %}
+{% set relateAncestors = relateAncestors ?? false %}
 
 {% set containerAttributes = {
     id: id,
@@ -28,18 +29,11 @@
 {% endif %}
 
 {% tag 'div' with containerAttributes %}
-    <div class="elements">
-        {% for element in elements %}
-            {% set element = include('_elements/element', {
-                context: 'field',
-                size: (viewMode == 'large' ? 'large' : 'small')
-            }) %}
-            {% if disabled %}
-                {% set element = element|removeClass('removable') %}
-            {% endif %}
-            {{ element|raw }}
-        {% endfor %}
-    </div>
+    {% if relateAncestors %}
+        {{ include('_elements/structurelist', { elements, id })}}
+    {% else %}
+        {{ include('_elements/list', { elements, viewMode, disabled }) }}
+    {% endif %}
 
     <div class="flex flex-nowrap">
         {{ tag('button', {
@@ -72,6 +66,8 @@
         condition: condition ? condition.getConfig() : null,
         criteria: criteria,
         allowSelfRelations: allowSelfRelations ?? false,
+        relateAncestors: relateAncestors,
+        branchLimit: branchLimit ?? null,
         sourceElementId: sourceElementId,
         disabledElementIds: disabledElementIds ?? null,
         viewMode: viewMode,