Merge pull request #9319 from mickaelandrieu/phpdocs

Phpdocs
PrestaShop · Jul 15, 2018 · 087ee2a · 087ee2a
2 parents 3874c2c + 6044234
commit 087ee2a
Show file tree

Hide file tree

Showing 28 changed files with 466 additions and 36 deletions.
diff --git a/src/Adapter/Addons/AddonsDataProvider.php b/src/Adapter/Addons/AddonsDataProvider.php
@@ -41,14 +41,29 @@
  */
 class AddonsDataProvider implements AddonsInterface
 {
+    /**
+     * @var bool
+     */
     protected static $is_addons_up = true;
 
+    /**
+     * @var ApiClient
+     */
     private $marketplaceClient;
 
+    /**
+     * @var ModuleZipManager
+     */
     private $zipManager;
 
+    /**
+     * @var PhpEncryption
+     */
     private $encryption;
 
+    /**
+     * @var string the cache directory location
+     */
     public $cacheDir;
 
     public function __construct(ApiClient $apiClient, ModuleZipManager $zipManager)
@@ -58,6 +73,12 @@ public function __construct(ApiClient $apiClient, ModuleZipManager $zipManager)
         $this->encryption = new PhpEncryption(_NEW_COOKIE_KEY_);
     }
 
+    /**
+     * @param $module_id
+     *
+     * @return bool
+     * @throws Exception
+     */
     public function downloadModule($module_id)
     {
         $params = array(
@@ -85,7 +106,11 @@ public function downloadModule($module_id)
         }
     }
 
-    /** Does this function should be in a User related class ? **/
+    /**
+     * @return bool
+     *
+     * @todo Does this function should be in a User related class ?
+     */
     public function isAddonsAuthenticated()
     {
         $request = Request::createFromGlobals();
@@ -161,6 +186,10 @@ public function request($action, $params = array())
         }
     }
 
+    /**
+     * @return array
+     * @throws Exception
+     */
     protected function getAddonsCredentials()
     {
         $request = Request::createFromGlobals();

diff --git a/src/Adapter/Admin/AbstractAdminQueryBuilder.php b/src/Adapter/Admin/AbstractAdminQueryBuilder.php
@@ -41,9 +41,16 @@ abstract class AbstractAdminQueryBuilder
     const FILTERING_EQUAL_NUMERIC = '= %s';
     const FILTERING_EQUAL_STRING = '= \'%s\'';
 
+    /**
+     * @var string|null
+     */
     private $lastCompiledSql = null;
 
-    final private function compileSqlWhere(array $whereArray)
+    /**
+     * @param array $whereArray
+     * @return mixed|string
+     */
+    private function compileSqlWhere(array $whereArray)
     {
         $operator = 'AND';
         $s = array();
@@ -65,7 +72,7 @@ final private function compileSqlWhere(array $whereArray)
     /**
      * Compiles a SQL query (SELECT), from a group of associative arrays.
      *
-     * @see PrestaShop\PrestaShop\Adapter\Product\AdminProductDataProvider::getCatalogProductList() for an example.
+     * @see \PrestaShop\PrestaShop\Adapter\Product\AdminProductDataProvider::getCatalogProductList() for an example.
      *
      * Format example for $table:
      *   $table = array(

diff --git a/src/Adapter/Admin/PagePreference.php b/src/Adapter/Admin/PagePreference.php
@@ -42,6 +42,9 @@
  */
 class PagePreference implements AdminPagePreferenceInterface
 {
+    /**
+     * @var SessionInterface
+     */
     private $session;
 
     public function __construct(SessionInterface $session)
@@ -54,8 +57,8 @@ public function __construct(SessionInterface $session)
         }
     }
 
-    /* (non-PHPdoc)
-     * @see \PrestaShopCoreAdminBundle\TransitionalBehavior\AdminPagePreferenceInterface::getTemporaryShouldUseLegacyPage()
+    /**
+     * {@inheritdoc}
      */
     public function getTemporaryShouldUseLegacyPage($page)
     {
@@ -66,8 +69,8 @@ public function getTemporaryShouldUseLegacyPage($page)
         return ($this->session->has('should_use_legacy_page_for_'.$page) && $this->session->get('should_use_legacy_page_for_'.$page, 0) == 1);
     }
 
-    /* (non-PHPdoc)
-     * @see \PrestaShopCoreAdminBundle\TransitionalBehavior\AdminPagePreferenceInterface::setTemporaryShouldUseLegacyPage()
+    /**
+     * {@inheritdoc}
      */
     public function setTemporaryShouldUseLegacyPage($page, $useLegacy)
     {
@@ -82,8 +85,8 @@ public function setTemporaryShouldUseLegacyPage($page, $useLegacy)
         }
     }
 
