PLUGINRANGERS-234 | Master file refactor step 8: Moved lib entities to src/Entity + minor adjustments

autoloader.php

@@ -18,6 +18,9 @@
 
 class Autoloader
 {
+    // Exceptions based on: https://devdocs.prestashop-project.org/8/modules/creation/module-file-structure/
+    const EXCEPTIONS_FOR_UNCAPITALIZE = ['Entity', 'Controller'];
+
     /**
      * Registers the autoloader according to PrestaShop standards, which are PSR-12 standards.
      * More info at: https://www.php-fig.org/psr/psr-12/
@@ -74,6 +77,10 @@ private static function pathFromNamespace($fullNameSpace)
      */
     private static function uncapitalize($text)
     {
+        if (in_array($text, self::EXCEPTIONS_FOR_UNCAPITALIZE, true)) {
+            return $text;
+        }
+
         return strtolower(substr($text, 0, 1)) . substr($text, 1);
     }
 }

config.php

@@ -13,9 +13,9 @@
  * @license   GPLv3
  */
 
-use PrestaShop\Module\Doofinder\Lib\DfTools;
-use PrestaShop\Module\Doofinder\Lib\DoofinderConfig;
-use PrestaShop\Module\Doofinder\Lib\DoofinderConstants;
+use PrestaShop\Module\Doofinder\Src\Entity\DfTools;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderConfig;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderConstants;
 
 $root_path = dirname(dirname(dirname($_SERVER['SCRIPT_FILENAME'])));
 $config_file_path = $root_path . '/config/config.inc.php';

controllers/front/landing.php

@@ -13,8 +13,8 @@
  * @license   GPLv3
  */
 
-use PrestaShop\Module\Doofinder\Lib\DoofinderApiLanding;
-use PrestaShop\Module\Doofinder\Lib\SearchEngine;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderApiLanding;
+use PrestaShop\Module\Doofinder\Src\Entity\SearchEngine;
 use PrestaShop\PrestaShop\Adapter\Image\ImageRetriever;
 use PrestaShop\PrestaShop\Adapter\Product\PriceFormatter;
 use PrestaShop\PrestaShop\Adapter\Product\ProductColorsRetriever;

doofinder-ajax.php

@@ -13,8 +13,8 @@
  * @license   GPLv3
  */
 
-use PrestaShop\Module\Doofinder\Lib\DoofinderApi;
-use PrestaShop\Module\Doofinder\Lib\DoofinderInstallation;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderApi;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderInstallation;
 
 $rootPath = dirname(dirname(dirname($_SERVER['SCRIPT_FILENAME'])));
 $configFilePath = $rootPath . '/config/config.inc.php';

doofinder.php

@@ -18,11 +18,11 @@
 
 require_once 'autoloader.php';
 
