[6.x] Field layouts

CHANGELOG-WIP.md

@@ -288,6 +288,65 @@ Craft 6 introduces a new validation system that uses Laravel's Validator instead
 - Removed `craft\console\controllers\EntryTypesController` in favor of:
   - `CraftCms\Cms\Entry\Commands\MergeEntryTypesCommand`
 
+## Component
+
+- Added `CraftCms\Cms\Component\Component` base class, replacing Yii2's `BaseObject`/`Component` with config hydration, magic getters/setters, and `Arrayable` support.
+- Added `CraftCms\Cms\Component\Exceptions\InvalidCallException`, replacing `yii\base\InvalidCallException`.
+- Added `CraftCms\Cms\Component\Exceptions\UnknownPropertyException`, replacing `yii\base\UnknownPropertyException`.
+
+## Field Layouts
+
+### Added
+
+- Added `CraftCms\Cms\FieldLayout\FieldLayoutForm`.
+- Added `CraftCms\Cms\FieldLayout\FieldLayoutFormTab`.
+- Added `CraftCms\Cms\FieldLayout\FieldLayoutFormElement`.
+- Added `CraftCms\Cms\FieldLayout\FieldLayoutServiceProvider`.
+- Added `CraftCms\Cms\FieldLayout\Concerns\HasFieldLayout` trait.
+
+### Deprecations
+- Deprecated `craft\models\FieldLayout`. `CraftCms\Cms\FieldLayout\FieldLayout` should be used instead.
+- Deprecated `craft\models\FieldLayoutTab`. `CraftCms\Cms\FieldLayout\FieldLayoutTab` should be used instead.
+- Deprecated `craft\base\FieldLayoutComponent`. `CraftCms\Cms\FieldLayout\FieldLayoutComponent` should be used instead.
+- Deprecated `craft\base\FieldLayoutElement`. `CraftCms\Cms\FieldLayout\FieldLayoutElement` should be used instead.
+- Deprecated `craft\base\FieldLayoutProviderInterface`. `CraftCms\Cms\FieldLayout\Contracts\FieldLayoutProviderInterface` should be used instead.
+- Deprecated `craft\records\FieldLayout`. `CraftCms\Cms\FieldLayout\Models\FieldLayout` should be used instead.
+- Deprecated `craft\fieldlayoutelements\BaseField`. `CraftCms\Cms\FieldLayout\LayoutElements\BaseField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\BaseNativeField`. `CraftCms\Cms\FieldLayout\LayoutElements\BaseNativeField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\BaseUiElement`. `CraftCms\Cms\FieldLayout\LayoutElements\BaseUiElement` should be used instead.
+- Deprecated `craft\fieldlayoutelements\CustomField`. `CraftCms\Cms\FieldLayout\LayoutElements\CustomField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\Heading`. `CraftCms\Cms\FieldLayout\LayoutElements\Heading` should be used instead.
+- Deprecated `craft\fieldlayoutelements\HorizontalRule`. `CraftCms\Cms\FieldLayout\LayoutElements\HorizontalRule` should be used instead.
+- Deprecated `craft\fieldlayoutelements\Html`. `CraftCms\Cms\FieldLayout\LayoutElements\Html` should be used instead.
+- Deprecated `craft\fieldlayoutelements\LineBreak`. `CraftCms\Cms\FieldLayout\LayoutElements\LineBreak` should be used instead.
+- Deprecated `craft\fieldlayoutelements\Markdown`. `CraftCms\Cms\FieldLayout\LayoutElements\Markdown` should be used instead.
+- Deprecated `craft\fieldlayoutelements\Template`. `CraftCms\Cms\FieldLayout\LayoutElements\Template` should be used instead.
+- Deprecated `craft\fieldlayoutelements\TextField`. `CraftCms\Cms\FieldLayout\LayoutElements\TextField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\TextareaField`. `CraftCms\Cms\FieldLayout\LayoutElements\TextareaField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\Tip`. `CraftCms\Cms\FieldLayout\LayoutElements\Tip` should be used instead.
+- Deprecated `craft\fieldlayoutelements\TitleField`. `CraftCms\Cms\FieldLayout\LayoutElements\TitleField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\FullNameField`. `CraftCms\Cms\FieldLayout\LayoutElements\FullNameField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\addresses\AddressField`. `CraftCms\Cms\FieldLayout\LayoutElements\addresses\AddressField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\addresses\CountryCodeField`. `CraftCms\Cms\FieldLayout\LayoutElements\addresses\CountryCodeField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\addresses\LabelField`. `CraftCms\Cms\FieldLayout\LayoutElements\addresses\LabelField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\addresses\LatLongField`. `CraftCms\Cms\FieldLayout\LayoutElements\addresses\LatLongField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\addresses\OrganizationField`. `CraftCms\Cms\FieldLayout\LayoutElements\addresses\OrganizationField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\addresses\OrganizationTaxIdField`. `CraftCms\Cms\FieldLayout\LayoutElements\addresses\OrganizationTaxIdField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\assets\AssetTitleField`. `CraftCms\Cms\FieldLayout\LayoutElements\assets\AssetTitleField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\assets\AltField`. `CraftCms\Cms\FieldLayout\LayoutElements\assets\AltField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\entries\EntryTitleField`. `CraftCms\Cms\FieldLayout\LayoutElements\entries\EntryTitleField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\users\UsernameField`. `CraftCms\Cms\FieldLayout\LayoutElements\users\UsernameField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\users\FullNameField`. `CraftCms\Cms\FieldLayout\LayoutElements\users\FullNameField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\users\EmailField`. `CraftCms\Cms\FieldLayout\LayoutElements\users\EmailField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\users\AffiliatedSiteField`. `CraftCms\Cms\FieldLayout\LayoutElements\users\AffiliatedSiteField` should be used instead.
+- Deprecated `craft\fieldlayoutelements\users\PhotoField`. `CraftCms\Cms\FieldLayout\LayoutElements\users\PhotoField` should be used instead.
+- Deprecated `craft\events\CreateFieldLayoutFormEvent`. `CraftCms\Cms\FieldLayout\Events\CreateFieldLayoutForm` should be used instead.
+- Deprecated `craft\events\DefineFieldLayoutCustomFieldsEvent`. `CraftCms\Cms\FieldLayout\Events\DefineCustomFields` should be used instead.
+- Deprecated `craft\events\DefineFieldLayoutElementsEvent`. `CraftCms\Cms\FieldLayout\Events\DefineUIElements` should be used instead.
+- Deprecated `craft\events\DefineFieldLayoutFieldsEvent`. `CraftCms\Cms\FieldLayout\Events\DefineNativeFields` should be used instead.
+- Deprecated `craft\events\DefineShowFieldLayoutComponentInFormEvent`. `CraftCms\Cms\FieldLayout\Events\DefineShowInForm` should be used instead.
+- Deprecated `craft\events\DefineFieldActionsEvent`. `CraftCms\Cms\FieldLayout\Events\DefineActionMenuItems` should be used instead.
+
 ## Fields
 
 - Removed `craft\controllers\FieldsController` in favor of `CraftCms\Cms\Http\Controllers\FieldsController`.

