Merge branch 'main' into documentation

OpenMage · Sep 2, 2024 · 1f7f746 · 1f7f746
2 parents b394a2c + 220399d
commit 1f7f746
Show file tree

Hide file tree

Showing 349 changed files with 1,021 additions and 1,129 deletions.
diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml
@@ -8,6 +8,8 @@
 name: Labeler
 on:
   pull_request_target:
+  # Allow manually triggering the workflow.
+  workflow_dispatch:
 
 jobs:
   triage:

diff --git a/.github/workflows/phpcs.yml b/.github/workflows/phpcs.yml
@@ -45,4 +45,4 @@ jobs:
 
       - name: PHPCodeSniffer
         run: php vendor/bin/phpcs -s --report=full --standard=${{ matrix.rules.path }}
-        continue-on-error: ${{ matrix.rules.path != '.phpcs.xml.dist' }}
+        continue-on-error: ${{ matrix.rules.path == '.phpcs.ecg.xml.dist' }}
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -83,6 +83,8 @@
         'single_import_per_statement' => true,
         // Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block.
         'single_line_after_imports' => true,
+        // Convert double quotes to single quotes for simple strings.
+        'single_quote' => true,
         // Each trait `use` must be done as single statement.
         'single_trait_insert_per_statement' => true,
         // A case should be followed by a colon and not a semicolon.