-    /* (non-PHPdoc)
-     * @see \PrestaShopCoreAdminBundle\TransitionalBehavior\AdminPagePreferenceInterface::getTemporaryShouldAllowUseLegacyPage()
+    /**
+     * {@inheritdoc}
      */
     public function getTemporaryShouldAllowUseLegacyPage($page = null)
     {

diff --git a/src/Adapter/Admin/UrlGenerator.php b/src/Adapter/Admin/UrlGenerator.php
@@ -65,8 +65,8 @@ public function __construct(LegacyContext $legacyContext, Router $router)
         $this->router = $router;
     }
 
-    /* (non-PHPdoc)
-     * @see \Symfony\Component\Routing\Generator\UrlGeneratorInterface::generate()
+    /**
+     * {@inheritdoc}
      */
     public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH)
     {
@@ -109,16 +109,16 @@ final public function getLegacyOptions($routeName, $parameters = array())
         return array($legacyController, $legacyParameters);
     }
 
-    /* (non-PHPdoc)
-     * @see \Symfony\Component\Routing\RequestContextAwareInterface::setContext()
+    /**
+     * {@inheritdoc}
      */
     public function setContext(RequestContext $context)
     {
         throw new LogicException('Cannot use this UrlGeneratorInterface implementation with a Symfony context. Please call AdminUrlGeneratorFactory::forLegacy() to reach the right instance.');
     }
 