composer.json

@@ -69,6 +69,7 @@
     "twig/twig": "~3.21.1",
     "web-auth/webauthn-lib": "~4.9.0",
     "webonyx/graphql-php": "~14.11.10",
+    "yiisoft/arrays": "^3.2",
     "yiisoft/html": "^3.11",
     "yiisoft/translator": "^3.2",
     "yiisoft/translator-message-php": "^1.1"

database/Factories/Concerns/HasFieldFactory.php

@@ -4,10 +4,10 @@
 
 namespace CraftCms\Cms\Database\Factories\Concerns;
 
-use craft\fieldlayoutelements\CustomField;
 use CraftCms\Cms\Database\Factories\ElementFactoryResult;
 use CraftCms\Cms\Element\Element;
 use CraftCms\Cms\Field\Models\Field;
+use CraftCms\Cms\FieldLayout\LayoutElements\CustomField;
 use CraftCms\Cms\FieldLayout\Models\FieldLayout;
 use CraftCms\Cms\Support\Facades\EntryTypes;
 use CraftCms\Cms\Support\Facades\Fields;

database/Factories/FieldLayoutFactory.php

@@ -4,10 +4,10 @@
 
 namespace CraftCms\Cms\Database\Factories;
 
-use craft\fieldlayoutelements\CustomField;
 use CraftCms\Cms\Entry\Elements\Entry;
 use CraftCms\Cms\Field\Field;
 use CraftCms\Cms\Field\Models\Field as FieldModel;