-use PrestaShop\Module\Doofinder\Lib\DoofinderAdminPanelView;
-use PrestaShop\Module\Doofinder\Lib\DoofinderInstallation;
-use PrestaShop\Module\Doofinder\Lib\DoofinderScript;
-use PrestaShop\Module\Doofinder\Lib\HookManager;
-use PrestaShop\Module\Doofinder\Lib\SearchEngine;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderAdminPanelView;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderInstallation;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderScript;
+use PrestaShop\Module\Doofinder\Src\Entity\HookManager;
+use PrestaShop\Module\Doofinder\Src\Entity\SearchEngine;
 
 class Doofinder extends Module
 {
@@ -69,7 +69,7 @@ public function install()
     /**
      * Uninstall the module and its dependencies
      *
-     * @return void
+     * @return bool
      */
     public function uninstall()
     {

feeds/category.php

@@ -13,8 +13,8 @@
  * @license   GPLv3
  */
 
-use PrestaShop\Module\Doofinder\Lib\DfCategoryBuild;
-use PrestaShop\Module\Doofinder\Lib\DfTools;
+use PrestaShop\Module\Doofinder\Src\Entity\DfCategoryBuild;
+use PrestaShop\Module\Doofinder\Src\Entity\DfTools;
 
 if (function_exists('set_time_limit')) {
     @set_time_limit(3600 * 2);

feeds/cms.php

@@ -13,8 +13,8 @@
  * @license   GPLv3
  */
 
-use PrestaShop\Module\Doofinder\Lib\DfCmsBuild;
-use PrestaShop\Module\Doofinder\Lib\DfTools;
+use PrestaShop\Module\Doofinder\Src\Entity\DfCmsBuild;
+use PrestaShop\Module\Doofinder\Src\Entity\DfTools;
 
 if (function_exists('set_time_limit')) {
     @set_time_limit(3600 * 2);

feeds/product.php

@@ -13,8 +13,8 @@
  * @license   GPLv3
  */
 
-use PrestaShop\Module\Doofinder\Lib\DfTools;
-use PrestaShop\Module\Doofinder\Lib\DoofinderConstants;
+use PrestaShop\Module\Doofinder\Src\Entity\DfTools;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderConstants;
 
 if (!defined('_PS_VERSION_')) {
     exit;

landing.php

@@ -13,9 +13,9 @@
  * @license   GPLv3
  */
 
-use PrestaShop\Module\Doofinder\Lib\DoofinderConfig;
-use PrestaShop\Module\Doofinder\Lib\DoofinderConstants;
-use PrestaShop\Module\Doofinder\Lib\LanguageManager;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderConfig;
+use PrestaShop\Module\Doofinder\Src\Entity\DoofinderConstants;
+use PrestaShop\Module\Doofinder\Src\Entity\LanguageManager;
 
 $rootPath = dirname(dirname(dirname($_SERVER['SCRIPT_FILENAME'])));
 $configFilePath = $rootPath . '/config/config.inc.php';

lib/DfCategoryBuild.php → src/Entity/DfCategoryBuild.php

@@ -13,7 +13,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;
@@ -71,7 +71,7 @@ private function buildCategory($idCategory)
         $c['meta_description'] = DfTools::cleanString($category->meta_description);
         $c['tags'] = DfTools::cleanString($category->meta_keywords);
         $c['link'] = $this->link->getCategoryLink($category);
-        $c['image_link'] = $category->id_image ? $this->link->getCatImageLink($category->link_rewrite, $category->id_image, 'category_default') : '';
+        $c['image_link'] = $category->id_image ? $this->link->getCatImageLink($category->link_rewrite, $category->id_image, \ImageType::getFormattedName('category')) : '';
 
         return $c;
     }

lib/DfCmsBuild.php → src/Entity/DfCmsBuild.php

@@ -13,7 +13,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;

lib/DfProductBuild.php → src/Entity/DfProductBuild.php

@@ -13,7 +13,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;

lib/DfTools.php → src/Entity/DfTools.php

@@ -13,7 +13,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;
@@ -61,10 +61,10 @@ public static function prepareSQL($sql, $args = [])
     public static function limitSQL($sql, $limit = false, $offset = false)
     {
         if (false !== $limit && is_numeric($limit)) {
-            $sql .= ' LIMIT ' . intval($limit);
+            $sql .= ' LIMIT ' . (int) $limit;
 
             if (false !== $offset && is_numeric($offset)) {
-                $sql .= ' OFFSET ' . intval($offset);
+                $sql .= ' OFFSET ' . (int) $offset;
             }
         }
 
@@ -92,7 +92,7 @@ public static function getAvailableImageSizes()
             `products` = 1
         ORDER BY
             CASE
-                WHEN name = 'home_default' THEN '1'
+                WHEN name = '" . \ImageType::getFormattedName('home') . "' THEN '1'
             END DESC;
         ";
 
@@ -145,9 +145,9 @@ public static function versionGte($minVersion)
         $minVersion = explode('.', $minVersion);
 
         foreach ($version as $index => $value) {
-            if (intval($value) > intval($minVersion[$index])) {
+            if ((int) $value > (int) $minVersion[$index]) {
                 return true;
-            } elseif (intval($value) < intval($minVersion[$index])) {
+            } elseif ((int) $value < (int) $minVersion[$index]) {
                 return false;
             }
         }
@@ -868,13 +868,13 @@ public static function getCategoriesForProductIdAndLanguage($idProduct, $idLang,
 
         foreach (\Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($sql) as $i => $row) {
             if (!$i) {
-                $idCategory0 = intval($row['id_category']);
-                $nleft0 = intval($row['nleft']);
-                $nright0 = intval($row['nright']);
+                $idCategory0 = (int) $row['id_category'];
+                $nleft0 = (int) $row['nleft'];
+                $nright0 = (int) $row['nright'];
             } else {
-                $idCategory1 = intval($row['id_category']);
-                $nleft1 = intval($row['nleft']);
-                $nright1 = intval($row['nright']);
+                $idCategory1 = (int) $row['id_category'];
+                $nleft1 = (int) $row['nleft'];
+                $nright1 = (int) $row['nright'];
 
                 if ($nleft1 < $nleft0 && $nright1 > $nright0) {
                     // $idCategory1 is an ancestor of $idCategory0
@@ -981,7 +981,7 @@ public static function getCmsPages($idLang, $idShop, $active = true)
 
     public static function truncateText($text, $length)
     {
-        $l = intval($length);
+        $l = (int) $length;
         $c = trim(preg_replace('/\s+/', ' ', $text));
 
         if (strlen($c) <= $l) {
@@ -1169,7 +1169,7 @@ public static function getCurrencyForLanguageFromRequest(\Language $lang)
     {
         if ($idCurrency = \Tools::getValue('currency')) {
             if (is_numeric($idCurrency)) {
-                $idCurrency = intval($idCurrency);
+                $idCurrency = (int) $idCurrency;
             } else {
                 $idCurrency = \Currency::getIdByIsoCode(strtoupper($idCurrency));
             }
@@ -1197,8 +1197,7 @@ public static function getCurrencyForLanguageFromRequest(\Language $lang)
     public static function getModuleLink($path, $ssl = false)
     {
         $context = \Context::getContext();
-        $shop = new \Shop($context->shop->id);
-        $base = (($ssl && \Configuration::get('PS_SSL_ENABLED')) ? 'https://' : 'http://') . $shop->domain;
+        $base = (($ssl && \Configuration::get('PS_SSL_ENABLED')) ? 'https://' : 'http://') . $context->shop->domain;
 
         return $base . _MODULE_DIR_ . basename(dirname(__FILE__)) . '/' . $path;
     }
@@ -1411,17 +1410,17 @@ public static function getOnsalePrice($productId, $includeTaxes, $variantId = nu
 
     private static function getVariantUrl($product, $context)
     {
-        global $lang, $shop;
-        $cfgModRewrite = self::cfg($shop->id, 'PS_REWRITING_SETTINGS', DoofinderConstants::YES);
+        $context = \Context::getContext();
+        $cfgModRewrite = self::cfg($context->shop->id, 'PS_REWRITING_SETTINGS', DoofinderConstants::YES);
 
         return self::cleanURL(
             $context->link->getProductLink(
                 (int) $product['id_product'],
                 $product['link_rewrite'],
                 $product['cat_link_rew'],
                 $product['ean13'],
-                $lang->id,
-                $shop->id,
+                $context->language->id,
+                $context->shop->id,
                 (int) $product['id_product_attribute'],
                 $cfgModRewrite,
                 false,

lib/DoofinderAdminPanelView.php → src/Entity/DoofinderAdminPanelView.php

@@ -13,7 +13,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;

lib/DoofinderApi.php → src/Entity/DoofinderApi.php

@@ -16,7 +16,7 @@
  * Gilles Devaux (<[email protected]>) (https://github.com/flaptor/indextank-php)
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;
@@ -372,15 +372,10 @@ public function removeTerm($filterName, $term)
         if ($this->optionExists('filter') && isset($this->searchOptions['filter'][$filterName])
             && in_array($term, $this->searchOptions['filter'][$filterName])
         ) {
-            function filter_me($value)
-            {
-                global $term;
-
-                return $value != $term;
-            }
-
             $this->searchOptions['filter'][$filterName] =
-            array_filter($this->searchOptions['filter'][$filterName], 'filter_me');
+            array_filter($this->searchOptions['filter'][$filterName], function ($value) use ($term) {
+                return $value !== $term;
+            });
         }
     }
 

lib/DoofinderApiIndex.php → src/Entity/DoofinderApiIndex.php

@@ -13,7 +13,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;

lib/DoofinderApiItems.php → src/Entity/DoofinderApiItems.php

@@ -13,7 +13,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;

lib/DoofinderApiLanding.php → src/Entity/DoofinderApiLanding.php

@@ -13,7 +13,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;

lib/DoofinderApiUniqueScript.php → src/Entity/DoofinderApiSingleScript.php

@@ -13,13 +13,13 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;
 }
 
-class DoofinderApiUniqueScript
+class DoofinderApiSingleScript
 {
     private $installationId;
     private $apiKey;
@@ -33,13 +33,13 @@ public function __construct($installationId, $region, $apiKey)
     }
 
     /**
-     * Make a request to the API to SET unique script flag to notify the migration of this customer
+     * Make a request to the API to SET single script flag to notify the migration of this customer
      *
      * This function does not require any parameters.
      *
      * @return mixed The response from the API request
      */
-    public function set_unique_script_flag()
+    public function setSingleScriptFlag()
     {
         $endpoint = '/prestashop/migrate-unique-script';
 

lib/DoofinderConfig.php → src/Entity/DoofinderConfig.php

@@ -13,7 +13,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;

lib/DoofinderConstants.php → src/Entity/DoofinderConstants.php

@@ -13,7 +13,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;

lib/DoofinderException.php → src/Entity/DoofinderException.php

@@ -5,7 +5,7 @@
  * @license   GPLv3
  */
 
-namespace PrestaShop\Module\Doofinder\Lib;
+namespace PrestaShop\Module\Doofinder\Src\Entity;
 
 if (!defined('_PS_VERSION_')) {
     exit;