ACP2E-3864: Update copyrights for PB and fix static failures

aplapana · aplapana · commit 66a476b41a4f · 2025-05-09T15:10:56.000+03:00
diff --git a/app/code/Magento/PageBuilder/Api/Data/TemplateInterface.php b/app/code/Magento/PageBuilder/Api/Data/TemplateInterface.php
@@ -15,19 +15,19 @@
  */
 interface TemplateInterface extends ExtensibleDataInterface
 {
-    const KEY_ID = 'template_id';
+    public const KEY_ID = 'template_id';
 
-    const KEY_NAME = 'name';
+    public const KEY_NAME = 'name';
 
-    const KEY_PREVIEW_IMAGE = 'preview_image';
+    public const KEY_PREVIEW_IMAGE = 'preview_image';
 
-    const KEY_TEMPLATE = 'template';
+    public const KEY_TEMPLATE = 'template';
 
-    const KEY_CREATED_FOR = 'created_for';
+    public const KEY_CREATED_FOR = 'created_for';
 
-    const KEY_CREATED_AT = 'created_at';
+    public const KEY_CREATED_AT = 'created_at';
 
-    const KEY_UPDATED_AT = 'updated_at';
+    public const KEY_UPDATED_AT = 'updated_at';
 
     /**
      * Get Template ID
diff --git a/app/code/Magento/PageBuilder/Block/Adminhtml/ContentType/Edit/CancelButton.php b/app/code/Magento/PageBuilder/Block/Adminhtml/ContentType/Edit/CancelButton.php
@@ -25,7 +25,7 @@ class CancelButton implements ButtonProviderInterface
     /**
      * Constructor
      *
-     * @param $targetName
+     * @param string $targetName
      */
     public function __construct(string $targetName)
     {
diff --git a/app/code/Magento/PageBuilder/Block/Adminhtml/ContentType/Edit/CloseButton.php b/app/code/Magento/PageBuilder/Block/Adminhtml/ContentType/Edit/CloseButton.php
@@ -24,7 +24,7 @@ class CloseButton implements ButtonProviderInterface
     /**
      * Constructor
      *
-     * @param $targetName
+     * @param string $targetName
      */
     public function __construct(string $targetName)
     {
diff --git a/app/code/Magento/PageBuilder/Block/Adminhtml/System/Config/EnableField.php b/app/code/Magento/PageBuilder/Block/Adminhtml/System/Config/EnableField.php
@@ -36,7 +36,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     protected function _getElementHtml(AbstractElement $element)
     {
diff --git a/app/code/Magento/PageBuilder/Block/Adminhtml/System/Config/SwitchAttributeType.php b/app/code/Magento/PageBuilder/Block/Adminhtml/System/Config/SwitchAttributeType.php
@@ -8,7 +8,6 @@
 
 namespace Magento\PageBuilder\Block\Adminhtml\System\Config;
 
-use Magento\Backend\Block\Template\Context;
 use Magento\Config\Block\System\Config\Form\Field;
 use Magento\Framework\Phrase;
 
@@ -19,17 +18,6 @@
  */
 class SwitchAttributeType extends Field
 {
-    /**
-     * @param Context $context
-     * @param array $data
-     */
-    public function __construct(
-        Context $context,
-        array $data = []
-    ) {
-        parent::__construct($context, $data);
-    }
-
     /**
      * Get text for the modal title heading when user switches to disable
      *
diff --git a/app/code/Magento/PageBuilder/Block/Catalog/Block/Product/View/Attributes.php b/app/code/Magento/PageBuilder/Block/Catalog/Block/Product/View/Attributes.php
@@ -14,9 +14,9 @@
  */
 class Attributes extends \Magento\Catalog\Block\Product\View\Attributes
 {
-    const DISPLAY_ATTRIBUTES_NON_PAGEBUILDER = 'non_pagebuilder';
+    public const DISPLAY_ATTRIBUTES_NON_PAGEBUILDER = 'non_pagebuilder';
 
-    const DISPLAY_ATTRIBUTES_PAGEBUILDER_ONLY = 'pagebuilder_only';
+    public const DISPLAY_ATTRIBUTES_PAGEBUILDER_ONLY = 'pagebuilder_only';
 
     /**
      * @inheritdoc
diff --git a/app/code/Magento/PageBuilder/Block/Element/Editor.php b/app/code/Magento/PageBuilder/Block/Element/Editor.php
@@ -15,7 +15,7 @@
 class Editor extends \Magento\Framework\Data\Form\Element\Editor
 {
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getElementHtml()
     {
@@ -27,7 +27,7 @@ public function getElementHtml()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function isEnabled()
     {
@@ -48,7 +48,7 @@ protected function isStageEnabled() : bool
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     protected function getInlineJs($jsSetupObject, $forceLoad)
     {
diff --git a/app/code/Magento/PageBuilder/Component/GoogleMapsApiKeyValidationContainer.php b/app/code/Magento/PageBuilder/Component/GoogleMapsApiKeyValidationContainer.php
@@ -20,7 +20,7 @@
  */
 class GoogleMapsApiKeyValidationContainer extends \Magento\Ui\Component\Container
 {
-    const GOOGLE_MAPS_API_KEY_PATH = 'cms/pagebuilder/google_maps_api_key';
+    public const GOOGLE_MAPS_API_KEY_PATH = 'cms/pagebuilder/google_maps_api_key';
 
     /**
      * @var UrlInterface
diff --git a/app/code/Magento/PageBuilder/Controller/Adminhtml/ContentType/Block/Metadata.php b/app/code/Magento/PageBuilder/Controller/Adminhtml/ContentType/Block/Metadata.php
@@ -10,12 +10,15 @@
 
 use Magento\Framework\Controller\ResultFactory;
 
+/**
+ * @SuppressWarnings(PHPMD.AllPurposeAction)
+ */
 class Metadata extends \Magento\Backend\App\AbstractAction
 {
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
-    const ADMIN_RESOURCE = 'Magento_Cms::block';
+    public const ADMIN_RESOURCE = 'Magento_Cms::block';
 
     /**
      * @var \Magento\Cms\Model\ResourceModel\Block\CollectionFactory
@@ -36,6 +39,9 @@ public function __construct(
         $this->blockCollectionFactory = $blockCollectionFactory;
     }
 
+    /**
+     * @inheritDoc
+     */
     public function execute()
     {
         $params = $this->getRequest()->getParams();
diff --git a/app/code/Magento/PageBuilder/Controller/Adminhtml/Form/Element/ProductConditions.php b/app/code/Magento/PageBuilder/Controller/Adminhtml/Form/Element/ProductConditions.php
@@ -12,6 +12,7 @@
 
 /**
  * Responsible for rendering the top-level conditions rule tree using the provided params
+ * @SuppressWarnings(PHPMD.AllPurposeAction)
  */
 class ProductConditions extends \Magento\CatalogWidget\Controller\Adminhtml\Product\Widget
 {
@@ -41,7 +42,7 @@ public function __construct(
     }
 
     /**
-     * @return void
+     * @inheritDoc
      */
     public function execute()
     {
diff --git a/app/code/Magento/PageBuilder/Controller/Adminhtml/GoogleMaps/ValidateApi.php b/app/code/Magento/PageBuilder/Controller/Adminhtml/GoogleMaps/ValidateApi.php
@@ -9,12 +9,9 @@
 
 use Magento\Framework\Controller\ResultFactory;
 
-/**
- * Class ValidateApi
- */
 class ValidateApi extends \Magento\Backend\App\Action implements \Magento\Framework\App\Action\HttpPostActionInterface
 {
-    const ADMIN_RESOURCE = 'Magento_Backend::content';
+    public const ADMIN_RESOURCE = 'Magento_Backend::content';
 
     /**
      * @var \Magento\PageBuilder\Model\GoogleMaps\ApiKeyValidator
diff --git a/app/code/Magento/PageBuilder/Controller/Adminhtml/Stage/Preview.php b/app/code/Magento/PageBuilder/Controller/Adminhtml/Stage/Preview.php
@@ -16,7 +16,7 @@
  */
 class Preview extends \Magento\Backend\App\Action implements HttpPostActionInterface
 {
-    const ADMIN_RESOURCE = 'Magento_Backend::content';
+    public const ADMIN_RESOURCE = 'Magento_Backend::content';
 
     /**
      * @var \Magento\PageBuilder\Model\Stage\RendererPool
diff --git a/app/code/Magento/PageBuilder/Controller/Adminhtml/Template/Index.php b/app/code/Magento/PageBuilder/Controller/Adminhtml/Template/Index.php
@@ -20,7 +20,7 @@
  */
 class Index extends Action implements HttpGetActionInterface
 {
-    const ADMIN_RESOURCE = 'Magento_PageBuilder::templates';
+    public const ADMIN_RESOURCE = 'Magento_PageBuilder::templates';
 
     /**
      * @var PageFactory
diff --git a/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Factory.php b/app/code/Magento/PageBuilder/Model/Catalog/Sorting/Factory.php
@@ -8,9 +8,6 @@
 
 namespace Magento\PageBuilder\Model\Catalog\Sorting;
 
-/**
- * Class Factory
- */
 class Factory
 {
     /**
diff --git a/app/code/Magento/PageBuilder/Model/Config.php b/app/code/Magento/PageBuilder/Model/Config.php
@@ -15,7 +15,7 @@
  */
 class Config extends \Magento\Framework\Config\Data implements \Magento\PageBuilder\Model\ConfigInterface
 {
-    const IS_PAGEBUILDER_ENABLED = 'cms/pagebuilder/enabled';
+    public const IS_PAGEBUILDER_ENABLED = 'cms/pagebuilder/enabled';
 
     private const IS_PAGEBUILDER_CONTENT_PREVIEW_ENABLED = 'cms/pagebuilder/enable_content_preview';
 
diff --git a/app/code/Magento/PageBuilder/Model/Config/ContentType/AdditionalData/ProviderInterface.php b/app/code/Magento/PageBuilder/Model/Config/ContentType/AdditionalData/ProviderInterface.php
@@ -17,6 +17,7 @@ interface ProviderInterface
 {
     /**
      * Get data from the provider
+     *
      * @param string $itemName - the name of the item to use as key in returned array
      * @return array
      */
diff --git a/app/code/Magento/PageBuilder/Model/Config/ContentType/Converter.php b/app/code/Magento/PageBuilder/Model/Config/ContentType/Converter.php
@@ -15,8 +15,8 @@
  */
 class Converter implements \Magento\Framework\Config\ConverterInterface
 {
-    const DEFAULT_ATTRIBUTE_READER = 'Magento_PageBuilder/js/property/attribute-reader';
-    const DEFAULT_PROPERTY_READER = 'Magento_PageBuilder/js/property/style-property-reader';
+    public const DEFAULT_ATTRIBUTE_READER = 'Magento_PageBuilder/js/property/attribute-reader';
+    public const DEFAULT_PROPERTY_READER = 'Magento_PageBuilder/js/property/style-property-reader';
 
     /**
      * @var ArgumentParser
@@ -25,6 +25,7 @@ class Converter implements \Magento\Framework\Config\ConverterInterface
 
     /**
      * Converter constructor.
+     *
      * @param ArgumentParser $parser
      */
     public function __construct(
@@ -529,6 +530,7 @@ private function convertParentsToAllowedParents(
         array $types,
         array $allowedParentsData
     ): array {
+        $baseAllowedTypes = $types;
         foreach ($parentChildData as $key => $value) {
             $parent = $value['parents'] ?? [];
 
@@ -542,7 +544,7 @@ private function convertParentsToAllowedParents(
             if ($parent['defaultPolicy'] === 'deny') {
                 $allowedParents = $allowedTypes;
             } else {
-                $allowedParents = array_merge($types, $allowedTypes);
+                $allowedParents = [...$baseAllowedTypes, ...$allowedTypes];
                 foreach ($deniedTypes as $type) {
                     $allowedParents = $this->removeDataInArray($type, $allowedParents);
                 }
diff --git a/app/code/Magento/PageBuilder/Model/Config/ContentType/Reader.php b/app/code/Magento/PageBuilder/Model/Config/ContentType/Reader.php
@@ -10,8 +10,8 @@
 
 class Reader extends \Magento\Framework\Config\Reader\Filesystem
 {
-    const TYPE_PATH = '/config/type';
-    
+    public const TYPE_PATH = '/config/type';
+
     /**
      * List of id attributes for merge
      *
@@ -50,6 +50,7 @@ class Reader extends \Magento\Framework\Config\Reader\Filesystem
      * @param array $idAttributes
      * @param string $domDocumentClass
      * @param string $defaultScope
+     * phpcs:disable Generic.CodeAnalysis.UselessOverridingMethod.Found
      */
     public function __construct(
         \Magento\PageBuilder\Model\Config\FileResolver $fileResolver,
diff --git a/app/code/Magento/PageBuilder/Model/Config/FileResolver.php b/app/code/Magento/PageBuilder/Model/Config/FileResolver.php
@@ -45,7 +45,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function get($filename, $scope): array
     {
@@ -54,7 +54,9 @@ public function get($filename, $scope): array
         $files = $this->baseFiles->getFiles($this->design->getDesignTheme(), $filename);
         foreach ($files as $file) {
             $fullFileName = $file->getFileName();
+            // phpcs:ignore Magento2.Functions.DiscouragedFunction
             $fileDir = dirname($fullFileName);
+            // phpcs:ignore Magento2.Functions.DiscouragedFunction
             $fileName = basename($fullFileName);
             $dirRead = $this->readFactory->create($fileDir);
             $result[$fullFileName] = $dirRead->readFile($fileName);
diff --git a/app/code/Magento/PageBuilder/Model/Config/MenuSection/Reader.php b/app/code/Magento/PageBuilder/Model/Config/MenuSection/Reader.php
@@ -33,6 +33,7 @@ class Reader extends \Magento\Framework\Config\Reader\Filesystem
      * @param array $idAttributes
      * @param string $domDocumentClass
      * @param string $defaultScope
+     * phpcs:disable Generic.CodeAnalysis.UselessOverridingMethod.Found
      */
     public function __construct(
         \Magento\PageBuilder\Model\Config\FileResolver $fileResolver,
diff --git a/app/code/Magento/PageBuilder/Model/GoogleMaps/ApiKeyValidator.php b/app/code/Magento/PageBuilder/Model/GoogleMaps/ApiKeyValidator.php
@@ -9,7 +9,7 @@
 
 class ApiKeyValidator
 {
-    const GOOGLE_MAPS_EMBED_URL = 'https://www.google.com/maps/embed/v1/place?key=%s&q=Austin+TX';
+    public const GOOGLE_MAPS_EMBED_URL = 'https://www.google.com/maps/embed/v1/place?key=%s&q=Austin+TX';
 
     /**
      * Send test request to Google Maps and return response
@@ -20,9 +20,13 @@ class ApiKeyValidator
     public function validate(string $apiKey): array
     {
         $testUrl = sprintf(self::GOOGLE_MAPS_EMBED_URL, $apiKey);
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
         $curl = curl_init($testUrl);
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
         curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
         $result = curl_exec($curl);
+        // phpcs:ignore Magento2.Functions.DiscouragedFunction
         $responseCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
         $returnArray = [
             'responseMessage' => $responseCode !== 200 ? $result : '',
diff --git a/app/code/Magento/PageBuilder/Model/State.php b/app/code/Magento/PageBuilder/Model/State.php
@@ -25,7 +25,8 @@ public function __construct(Config $config)
 
     /**
      * Returns information if use page builder based on system configuration and xml configuration
-     * @param $isPageBuilderUsed
+     *
+     * @param mixed $isPageBuilderUsed
      * @return bool
      */
     public function isPageBuilderInUse($isPageBuilderUsed) : bool
diff --git a/app/code/Magento/PageBuilder/Model/Template.php b/app/code/Magento/PageBuilder/Model/Template.php
@@ -18,6 +18,9 @@
  */
 class Template extends AbstractExtensibleModel implements TemplateInterface
 {
+    /**
+     * @var string
+     */
     protected $_eventPrefix = 'pagebuilder_template';
 
     /**
diff --git a/app/code/Magento/PageBuilder/Model/Template/Source/TemplateTypes.php b/app/code/Magento/PageBuilder/Model/Template/Source/TemplateTypes.php
@@ -35,6 +35,7 @@ public function __construct(Config $config)
     public function toOptionArray()
     {
         $templateTypes = $this->config->getConfig()['stage_config']['template_types'];
+        $options = [];
         foreach ($templateTypes as $key => $value) {
             $options[] = [
                 'label' => $value,
diff --git a/app/code/Magento/PageBuilder/Model/Wysiwyg/InlineEditingSupportedAdapterList.php b/app/code/Magento/PageBuilder/Model/Wysiwyg/InlineEditingSupportedAdapterList.php
@@ -37,6 +37,7 @@ public function __construct(
 
     /**
      * Check if inline editing available for current adapter
+     *
      * @param string $editorPath
      * @return bool
      */

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class CancelButton implements ButtonProviderInterface`
`25`	`25`	`/**`
`26`	`26`	`* Constructor`
`27`	`27`	`*`
`28`		`- * @param $targetName`
	`28`	`+ * @param string $targetName`
`29`	`29`	`*/`
`30`	`30`	`public function __construct(string $targetName)`
`31`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class CloseButton implements ButtonProviderInterface`
`24`	`24`	`/**`
`25`	`25`	`* Constructor`
`26`	`26`	`*`
`27`		`- * @param $targetName`
	`27`	`+ * @param string $targetName`
`28`	`28`	`*/`
`29`	`29`	`public function __construct(string $targetName)`
`30`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function __construct(`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`/**`
`39`		`- * {@inheritdoc}`
	`39`	`+ * @inheritdoc`
`40`	`40`	`*/`
`41`	`41`	`protected function _getElementHtml(AbstractElement $element)`
`42`	`42`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`class Editor extends \Magento\Framework\Data\Form\Element\Editor`
`16`	`16`	`{`
`17`	`17`	`/**`
`18`		`- * {@inheritdoc}`
	`18`	`+ * @inheritdoc`
`19`	`19`	`*/`
`20`	`20`	`public function getElementHtml()`
`21`	`21`	`{`
`@@ -27,7 +27,7 @@ public function getElementHtml()`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * {@inheritdoc}`
	`30`	`+ * @inheritdoc`
`31`	`31`	`*/`
`32`	`32`	`public function isEnabled()`
`33`	`33`	`{`
`@@ -48,7 +48,7 @@ protected function isStageEnabled() : bool`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`/**`
`51`		`- * {@inheritdoc}`
	`51`	`+ * @inheritdoc`
`52`	`52`	`*/`
`53`	`53`	`protected function getInlineJs($jsSetupObject, $forceLoad)`
`54`	`54`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*/`
`21`	`21`	`class GoogleMapsApiKeyValidationContainer extends \Magento\Ui\Component\Container`
`22`	`22`	`{`
`23`		`- const GOOGLE_MAPS_API_KEY_PATH = 'cms/pagebuilder/google_maps_api_key';`
	`23`	`+ public const GOOGLE_MAPS_API_KEY_PATH = 'cms/pagebuilder/google_maps_api_key';`
`24`	`24`
`25`	`25`	`/**`
`26`	`26`	`* @var UrlInterface`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* Responsible for rendering the top-level conditions rule tree using the provided params`
	`15`	`+ * @SuppressWarnings(PHPMD.AllPurposeAction)`
`15`	`16`	`*/`
`16`	`17`	`class ProductConditions extends \Magento\CatalogWidget\Controller\Adminhtml\Product\Widget`
`17`	`18`	`{`
`@@ -41,7 +42,7 @@ public function __construct(`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`/**`
`44`		`- * @return void`
	`45`	`+ * @inheritDoc`
`45`	`46`	`*/`
`46`	`47`	`public function execute()`
`47`	`48`	`{`