+use CraftCms\Cms\FieldLayout\LayoutElements\CustomField;
 use CraftCms\Cms\FieldLayout\Models\FieldLayout;
 use CraftCms\Cms\Support\Str;
 use Illuminate\Database\Eloquent\Factories\Factory;

resources/templates/_includes/forms/cardViewDesigner.twig

@@ -1,2 +1,2 @@
-{% set fieldLayout = fieldLayout ?? create('craft\\models\\FieldLayout') %}
+{% set fieldLayout = fieldLayout ?? create('CraftCms\\Cms\\FieldLayout\\FieldLayout') %}
 {{ cardViewDesigner(fieldLayout, _context)|raw }}

resources/templates/_includes/forms/fieldLayoutDesigner.twig

@@ -1,2 +1,2 @@
-{% set fieldLayout = fieldLayout ?? create('craft\\models\\FieldLayout') %}
+{% set fieldLayout = fieldLayout ?? create('CraftCms\\Cms\\FieldLayout\\FieldLayout') %}
 {{ fieldLayoutDesigner(fieldLayout, _context)|raw }}

resources/templates/_includes/forms/generatedFieldsTable.twig

@@ -1,2 +1,2 @@
-{% set fieldLayout = fieldLayout ?? create('craft\\models\\FieldLayout') %}
+{% set fieldLayout = fieldLayout ?? create('CraftCms\\Cms\\FieldLayout\\FieldLayout') %}
 {{ generatedFieldsTable(fieldLayout, _context)|raw }}

src/Address/Addresses.php

@@ -14,9 +14,6 @@
 use CommerceGuys\Addressing\Formatter\DefaultFormatter;
 use CommerceGuys\Addressing\Formatter\FormatterInterface;
 use Craft;
-use craft\base\FieldLayoutProviderInterface;
-use craft\models\FieldLayout;
-use craft\models\FieldLayoutTab;
 use CraftCms\Cms\Address\Elements\Address;
 use CraftCms\Cms\Address\Events\DefineAddressCountries;
 use CraftCms\Cms\Address\Events\DefineAddressFieldLabel;
@@ -25,6 +22,9 @@
 use CraftCms\Cms\Address\Events\DefineAddressUsedSubdivisionFields;
 use CraftCms\Cms\Address\Repositories\SubdivisionRepository;
 use CraftCms\Cms\Field\Fields;
+use CraftCms\Cms\FieldLayout\Contracts\FieldLayoutProviderInterface;
+use CraftCms\Cms\FieldLayout\FieldLayout;
+use CraftCms\Cms\FieldLayout\FieldLayoutTab;
 use CraftCms\Cms\ProjectConfig\Events\ConfigEvent;
 use CraftCms\Cms\ProjectConfig\ProjectConfig;
 use CraftCms\Cms\ProjectConfig\ProjectConfigHelper;

src/Address/Elements/Address.php

@@ -14,7 +14,6 @@
 use craft\elements\actions\Copy;
 use craft\elements\conditions\addresses\AddressCondition;
 use craft\elements\conditions\ElementConditionInterface;
