BAP-21474: Extended Entities Without Code Generation (#33445)

The approach to expanding entities has been changed, instead of generating additional fields and associations, the new approach uses PHP magic methods to access.
Implementation:
      -  ExtendEntityTrait
      -  ExtendEntityInterface
      -  EntityFieldExtensionInterface
      -  ExtendedEntityFieldsProcessor

For the full list of changes see the [OroPlatform Changelog for 5.1 LTS version](https://github.com/oroinc/platform/blob/master/CHANGELOG.md#510-unreleased).

Co-authored-by: Andrii Yatsenko [[email protected]](mailto:[email protected])
Co-authored-by: Victor Tihonchuk [[email protected]](mailto:[email protected])

Author: timofiyprisyazhnyuk

bootstrap_test.php

@@ -0,0 +1,7 @@
+<?php
+
+use Oro\Bundle\EntityExtendBundle\Test\EntityExtendTestInitializer;
+
+require __DIR__.'/vendor/autoload.php';
+
+EntityExtendTestInitializer::initialize();

phpunit.xml.dist

@@ -6,7 +6,7 @@
         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
         backupGlobals="false"
         backupStaticAttributes="false"
-        bootstrap="vendor/autoload.php"
+        bootstrap="bootstrap_test.php"
         stopOnError="false"
         stopOnFailure="false"
         stopOnWarning="false"

src/Oro/Bundle/CMSBundle/ContentVariantType/CmsPageContentVariantType.php

@@ -9,6 +9,7 @@
 use Oro\Component\WebCatalog\ContentVariantTypeInterface;
 use Oro\Component\WebCatalog\Entity\ContentVariantInterface;
 use Symfony\Component\PropertyAccess\PropertyAccessor;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 
 /**
@@ -26,7 +27,7 @@ class CmsPageContentVariantType implements ContentVariantTypeInterface, ContentV
 
     public function __construct(
         AuthorizationCheckerInterface $authorizationChecker,
-        PropertyAccessor $propertyAccessor
+        PropertyAccessorInterface $propertyAccessor
     ) {
         $this->authorizationChecker = $authorizationChecker;
         $this->propertyAccessor = $propertyAccessor;

src/Oro/Bundle/CMSBundle/Entity/ContentBlock.php

@@ -4,11 +4,13 @@
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Mapping as ORM;
-use Oro\Bundle\CMSBundle\Model\ExtendContentBlock;
 use Oro\Bundle\EntityBundle\EntityProperty\DatesAwareInterface;
 use Oro\Bundle\EntityBundle\EntityProperty\DatesAwareTrait;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityInterface;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityTrait;
+use Oro\Bundle\LocaleBundle\Entity\Localization;
 use Oro\Bundle\LocaleBundle\Entity\LocalizedFallbackValue;
 use Oro\Bundle\OrganizationBundle\Entity\OrganizationAwareInterface;
 use Oro\Bundle\OrganizationBundle\Entity\Ownership\BusinessUnitAwareTrait;
@@ -37,13 +39,17 @@
  *          }
  *     }
  * )
+ * @method LocalizedFallbackValue getDefaultTitle()
+ * @method LocalizedFallbackValue getTitle(Localization $localization = null)
  */
-class ContentBlock extends ExtendContentBlock implements
+class ContentBlock implements
     DatesAwareInterface,
-    OrganizationAwareInterface
+    OrganizationAwareInterface,
+    ExtendEntityInterface
 {
     use BusinessUnitAwareTrait;
     use DatesAwareTrait;
+    use ExtendEntityTrait;
 
     /**
      * @var int
@@ -137,8 +143,6 @@ class ContentBlock extends ExtendContentBlock implements
      */
     public function __construct()
     {
-        parent::__construct();
-
         $this->titles = new ArrayCollection();
         $this->scopes = new ArrayCollection();
         $this->contentVariants = new ArrayCollection();

src/Oro/Bundle/CMSBundle/Entity/ContentTemplate.php

@@ -3,11 +3,12 @@
 namespace Oro\Bundle\CMSBundle\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
-use Oro\Bundle\CMSBundle\Model\ExtendContentTemplate;
 use Oro\Bundle\EntityBundle\EntityProperty\DatesAwareInterface;
 use Oro\Bundle\EntityBundle\EntityProperty\DatesAwareTrait;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityInterface;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityTrait;
 use Oro\Bundle\OrganizationBundle\Entity\OrganizationAwareInterface;
 use Oro\Bundle\UserBundle\Entity\Ownership\UserAwareTrait;
 
@@ -44,10 +45,11 @@
  *      }
  * )
  */
-class ContentTemplate extends ExtendContentTemplate implements DatesAwareInterface, OrganizationAwareInterface
+class ContentTemplate implements DatesAwareInterface, OrganizationAwareInterface, ExtendEntityInterface
 {
     use DatesAwareTrait;
     use UserAwareTrait;
+    use ExtendEntityTrait;
 
     /**
      * @ORM\Id

src/Oro/Bundle/CMSBundle/Entity/ImageSlide.php

@@ -3,9 +3,11 @@
 namespace Oro\Bundle\CMSBundle\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
-use Oro\Bundle\CMSBundle\Model\ExtendImageSlide;
+use Oro\Bundle\AttachmentBundle\Entity\File;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityInterface;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityTrait;
 use Oro\Bundle\OrganizationBundle\Entity\OrganizationAwareInterface;
 use Oro\Bundle\OrganizationBundle\Entity\Ownership\OrganizationAwareTrait;
 
@@ -30,10 +32,17 @@
  *          }
  *     }
  * )
+ * @method null|File getMainImage()
+ * @method ImageSlide setMainImage(File $image)
+ * @method null|File getMediumImage()
+ * @method ImageSlide setMediumImage(File $image)
+ * @method null|File getSmallImage()
+ * @method ImageSlide setSmallImage(File $image)
  */
-class ImageSlide extends ExtendImageSlide implements OrganizationAwareInterface
+class ImageSlide implements OrganizationAwareInterface, ExtendEntityInterface
 {
     use OrganizationAwareTrait;
+    use ExtendEntityTrait;
 
     public const TEXT_ALIGNMENT_CENTER = 'center';
     public const TEXT_ALIGNMENT_LEFT = 'left';

src/Oro/Bundle/CMSBundle/Entity/LoginPage.php

@@ -3,11 +3,15 @@
 namespace Oro\Bundle\CMSBundle\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
-use Oro\Bundle\CMSBundle\Model\ExtendLoginPage;
+use Oro\Bundle\AttachmentBundle\Entity\File;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityInterface;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityTrait;
 
 /**
+ * Login page entity class.
+ *
  * @ORM\Table(name="oro_cms_login_page")
  * @ORM\Entity()
  * @Config(
@@ -26,9 +30,15 @@
  *          }
  *      }
  * )
+ * @method File getLogoImage()
+ * @method LoginPage setLogoImage(File $image)
+ * @method File getBackgroundImage()
+ * @method LoginPage setBackgroundImage(File $image)
  */
-class LoginPage extends ExtendLoginPage
+class LoginPage implements ExtendEntityInterface
 {
+    use ExtendEntityTrait;
+
     /**
      * @var integer
      *

src/Oro/Bundle/CMSBundle/Entity/Page.php

@@ -5,13 +5,15 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
-use Oro\Bundle\CMSBundle\Model\ExtendPage;
 use Oro\Bundle\DraftBundle\Entity\DraftableInterface;
 use Oro\Bundle\DraftBundle\Entity\DraftableTrait;
 use Oro\Bundle\EntityBundle\EntityProperty\DatesAwareInterface;
 use Oro\Bundle\EntityBundle\EntityProperty\DatesAwareTrait;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityInterface;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityTrait;
+use Oro\Bundle\LocaleBundle\Entity\Localization;
 use Oro\Bundle\LocaleBundle\Entity\LocalizedFallbackValue;
 use Oro\Bundle\OrganizationBundle\Entity\OrganizationAwareInterface;
 use Oro\Bundle\OrganizationBundle\Entity\Ownership\AuditableOrganizationAwareTrait;
@@ -87,17 +89,26 @@
  *          }
  *      }
  * )
+ * @method LocalizedFallbackValue getTitle(Localization $localization = null)
+ * @method LocalizedFallbackValue getDefaultTitle()
+ * @method LocalizedFallbackValue getSlug(Localization $localization = null)
+ * @method LocalizedFallbackValue getDefaultSlug()
+ * @method setDefaultTitle($title)
+ * @method setDefaultSlug($slug)
+ * @method $this cloneLocalizedFallbackValueAssociations()
  */
-class Page extends ExtendPage implements
+class Page implements
     DatesAwareInterface,
     SluggableInterface,
     DraftableInterface,
-    OrganizationAwareInterface
+    OrganizationAwareInterface,
+    ExtendEntityInterface
 {
     use AuditableOrganizationAwareTrait;
     use DatesAwareTrait;
     use SluggableTrait;
     use DraftableTrait;
+    use ExtendEntityTrait;
 
     /**
      * @var integer
@@ -163,8 +174,6 @@ class Page extends ExtendPage implements
      */
     public function __construct()
     {
-        parent::__construct();
-
         $this->slugPrototypes = new ArrayCollection();
         $this->slugs = new ArrayCollection();
         $this->titles = new ArrayCollection();
@@ -245,7 +254,7 @@ public function __toString()
     public function __clone()
     {
         if ($this->id) {
-            $this->cloneLocalizedFallbackValueAssociations();
+            $this->cloneExtendEntityStorage();
         }
     }
 }

src/Oro/Bundle/CMSBundle/Entity/TabbedContentItem.php

@@ -3,11 +3,12 @@
 namespace Oro\Bundle\CMSBundle\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
-use Oro\Bundle\CMSBundle\Model\ExtendTabbedContentItem;
 use Oro\Bundle\EntityBundle\EntityProperty\DatesAwareInterface;
 use Oro\Bundle\EntityBundle\EntityProperty\DatesAwareTrait;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\Config;
 use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityInterface;
+use Oro\Bundle\EntityExtendBundle\Entity\ExtendEntityTrait;
 use Oro\Bundle\OrganizationBundle\Entity\OrganizationAwareInterface;
 use Oro\Bundle\OrganizationBundle\Entity\Ownership\OrganizationAwareTrait;
 
@@ -33,10 +34,14 @@
  *     }
  * )
  */
-class TabbedContentItem extends ExtendTabbedContentItem implements OrganizationAwareInterface, DatesAwareInterface
+class TabbedContentItem implements
+    OrganizationAwareInterface,
+    DatesAwareInterface,
+    ExtendEntityInterface
 {
     use OrganizationAwareTrait;
     use DatesAwareTrait;
+    use ExtendEntityTrait;
 
     /**
      * @ORM\Column(type="integer")

src/Oro/Bundle/CMSBundle/ImportExport/Normalizer/LocalizedFallbackValueCollectionNormalizer.php

@@ -2,6 +2,7 @@
 
 namespace Oro\Bundle\CMSBundle\ImportExport\Normalizer;
 
+use Oro\Bundle\EntityExtendBundle\EntityPropertyInfo;
 use Oro\Bundle\LocaleBundle\Entity\LocalizedFallbackValue;
 use Oro\Bundle\LocaleBundle\ImportExport\Normalizer\LocalizationCodeFormatter;
 use Oro\Bundle\LocaleBundle\ImportExport\Normalizer\LocalizedFallbackValueCollectionNormalizer as BaseNormalizer;
@@ -21,7 +22,9 @@ public function normalize($object, string $format = null, array $context = []):
         foreach ($object as $item) {
             $key = LocalizationCodeFormatter::formatName($item->getLocalization());
 
-            $result[$key]['wysiwyg'] = method_exists($item, 'getWysiwyg') ? $item->getWysiwyg() : null;
+            $result[$key]['wysiwyg'] = EntityPropertyInfo::methodExists($item, 'getWysiwyg')
+                ? $item->getWysiwyg()
+                : null;
         }
 
         return $result;
@@ -42,7 +45,7 @@ public function denormalize($data, string $type, string $format = null, array $c
                 /** @var LocalizedFallbackValue $object */
                 $object = $result->get($localizationName);
 
-                if (method_exists($object, 'getWysiwyg')) {
+                if (EntityPropertyInfo::methodExists($object, 'setWysiwyg')) {
                     $object->setWysiwyg((string)$item['wysiwyg']);
                 }
             }