[6.x] Element compatibility improvements

src/Address/Concerns/LegacyConstants.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Address\Concerns;
+
+use Deprecated;
+
+if (! class_exists(LegacyConstants::class)) {
+    /**
+     * @internal
+     */
+    #[Deprecated(message: 'This is a hook for the yii2-adapter to define its constants.', since: '6.0.0')]
+    trait LegacyConstants {}
+}

src/Address/Elements/Address.php

@@ -9,6 +9,7 @@
 use CommerceGuys\Addressing\Country\Country;
 use CommerceGuys\Addressing\Subdivision\SubdivisionUpdater;
 use CraftCms\Cms\Address\Addresses;
+use CraftCms\Cms\Address\Concerns\LegacyConstants;
 use CraftCms\Cms\Address\Conditions\AddressCondition;
 use CraftCms\Cms\Address\Models\Address as AddressModel;
 use CraftCms\Cms\Address\Validation\AddressRules;
@@ -38,6 +39,7 @@
 class Address extends Element implements AddressInterface, NestedElementInterface
 {
     use HasNames;
+    use LegacyConstants;
     use NestedElement;
 
     public const string GQL_TYPE_NAME = 'Address';

src/Asset/Concerns/LegacyConstants.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Asset\Concerns;
+
+use Deprecated;
+
+if (! class_exists(LegacyConstants::class)) {
+    /**
+     * @internal
+     */
+    #[Deprecated(message: 'This is a hook for the yii2-adapter to define its constants.', since: '6.0.0')]
+    trait LegacyConstants {}
+}

src/Asset/Elements/Asset.php

@@ -16,6 +16,7 @@
 use CraftCms\Cms\Asset\Actions\ReplaceFile;
 use CraftCms\Cms\Asset\Actions\ShowInFolder;
 use CraftCms\Cms\Asset\AssetsHelper;
+use CraftCms\Cms\Asset\Concerns\LegacyConstants;
 use CraftCms\Cms\Asset\Conditions\AssetCondition;
 use CraftCms\Cms\Asset\Data\Volume;
 use CraftCms\Cms\Asset\Data\VolumeFolder;
@@ -138,6 +139,8 @@
 #[Ruleset(AssetRules::class)]
 class Asset extends Element
 {
+    use LegacyConstants;
+
     // Location error codes
     // -------------------------------------------------------------------------
 

src/Element/Concerns/LegacyNestedElementManager.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Element\Concerns;
+
+use Deprecated;
+
+if (! class_exists(LegacyNestedElementManager::class)) {
+    /**
+     * @internal
+     */
+    #[Deprecated(message: 'This is a hook for the yii2-adapter to define its constants.', since: '6.0.0')]
+    trait LegacyNestedElementManager {}
+}

src/Element/NestedElementManager.php

@@ -14,6 +14,7 @@
 use CraftCms\Cms\Element\Actions\ChangeSortOrder;
 use CraftCms\Cms\Element\Actions\MoveDown;
 use CraftCms\Cms\Element\Actions\MoveUp;
+use CraftCms\Cms\Element\Concerns\LegacyNestedElementManager;
 use CraftCms\Cms\Element\Contracts\ElementInterface;
 use CraftCms\Cms\Element\Contracts\NestedElementInterface;
 use CraftCms\Cms\Element\Enums\PropagationMethod;
@@ -50,6 +51,8 @@
  */
 class NestedElementManager extends Component
 {
+    use LegacyNestedElementManager;
+
     private const string VIEW_MODE_CARDS = 'cards';
 
     private const string VIEW_MODE_INDEX = 'index';

src/Entry/Concerns/LegacyConstants.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Entry\Concerns;
+
+use Deprecated;
+
+if (! class_exists(LegacyConstants::class)) {
+    /**
+     * @internal
+     */
+    #[Deprecated(message: 'This is a hook for the yii2-adapter to define its constants.', since: '6.0.0')]
+    trait LegacyConstants {}
+}

src/Entry/Elements/Entry.php

@@ -36,6 +36,7 @@
 use CraftCms\Cms\Entry\Actions\NewChild;
 use CraftCms\Cms\Entry\Actions\NewSiblingAfter;
 use CraftCms\Cms\Entry\Actions\NewSiblingBefore;
+use CraftCms\Cms\Entry\Concerns\LegacyConstants;
 use CraftCms\Cms\Entry\Conditions\EntryCondition;
 use CraftCms\Cms\Entry\Conditions\SectionConditionRule;
 use CraftCms\Cms\Entry\Conditions\TypeConditionRule;
@@ -108,6 +109,7 @@
 #[Ruleset(EntryRules::class)]
 class Entry extends Element implements Colorable, ExpirableElementInterface, Iconic, NestedElementInterface
 {
+    use LegacyConstants;
     use NestedElement {
         eagerLoadingMap as traitEagerLoadingMap;
         attributes as traitAttributes;

src/Field/Elements/Concerns/LegacyConstants.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Field\Elements\Concerns;
+
+use Deprecated;
+
+if (! class_exists(LegacyConstants::class)) {
+    /**
+     * @internal
+     */
+    #[Deprecated(message: 'This is a hook for the yii2-adapter to define its constants.', since: '6.0.0')]
+    trait LegacyConstants {}
+}

src/Field/Elements/ContentBlock.php

@@ -10,6 +10,7 @@
 use CraftCms\Cms\Element\Element;
 use CraftCms\Cms\Element\Queries\ContentBlockQuery;
 use CraftCms\Cms\Field\ContentBlock as ContentBlockField;
+use CraftCms\Cms\Field\Elements\Concerns\LegacyConstants;
 use CraftCms\Cms\Field\Fields;
 use CraftCms\Cms\Field\Models\ContentBlock as ContentBlockModel;
 use CraftCms\Cms\FieldLayout\FieldLayout;
@@ -26,6 +27,7 @@
 #[Ruleset(ContentBlockRules::class)]
 class ContentBlock extends Element implements NestedElementInterface
 {
+    use LegacyConstants;
     use NestedElement;
 
     #[Override]

src/User/Concerns/LegacyConstants.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\User\Concerns;
+
+use Deprecated;
+
+if (! class_exists(LegacyConstants::class)) {
+    /**
+     * @internal
+     */
+    #[Deprecated(message: 'This is a hook for the yii2-adapter to define its constants.', since: '6.0.0')]
+    trait LegacyConstants {}
+}

src/User/Elements/User.php

@@ -52,6 +52,7 @@
 use CraftCms\Cms\User\Actions\DeleteUsers;
 use CraftCms\Cms\User\Actions\SuspendUsers;
 use CraftCms\Cms\User\Actions\UnsuspendUsers;
+use CraftCms\Cms\User\Concerns\LegacyConstants;
 use CraftCms\Cms\User\Conditions\UserCondition;
 use CraftCms\Cms\User\Data\UserGroup;
 use CraftCms\Cms\User\Events\UserFriendlyNameResolving;
@@ -110,6 +111,7 @@ class User extends Element implements AuthenticatableContract, AuthorizableContr
     use CanResetPassword;
     use ConfirmsPasswords;
     use HasNames;
+    use LegacyConstants;
     use Macroable;
     use Notifiable;
 

yii2-adapter/composer.json

@@ -82,6 +82,7 @@
   "autoload": {
     "psr-4": {
       "craft\\": "legacy/",
+      "CraftCms\\Cms\\": "constants/",
       "CraftCms\\Yii2Adapter\\": "src/",
       "yii2tech\\ar\\softdelete\\": "lib/ar-softdelete/src/"
     }

yii2-adapter/constants/Address/Concerns/LegacyConstants.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+namespace CraftCms\Cms\Address\Concerns;
+
+use CommerceGuys\Addressing\AddressFormat\AddressField;
+use craft\base\ElementEventConstants;
+use CraftCms\Cms\Address\Addresses;
+use Deprecated;
+
+/**
+ * @internal
+ * @deprecated 6.0.0
+ */
+trait LegacyConstants
+{
+    use ElementEventConstants;
+
+    /**
+     * Returns an address attribute label.
+     */
+    #[Deprecated(message: 'in 4.3.0. [[\craft\services\Addresses::getFieldLabel()]] should be used instead.')]
+    public static function addressAttributeLabel(string $attribute, string $countryCode): ?string
+    {
+        if (!AddressField::exists($attribute)) {
+            return null;
+        }
+
+        /** @phpstan-var AddressField::* $attribute */
+        return app(Addresses::class)->getFieldLabel($attribute, $countryCode);
+    }
+}