-use craft\models\FieldLayout;
 use craft\web\twig\AllowedInSandbox;
 use CraftCms\Cms\Address\Addresses;
 use CraftCms\Cms\Address\Models\Address as AddressModel;
@@ -23,6 +22,7 @@
 use CraftCms\Cms\Database\Table;
 use CraftCms\Cms\Element\Element;
 use CraftCms\Cms\Element\Queries\AddressQuery;
+use CraftCms\Cms\FieldLayout\FieldLayout;
 use CraftCms\Cms\Shared\Concerns\HasNames;
 use CraftCms\Cms\User\Elements\User;
 use CraftCms\Cms\Validation\Attributes\Ruleset;

src/Address/Validation/AddressRules.php

@@ -4,16 +4,16 @@
 
 namespace CraftCms\Cms\Address\Validation;
 
-use craft\fieldlayoutelements\addresses\LatLongField;
-use craft\fieldlayoutelements\addresses\OrganizationField;
-use craft\fieldlayoutelements\addresses\OrganizationTaxIdField;
-use craft\fieldlayoutelements\BaseNativeField;
-use craft\fieldlayoutelements\FullNameField;
 use CraftCms\Cms\Address\Addresses;
 use CraftCms\Cms\Address\Elements\Address;
 use CraftCms\Cms\Cms;
 use CraftCms\Cms\Element\Element;
 use CraftCms\Cms\Element\Validation\ElementRules;
+use CraftCms\Cms\FieldLayout\LayoutElements\addresses\LatLongField;
+use CraftCms\Cms\FieldLayout\LayoutElements\addresses\OrganizationField;
+use CraftCms\Cms\FieldLayout\LayoutElements\addresses\OrganizationTaxIdField;
+use CraftCms\Cms\FieldLayout\LayoutElements\BaseNativeField;
+use CraftCms\Cms\FieldLayout\LayoutElements\FullNameField;
 use CraftCms\Cms\Support\Arr;
 use CraftCms\Cms\Validation\Rules\DisallowMb4;
 use Illuminate\Validation\Rule;

src/Asset/Elements/Asset.php

@@ -42,7 +42,6 @@
 use craft\helpers\ImageTransforms;
 use craft\helpers\Template;
 use craft\helpers\UrlHelper;
-use craft\models\FieldLayout;
 use craft\models\ImageTransform;
 use craft\models\Volume;
 use craft\models\VolumeFolder;
@@ -68,6 +67,7 @@
 use CraftCms\Cms\Element\Queries\AssetQuery;
 use CraftCms\Cms\Element\Queries\Contracts\ElementQueryInterface;
 use CraftCms\Cms\Field\Field;
+use CraftCms\Cms\FieldLayout\FieldLayout;
 use CraftCms\Cms\Support\Arr;
 use CraftCms\Cms\Support\Facades\I18N;
 use CraftCms\Cms\Support\Facades\Users;
@@ -84,11 +84,11 @@
 use Illuminate\Support\Facades\DB as DbFacade;
 use Illuminate\Support\Facades\Gate;
 use Illuminate\Support\Facades\Log;
+use InvalidArgumentException;
 use Override;
 use Stringable;
 use Twig\Markup;
 use yii\base\Exception;
-use yii\base\InvalidArgumentException;
 use yii\base\InvalidCallException;
 use yii\base\InvalidConfigException;
 use yii\base\NotSupportedException;