-    /* (non-PHPdoc)
-     * @see \Symfony\Component\Routing\RequestContextAwareInterface::getContext()
+    /**
+     * {@inheritdoc}
      */
     public function getContext()
     {

diff --git a/src/Adapter/Assets/AssetUrlGeneratorTrait.php b/src/Adapter/Assets/AssetUrlGeneratorTrait.php
@@ -31,13 +31,24 @@
 
 trait AssetUrlGeneratorTrait
 {
+    /**
+     * @var string
+     */
     protected $fqdn;
 
+    /**
+     * @param string $fullPath
+     * @return string
+     */
     protected function getUriFromPath($fullPath)
     {
         return str_replace($this->configuration->get('_PS_ROOT_DIR_'), rtrim($this->configuration->get('__PS_BASE_URI__'), '/'), $fullPath);
     }
 
+    /**
+     * @param string $fullUri
+     * @return string
+     */
     protected function getPathFromUri($fullUri)
     {
         if ('' !== ($trimmedUri = rtrim($this->configuration->get('__PS_BASE_URI__'), '/'))) {
@@ -47,6 +58,9 @@ protected function getPathFromUri($fullUri)
         return $this->configuration->get('_PS_ROOT_DIR_').$fullUri;
     }
 
+    /**
+     * @return string
+     */
     protected function getFQDN()
     {
         if (is_null($this->fqdn)) {

diff --git a/src/Adapter/Attribute/AdminAttributeGeneratorControllerWrapper.php b/src/Adapter/Attribute/AdminAttributeGeneratorControllerWrapper.php
@@ -27,6 +27,7 @@
 namespace PrestaShop\PrestaShop\Adapter\Attribute;
 
 use Context;
+use Symfony\Component\Translation\TranslatorInterface;
 use Validate;
 use Product;
 use SpecificPriceRule;
@@ -41,6 +42,9 @@
  */
 class AdminAttributeGeneratorControllerWrapper
 {
+    /**
+     * @var TranslatorInterface
+     */
     private $translator;
 
     public function __construct()

diff --git a/src/Adapter/BestSales/BestSalesProductSearchProvider.php b/src/Adapter/BestSales/BestSalesProductSearchProvider.php
@@ -39,7 +39,14 @@
 
 class BestSalesProductSearchProvider implements ProductSearchProviderInterface
 {
+    /**
+     * @var TranslatorInterface
+     */
     private $translator;
+
+    /**
+     * @var SortOrderFactory
+     */
     private $sortOrderFactory;
 
     public function __construct(
@@ -49,6 +56,11 @@ public function __construct(
         $this->sortOrderFactory = new SortOrderFactory($this->translator);
     }
 
+    /**
+     * @param ProductSearchContext $context
+     * @param ProductSearchQuery $query
+     * @return ProductSearchResult
+     */
     public function runQuery(
         ProductSearchContext $context,
         ProductSearchQuery $query

diff --git a/src/Adapter/Cart/CartPresenter.php b/src/Adapter/Cart/CartPresenter.php
@@ -37,17 +37,41 @@
 use Cart;
 use Product;
 use Configuration;
+use Symfony\Component\Translation\TranslatorInterface;
 use TaxConfiguration;
 use CartRule;
 use Tools;
 use Hook;
 
+/**
+ * This class is used to render the PHP and Javascript representations of Customer Cart
+ * in Front Office.
+ */
 class CartPresenter implements PresenterInterface
 {
+    /**
+     * @var PriceFormatter
+     */
     private $priceFormatter;
+
+    /**
+     * @var \Link
+     */
     private $link;
+
+    /**
+     * @var TranslatorInterface
+     */
     private $translator;
+
+    /**
+     * @var ImageRetriever
+     */
     private $imageRetriever;
+
+    /**
+     * @var TaxConfiguration
+     */
     private $taxConfiguration;
 
     public function __construct()
@@ -60,11 +84,18 @@ public function __construct()
         $this->taxConfiguration = new TaxConfiguration();
     }
 
+    /**
+     * @return bool|mixed
+     */
     private function includeTaxes()
     {
         return $this->taxConfiguration->includeTaxes();
     }
 
+    /**
+     * @param array $rawProduct
+     * @return array
+     */
     private function presentProduct(array $rawProduct)
     {
         $settings = new ProductPresentationSettings();
@@ -149,6 +180,11 @@ private function presentProduct(array $rawProduct)
         );
     }
 
+    /**
+     * @param array $products
+     * @param Cart $cart
+     * @return array
+     */
     public function addCustomizedData(array $products, Cart $cart)
     {
         return array_map(function (array $product) use ($cart) {
@@ -436,6 +472,10 @@ function ($voucher) {
         );
     }
 
+    /**
+     * @param Cart $cart
+     * @return array
+     */
     private function getTemplateVarVouchers(Cart $cart)
     {
         $cartVouchers = $cart->getCartRules();

diff --git a/src/Adapter/Category/CategoryDataProvider.php b/src/Adapter/Category/CategoryDataProvider.php
@@ -37,6 +37,9 @@
  */
 class CategoryDataProvider
 {
+    /**
+     * @var int
+     */
     private $languageId;
 
     /** @var array the list of existing active categories until root */
@@ -251,6 +254,11 @@ public function getAjaxCategories($query, $limit, $nameAsBreadCrumb = false)
         return $results;
     }
 
+    /**
+     * @param int|null $idLang
+     * @param Shop|null $shop
+     * @return Category
+     */
     public function getRootCategory($idLang = null, Shop $shop = null)
     {
         return Category::getRootCategory($idLang, $shop);

diff --git a/src/Adapter/Category/CategoryProductSearchProvider.php b/src/Adapter/Category/CategoryProductSearchProvider.php
@@ -35,6 +35,9 @@
 use Symfony\Component\Translation\TranslatorInterface;
 use Category;
 
+/**
+ * Responsible of getting products for specific category
+ */
 class CategoryProductSearchProvider implements ProductSearchProviderInterface
 {
     private $translator;
@@ -50,6 +53,13 @@ public function __construct(
         $this->sortOrderFactory = new SortOrderFactory($this->translator);
     }
 
+    /**
+     * @param ProductSearchContext $context
+     * @param ProductSearchQuery $query
+     * @param string $type
+     * @return array|false|int
+     * @throws \PrestaShopDatabaseException
+     */
     private function getProductsOrCount(
         ProductSearchContext $context,
         ProductSearchQuery $query,
@@ -79,6 +89,12 @@ private function getProductsOrCount(
         }
     }
 
+    /**
+     * @param ProductSearchContext $context
+     * @param ProductSearchQuery $query
+     * @return ProductSearchResult
+     * @throws \PrestaShopDatabaseException
+     */
     public function runQuery(
         ProductSearchContext $context,
         ProductSearchQuery $query