diff --git a/app/code/core/Mage/Admin/Model/Config.php b/app/code/core/Mage/Admin/Model/Config.php
@@ -79,7 +79,7 @@ public function __construct()
     public function loadAclResources(Mage_Admin_Model_Acl $acl, $resource = null, $parentName = null)
     {
         if (is_null($resource)) {
-            $resource = $this->getAdminhtmlConfig()->getNode("acl/resources");
+            $resource = $this->getAdminhtmlConfig()->getNode('acl/resources');
             $resourceName = null;
         } else {
             $resourceName = (is_null($parentName) ? '' : $parentName . '/') . $resource->getName();
@@ -117,7 +117,7 @@ public function loadAclResources(Mage_Admin_Model_Acl $acl, $resource = null, $p
      */
     public function getAclAssert($name = '')
     {
-        $asserts = $this->getNode("admin/acl/asserts");
+        $asserts = $this->getNode('admin/acl/asserts');
         if ($name === '') {
             return $asserts;
         }
@@ -133,7 +133,7 @@ public function getAclAssert($name = '')
      */
     public function getAclPrivilegeSet($name = '')
     {
-        $sets = $this->getNode("admin/acl/privilegeSets");
+        $sets = $this->getNode('admin/acl/privilegeSets');
         if ($name === '') {
             return $sets;
         }

diff --git a/app/code/core/Mage/Admin/Model/Observer.php b/app/code/core/Mage/Admin/Model/Observer.php
@@ -55,7 +55,7 @@ public function actionPreDispatchAdmin($observer)
                     /** @var Mage_Core_Model_Session $coreSession */
                     $coreSession = Mage::getSingleton('core/session');
 
-                    if ($coreSession->validateFormKey($request->getPost("form_key"))) {
+                    if ($coreSession->validateFormKey($request->getPost('form_key'))) {
                         $postLogin = $request->getPost('login');
                         $username = $postLogin['username'] ?? '';
                         $password = $postLogin['password'] ?? '';

diff --git a/app/code/core/Mage/Admin/Model/Resource/Acl.php b/app/code/core/Mage/Admin/Model/Resource/Acl.php
@@ -148,7 +148,7 @@ public function loadRules(Mage_Admin_Model_Acl $acl, array $rulesArr)
                 Mage::helper('adminhtml')->__(
                     'The following role resources are no longer available in the system: %s. You can delete them by <a href="%s">clicking here</a>.',
                     implode(', ', $orphanedResources),
-                    Mage::helper("adminhtml")->getUrl('adminhtml/permissions_orphanedResource')
+                    Mage::helper('adminhtml')->getUrl('adminhtml/permissions_orphanedResource')
                 )
             );
         }

diff --git a/app/code/core/Mage/Admin/Model/Resource/Roles/Collection.php b/app/code/core/Mage/Admin/Model/Resource/Roles/Collection.php
@@ -33,7 +33,7 @@ protected function _initSelect()
     {
         parent::_initSelect();
 
-        $this->getSelect()->where("main_table.role_type = ?", 'G');
+        $this->getSelect()->where('main_table.role_type = ?', 'G');
 
         return $this;
     }

diff --git a/app/code/core/Mage/Admin/Model/Resource/Roles/User/Collection.php b/app/code/core/Mage/Admin/Model/Resource/Roles/User/Collection.php
@@ -33,7 +33,7 @@ protected function _initSelect()
     {
         parent::_initSelect();
 
-        $this->getSelect()->where("user_id > 0");
+        $this->getSelect()->where('user_id > 0');
 
         return $this;
     }

diff --git a/app/code/core/Mage/Admin/Model/Roles.php b/app/code/core/Mage/Admin/Model/Roles.php
@@ -146,8 +146,8 @@ protected function _buildResourcesArray(
                 }
 
                 if ($rawNodes) {
-                    $resource->addAttribute("aclpath", $resourceName);
-                    $resource->addAttribute("module_c", $module);
+                    $resource->addAttribute('aclpath', $resourceName);
+                    $resource->addAttribute('module_c', $module);
                 }
 
                 if (is_null($represent2Darray)) {

diff --git a/app/code/core/Mage/Admin/sql/admin_setup/upgrade-1.6.1.1-1.6.1.2.php b/app/code/core/Mage/Admin/sql/admin_setup/upgrade-1.6.1.1-1.6.1.2.php
@@ -28,7 +28,7 @@
     ->addColumn('variable_name', Varien_Db_Ddl_Table::TYPE_VARCHAR, 255, [
         'primary'   => true,
         'nullable'  => false,
-        'default'   => "",
+        'default'   => '',
     ], 'Config Path')
     ->addColumn('is_allowed', Varien_Db_Ddl_Table::TYPE_BOOLEAN, null, [
         'nullable'  => false,
@@ -73,7 +73,7 @@
     ], 'Block ID')
     ->addColumn('block_name', Varien_Db_Ddl_Table::TYPE_VARCHAR, 255, [
         'nullable'  => false,
-        'default'   => "",
+        'default'   => '',
     ], 'Block Name')
     ->addColumn('is_allowed', Varien_Db_Ddl_Table::TYPE_BOOLEAN, null, [
         'nullable'  => false,

diff --git a/app/code/core/Mage/Adminhtml/Block/Api/Editroles.php b/app/code/core/Mage/Adminhtml/Block/Api/Editroles.php
@@ -30,7 +30,7 @@ public function __construct()
     protected function _beforeToHtml()
     {
         $roleId = $this->getRequest()->getParam('rid', false);
-        $role = Mage::getModel("api/roles")
+        $role = Mage::getModel('api/roles')
            ->load($roleId);
 
         $this->addTab('info', [

diff --git a/app/code/core/Mage/Adminhtml/Block/Api/Grid/Role.php b/app/code/core/Mage/Adminhtml/Block/Api/Grid/Role.php
@@ -33,7 +33,7 @@ public function __construct()
 
     protected function _prepareCollection()
     {
-        $collection =  Mage::getModel("api/roles")->getCollection();
+        $collection =  Mage::getModel('api/roles')->getCollection();
         $this->setCollection($collection);
 
         return parent::_prepareCollection();

diff --git a/app/code/core/Mage/Adminhtml/Block/Api/Role/Grid/User.php b/app/code/core/Mage/Adminhtml/Block/Api/Role/Grid/User.php
@@ -145,7 +145,7 @@ public function getGridUrl()
      */
     protected function _getUsers($json = false)
     {
-        if ($this->getRequest()->getParam('in_role_user') != "") {
+        if ($this->getRequest()->getParam('in_role_user') != '') {
             return (int)$this->getRequest()->getParam('in_role_user');
         }
         $roleId = ($this->getRequest()->getParam('rid') > 0) ? $this->getRequest()->getParam('rid') : Mage::registry('RID');

diff --git a/app/code/core/Mage/Adminhtml/Block/Api/Tab/Rolesusers.php b/app/code/core/Mage/Adminhtml/Block/Api/Tab/Rolesusers.php
@@ -25,7 +25,7 @@ public function __construct()
 
         $roleId = $this->getRequest()->getParam('rid', false);
 
-        $users = Mage::getModel("api/user")->getCollection()->load();
+        $users = Mage::getModel('api/user')->getCollection()->load();
         $this->setTemplate('api/rolesusers.phtml')
             ->assign('users', $users->getItems())
             ->assign('roleId', $roleId);

diff --git a/app/code/core/Mage/Adminhtml/Block/Api/Tab/Userroles.php b/app/code/core/Mage/Adminhtml/Block/Api/Tab/Userroles.php
@@ -25,11 +25,11 @@ public function __construct()
 
         $uid = $this->getRequest()->getParam('id', false);
         $uid = !empty($uid) ? $uid : 0;
-        $roles = Mage::getModel("api/roles")
+        $roles = Mage::getModel('api/roles')
             ->getCollection()
             ->load();
 
-        $user_roles = Mage::getModel("api/roles")
+        $user_roles = Mage::getModel('api/roles')
             ->getUsersCollection()
             ->setUserFilter($uid)
             ->load();

diff --git a/app/code/core/Mage/Adminhtml/Block/Api/User/Edit/Tab/Roles.php b/app/code/core/Mage/Adminhtml/Block/Api/User/Edit/Tab/Roles.php
@@ -103,7 +103,7 @@ public function getGridUrl()
      */
     protected function _getSelectedRoles($json = false)
     {
-        if ($this->getRequest()->getParam('user_roles') != "") {
+        if ($this->getRequest()->getParam('user_roles') != '') {
             return $this->getRequest()->getParam('user_roles');
         }
         $uRoles = Mage::registry('api_user')->getRoles();

diff --git a/app/code/core/Mage/Adminhtml/Block/Catalog/Category/Abstract.php b/app/code/core/Mage/Adminhtml/Block/Catalog/Category/Abstract.php
@@ -163,7 +163,7 @@ public function getSaveUrl(array $args = [])
 
     public function getEditUrl()
     {
-        return $this->getUrl("*/catalog_category/edit", ['_current' => true, 'store' => null, '_query' => false, 'id' => null, 'parent' => null]);
+        return $this->getUrl('*/catalog_category/edit', ['_current' => true, 'store' => null, '_query' => false, 'id' => null, 'parent' => null]);
     }
 
     /**

diff --git a/app/code/core/Mage/Adminhtml/Block/Catalog/Category/Helper/Pricestep.php b/app/code/core/Mage/Adminhtml/Block/Catalog/Category/Helper/Pricestep.php
@@ -29,7 +29,7 @@ class Mage_Adminhtml_Block_Catalog_Category_Helper_Pricestep extends Varien_Data
     public function getToggleCode()
     {
         $htmlId = 'use_config_' . $this->getHtmlId();
-        return "toggleValueElements(this, this.parentNode.parentNode);"
+        return 'toggleValueElements(this, this.parentNode.parentNode);'
             . "if (!this.checked) toggleValueElements($('$htmlId'), $('$htmlId').parentNode);";
     }
 

diff --git a/app/code/core/Mage/Adminhtml/Block/Catalog/Category/Helper/Sortby/Available.php b/app/code/core/Mage/Adminhtml/Block/Catalog/Category/Helper/Sortby/Available.php
@@ -29,7 +29,7 @@ class Mage_Adminhtml_Block_Catalog_Category_Helper_Sortby_Available extends Vari
     public function getToggleCode()
     {
         $htmlId = 'use_config_' . $this->getHtmlId();
-        return "toggleValueElements(this, this.parentNode.parentNode);"
+        return 'toggleValueElements(this, this.parentNode.parentNode);'
             . "if (!this.checked) toggleValueElements($('$htmlId'), $('$htmlId').parentNode);";
     }
 

diff --git a/app/code/core/Mage/Adminhtml/Block/Catalog/Category/Helper/Sortby/Default.php b/app/code/core/Mage/Adminhtml/Block/Catalog/Category/Helper/Sortby/Default.php
@@ -29,7 +29,7 @@ class Mage_Adminhtml_Block_Catalog_Category_Helper_Sortby_Default extends Varien
     public function getToggleCode()
     {
         $htmlId = 'use_config_' . $this->getHtmlId();
-        return "toggleValueElements(this, this.parentNode.parentNode);"
+        return 'toggleValueElements(this, this.parentNode.parentNode);'
             . "if (!this.checked) toggleValueElements($('$htmlId'), $('$htmlId').parentNode);";
     }
 

diff --git a/app/code/core/Mage/Adminhtml/Block/Catalog/Category/Tree.php b/app/code/core/Mage/Adminhtml/Block/Catalog/Category/Tree.php
@@ -33,7 +33,7 @@ public function __construct()
 
     protected function _prepareLayout()
     {
-        $addUrl = $this->getUrl("*/*/add", [
+        $addUrl = $this->getUrl('*/*/add', [
             '_current' => true,
             'id' => null,
             '_query' => false
@@ -141,7 +141,7 @@ public function getNodesUrl()
     public function getSwitchTreeUrl()
     {
         return $this->getUrl(
-            "*/catalog_category/tree",
+            '*/catalog_category/tree',
             ['_current' => true, 'store' => null, '_query' => false, 'id' => null, 'parent' => null]
         );
     }

diff --git a/app/code/core/Mage/Adminhtml/Block/Catalog/Product/Attribute/Edit/Tab/Main.php b/app/code/core/Mage/Adminhtml/Block/Catalog/Product/Attribute/Edit/Tab/Main.php
@@ -148,7 +148,7 @@ protected function _prepareForm()
 
         $fieldset->addField('is_filterable', 'select', [
             'name' => 'is_filterable',
-            'label' => Mage::helper('catalog')->__("Use In Layered Navigation"),
+            'label' => Mage::helper('catalog')->__('Use In Layered Navigation'),
             'title' => Mage::helper('catalog')->__('Can be used only with catalog input type Dropdown, Multiple Select and Price'),
             'note' => Mage::helper('catalog')->__('Can be used only with catalog input type Dropdown, Multiple Select and Price'),
             'values' => [
@@ -160,7 +160,7 @@ protected function _prepareForm()
 
         $fieldset->addField('is_filterable_in_search', 'select', [
             'name' => 'is_filterable_in_search',
-            'label' => Mage::helper('catalog')->__("Use In Search Results Layered Navigation"),
+            'label' => Mage::helper('catalog')->__('Use In Search Results Layered Navigation'),
             'title' => Mage::helper('catalog')->__('Can be used only with catalog input type Dropdown, Multiple Select and Price'),
             'note' => Mage::helper('catalog')->__('Can be used only with catalog input type Dropdown, Multiple Select and Price'),
             'values' => $yesnoSource,
@@ -233,9 +233,9 @@ protected function _prepareForm()
         /** @var Mage_Adminhtml_Block_Widget_Form_Element_Dependence $block */
         $block = $this->getLayout()->createBlock('adminhtml/widget_form_element_dependence');
         $this->setChild('form_after', $block
-            ->addFieldMap("is_wysiwyg_enabled", 'wysiwyg_enabled')
-            ->addFieldMap("is_html_allowed_on_front", 'html_allowed_on_front')
-            ->addFieldMap("frontend_input", 'frontend_input_type')
+            ->addFieldMap('is_wysiwyg_enabled', 'wysiwyg_enabled')
+            ->addFieldMap('is_html_allowed_on_front', 'html_allowed_on_front')
+            ->addFieldMap('frontend_input', 'frontend_input_type')
             ->addFieldDependence('wysiwyg_enabled', 'frontend_input_type', 'textarea')
             ->addFieldDependence('html_allowed_on_front', 'wysiwyg_enabled', '0'));
 

diff --git a/app/code/core/Mage/Adminhtml/Block/Catalog/Product/Helper/Form/Gallery.php b/app/code/core/Mage/Adminhtml/Block/Catalog/Product/Helper/Form/Gallery.php
@@ -79,12 +79,12 @@ public function usedDefault($attribute)
 
         // special management for "label" and "position" since they're columns of the
         // catalog_product_entity_media_gallery_value database table
-        if ($attributeCode == "label" || $attributeCode == "position") {
+        if ($attributeCode == 'label' || $attributeCode == 'position') {
             $media_gallery = $this->getDataObject()->getMediaGallery();
-            if (!count($media_gallery["images"])) {
+            if (!count($media_gallery['images'])) {
                 return true;
             }
-            return $media_gallery["images"][0]["{$attributeCode}_use_default"];
+            return $media_gallery['images'][0]["{$attributeCode}_use_default"];
         }
 
         $defaultValue = $this->getDataObject()->getAttributeDefaultValue($attributeCode);

diff --git a/app/code/core/Mage/Adminhtml/Block/Checkout/Formkey.php b/app/code/core/Mage/Adminhtml/Block/Checkout/Formkey.php
@@ -39,6 +39,6 @@ public function canShow()
      */
     public function getSecurityAdminUrl()
     {
-        return Mage::helper("adminhtml")->getUrl('adminhtml/system_config/edit/section/admin');
+        return Mage::helper('adminhtml')->getUrl('adminhtml/system_config/edit/section/admin');
     }
 }
diff --git a/app/code/core/Mage/Adminhtml/Block/Dashboard/Graph.php b/app/code/core/Mage/Adminhtml/Block/Dashboard/Graph.php
@@ -253,10 +253,10 @@ public function getChartUrl($directUrl = true)
         $this->_allSeries = $datas;
 
         // Image-Charts Awesome data format values
-        $params['chd'] = "a:";
-        $dataDelimiter = ",";
-        $dataSetdelimiter = "|";
-        $dataMissing = "_";
+        $params['chd'] = 'a:';
+        $dataDelimiter = ',';
+        $dataSetdelimiter = '|';
+        $dataMissing = '_';
 
         // process each string in the array, and find the max length
         foreach ($this->getAllSeries() as $index => $serie) {
@@ -321,9 +321,9 @@ public function getChartUrl($directUrl = true)
 
         $params['chd'] .= $buffer;
 
-        $labelBuffer = "";
+        $labelBuffer = '';
         $valueBuffer = [];
-        $rangeBuffer = "";
+        $rangeBuffer = '';
 
         if (count($this->_axisLabels)) {
             $params['chxt'] = implode(',', array_keys($this->_axisLabels));
@@ -353,7 +353,7 @@ public function getChartUrl($directUrl = true)
                                 case '2y':
                                     $formats = Mage::app()->getLocale()->getTranslationList('datetime');
                                     $format = $formats['yyMM'] ?? 'MM/yyyy';
-                                    $format = str_replace(["yyyy", "yy", "MM"], ["Y", "y", "m"], $format);
+                                    $format = str_replace(['yyyy', 'yy', 'MM'], ['Y', 'y', 'm'], $format);
                                     $this->_axisLabels[$idx][$_index] = date($format, strtotime($_label));
                                     break;
                             }
@@ -364,21 +364,21 @@ public function getChartUrl($directUrl = true)
 
                     $tmpstring = implode('|', $this->_axisLabels[$idx]);
 
-                    $valueBuffer[] = $indexid . ":|" . $tmpstring;
+                    $valueBuffer[] = $indexid . ':|' . $tmpstring;
                     if (count($this->_axisLabels[$idx]) > 1) {
                         $deltaX = 100 / (count($this->_axisLabels[$idx]) - 1);
                     } else {
                         $deltaX = 100;
                     }
                 } elseif ($idx === 'y') {
-                    $valueBuffer[] = $indexid . ":|" . implode('|', $yLabels);
+                    $valueBuffer[] = $indexid . ':|' . implode('|', $yLabels);
                     if (count($yLabels) - 1) {
                         $deltaY = 100 / (count($yLabels) - 1);
                     } else {
                         $deltaY = 100;
                     }
                     // setting range values for y axis
-                    $rangeBuffer = $indexid . "," . $miny . "," . $maxy . "|";
+                    $rangeBuffer = $indexid . ',' . $miny . ',' . $maxy . '|';
                 }
                 $indexid++;
             }

diff --git a/app/code/core/Mage/Adminhtml/Block/Newsletter/Queue/Preview.php b/app/code/core/Mage/Adminhtml/Block/Newsletter/Queue/Preview.php
@@ -49,7 +49,7 @@ protected function _toHtml()
             $storeId = Mage::app()->getAnyStoreView()->getId();
         }
 
-        Varien_Profiler::start("newsletter_queue_proccessing");
+        Varien_Profiler::start('newsletter_queue_proccessing');
         $vars = [];
 
         $vars['subscriber'] = Mage::getModel('newsletter/subscriber');
@@ -59,13 +59,13 @@ protected function _toHtml()
         $template->revertDesign();
 
         if ($template->isPlain()) {
-            $templateProcessed = "<pre>" . htmlspecialchars($templateProcessed) . "</pre>";
+            $templateProcessed = '<pre>' . htmlspecialchars($templateProcessed) . '</pre>';
         }
 
         $templateProcessed = Mage::getSingleton('core/input_filter_maliciousCode')
             ->linkFilter($templateProcessed);
 
-        Varien_Profiler::stop("newsletter_queue_proccessing");
+        Varien_Profiler::stop('newsletter_queue_proccessing');
 
         return $templateProcessed;
     }

diff --git a/app/code/core/Mage/Adminhtml/Block/Newsletter/Template/Preview.php b/app/code/core/Mage/Adminhtml/Block/Newsletter/Template/Preview.php
@@ -45,7 +45,7 @@ protected function _toHtml()
             $storeId = Mage::app()->getAnyStoreView()->getId();
         }
 
-        Varien_Profiler::start("newsletter_template_proccessing");
+        Varien_Profiler::start('newsletter_template_proccessing');
         $vars = [];
 
         $vars['subscriber'] = Mage::getModel('newsletter/subscriber');
@@ -58,13 +58,13 @@ protected function _toHtml()
         $template->revertDesign();
 
         if ($template->isPlain()) {
-            $templateProcessed = "<pre>" . htmlspecialchars($templateProcessed) . "</pre>";
+            $templateProcessed = '<pre>' . htmlspecialchars($templateProcessed) . '</pre>';
         }
 
         $templateProcessed = Mage::getSingleton('core/input_filter_maliciousCode')
             ->linkFilter($templateProcessed);
 
-        Varien_Profiler::stop("newsletter_template_proccessing");
+        Varien_Profiler::stop('newsletter_template_proccessing');
 
         return $templateProcessed;
     }