@@ -1288,7 +1288,8 @@ public function __get($name)
 
         try {
             return parent::__get($name);
-        } catch (UnknownPropertyException $e) {
+            /** @phpstan-ignore catch.neverThrown */
+        } catch (UnknownPropertyException|\CraftCms\Cms\Component\Exceptions\UnknownPropertyException $e) {
             // Is $name a transform handle?
             if (($transform = Craft::$app->getImageTransforms()->getTransformByHandle($name)) !== null) {
                 return $this->copyWithTransform($transform);

src/Asset/Validation/AssetRules.php

@@ -4,10 +4,10 @@
 
 namespace CraftCms\Cms\Asset\Validation;
 
-use craft\fieldlayoutelements\assets\AltField;
 use CraftCms\Cms\Asset\Elements\Asset;
 use CraftCms\Cms\Asset\Validation\Rules\AssetLocationRule;
 use CraftCms\Cms\Element\Validation\ElementRules;
+use CraftCms\Cms\FieldLayout\LayoutElements\assets\AltField;
 use CraftCms\Cms\Validation\Rules\DisallowMb4;
 use Illuminate\Validation\Rule;
 use Override;

src/Component/Component.php

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Component;
+
+use CraftCms\Cms\Component\Exceptions\InvalidCallException;
+use CraftCms\Cms\Component\Exceptions\UnknownPropertyException;
+use CraftCms\Cms\Support\Typecast;
+use Illuminate\Contracts\Support\Arrayable;
+use Yiisoft\Arrays\ArrayableInterface;
+use Yiisoft\Arrays\ArrayableTrait;
+
+abstract class Component implements Arrayable, ArrayableInterface
+{
+    use ArrayableTrait;
+
+    public function __construct(array $config = [])
+    {
+        Typecast::properties(static::class, $config);
+
+        self::configure($this, $config);
+    }
+
+    /**
+     * Configures a component with the initial property values.
+     *
+     * @param  self  $component  the component to be configured
+     * @param  array  $properties  the property initial values given in terms of name-value pairs.
+     * @return self the component itself
+     */
+    final public static function configure(self $component, array $properties = []): self
+    {
+        foreach ($properties as $name => $value) {
+            $component->$name = $value;
+        }
+
+        return $component;
+    }
+
+    public function __get(string $name)
+    {
+        $getter = 'get'.$name;
+
+        if (method_exists($this, $getter)) {
+            return $this->$getter();
+        }
+
+        if (method_exists($this, 'set'.$name)) {
+            throw new InvalidCallException('Getting write-only property: '.static::class.'::'.$name);
+        }
+
+        throw new UnknownPropertyException('Getting unknown property: '.static::class.'::'.$name);
+    }
+
+    public function __set(string $name, $value): void
+    {
+        $setter = 'set'.$name;
+
+        if (method_exists($this, $setter)) {
+            // set property
+            $this->$setter($value);
+
+            return;
+        }
+
+        if (method_exists($this, 'get'.$name)) {
+            throw new InvalidCallException('Setting read-only property: '.static::class.'::'.$name);
+        }
+
+        throw new UnknownPropertyException('Setting unknown property: '.static::class.'::'.$name);
+    }
+
+    public function __isset(string $name): bool
+    {
+        $getter = 'get'.$name;
+
+        if (method_exists($this, $getter)) {
+            return $this->$getter() !== null;
+        }
+
+        return false;
+    }
+
+    public function __unset(string $name): void
+    {
+        $setter = 'set'.$name;
+
+        if (method_exists($this, $setter)) {
+            $this->$setter(null);
+
+            return;
+        }
+
+        throw new InvalidCallException('Unsetting an unknown or read-only property: '.static::class.'::'.$name);
+    }
+}

src/Component/Exceptions/InvalidCallException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Component\Exceptions;
+
+use Exception;
+
+final class InvalidCallException extends Exception {}

src/Component/Exceptions/UnknownPropertyException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Component\Exceptions;
+
+use Exception;
+
+final class UnknownPropertyException extends Exception {}

src/Config/GeneralConfig.php

@@ -6219,7 +6219,7 @@ public function rememberedUserSessionDuration(mixed $value): self
         // Store the DateInterval separately for getRememberedUserSessionDuration()
         try {
             $interval = DateTimeHelper::toDateInterval($value);
-        } catch (\yii\base\InvalidArgumentException $e) {
+        } catch (InvalidArgumentException $e) {
             throw new InvalidConfigException($e->getMessage(), 0, $e);
         }