Fixed phpdoc types - (pimcore#14051)

* fixed phpdoc types - in preparation for pimcore#13869 * Update bundles/EcommerceFrameworkBundle/CartManager/CartPriceCalculatorInterface.php Co-authored-by: Sebastian Blank <[email protected]> * Update bundles/EcommerceFrameworkBundle/IndexService/Getter/TagsGetter.php Co-authored-by: Sebastian Blank <[email protected]> * Apply suggestions from code review Co-authored-by: Sebastian Blank <[email protected]> * fixed phpdoc types - in preparation for pimcore#13869 * fixed phpdoc types - in preparation for pimcore#13869 * fixed phpdoc types - in preparation for pimcore#13869 * Apply suggestions from code review Co-authored-by: mcop1 <[email protected]> * Apply suggestions from code review Co-authored-by: Sebastian Blank <[email protected]> Co-authored-by: Sebastian Blank <[email protected]> Co-authored-by: mcop1 <[email protected]>
michalananapps · Jan 13, 2023 · 596f565 · 596f565
1 parent ad03a42
commit 596f565
Show file tree

Hide file tree

Showing 97 changed files with 551 additions and 65 deletions.
diff --git a/bundles/EcommerceFrameworkBundle/CartManager/AbstractCartCheckoutData.php b/bundles/EcommerceFrameworkBundle/CartManager/AbstractCartCheckoutData.php
@@ -55,6 +55,11 @@ public function getCartId()
 
     abstract public function save();
 
+    /**
+     * @param string $key
+     * @param int|string $cartId
+     * @return AbstractCartCheckoutData|null
+     */
     public static function getByKeyCartId($key, $cartId)
     {
         throw new \Exception('Not implemented.');

diff --git a/bundles/EcommerceFrameworkBundle/CartManager/CartCheckoutData.php b/bundles/EcommerceFrameworkBundle/CartManager/CartCheckoutData.php
@@ -30,6 +30,11 @@ public function save()
         $this->getDao()->save();
     }
 
+    /**
+     * @param string $key
+     * @param int|string $cartId
+     * @return AbstractCartCheckoutData|null
+     */
     public static function getByKeyCartId($key, $cartId)
     {
         $cacheKey = CartCheckoutData\Dao::TABLE_NAME . '_' . $key . '_' . $cartId;

diff --git a/bundles/EcommerceFrameworkBundle/CartManager/CartInterface.php b/bundles/EcommerceFrameworkBundle/CartManager/CartInterface.php
@@ -338,6 +338,7 @@ public function getVoucherTokenCodes();
     public function getPricingManagerTokenInformationDetails(): array;
 
     /**
+     * @param int $errorCode
      * @return bool
      */
     public function isVoucherErrorCode($errorCode);

diff --git a/bundles/EcommerceFrameworkBundle/CartManager/CartPriceCalculator.php b/bundles/EcommerceFrameworkBundle/CartManager/CartPriceCalculator.php
@@ -151,6 +151,8 @@ protected function configureModificatorResolver(OptionsResolver $resolver)
     }
 
     /**
+     * @param bool $ignorePricingRules
+     * @return void
      * @throws UnsupportedException
      */
     public function calculate($ignorePricingRules = false)

diff --git a/bundles/EcommerceFrameworkBundle/CartManager/CartPriceCalculatorInterface.php b/bundles/EcommerceFrameworkBundle/CartManager/CartPriceCalculatorInterface.php
@@ -42,6 +42,7 @@ public function initModificators();
     /**
      * Calculates cart sums and saves results
      *
+     * @param bool $ignorePricingRules
      * @return void
      */
     public function calculate($ignorePricingRules = false);

diff --git a/bundles/EcommerceFrameworkBundle/CartManager/SessionCartCheckoutData.php b/bundles/EcommerceFrameworkBundle/CartManager/SessionCartCheckoutData.php
@@ -24,6 +24,11 @@ public function save()
         throw new \Exception('Not implemented, should not be needed for this cart type.');
     }
 
+    /**
+     * @param string $key
+     * @param int|string $cartId
+     * @return AbstractCartCheckoutData|null
+     */
     public static function getByKeyCartId($key, $cartId)
     {
         throw new \Exception('Not implemented, should not be needed for this cart type.');
@@ -56,11 +61,18 @@ public function getCart()
         return $this->cart;
     }
 
+    /**
+     * @return int|string|null
+     */
     public function getCartId()
     {
         return $this->cartId;
     }
 
+    /**
+     * @param int|string|null $cartId
+     * @return void
+     */
     public function setCartId($cartId)
     {
         $this->cartId = $cartId;

diff --git a/bundles/EcommerceFrameworkBundle/CoreExtensions/ClassDefinition/IndexFieldSelection.php b/bundles/EcommerceFrameworkBundle/CoreExtensions/ClassDefinition/IndexFieldSelection.php
@@ -72,11 +72,18 @@ public function __construct()
     {
     }
 
+    /**
+     * @param bool $considerTenants
+     * @return void
+     */
     public function setConsiderTenants($considerTenants)
     {
         $this->considerTenants = $considerTenants;
     }
 
+    /**
+     * @return bool
+     */
     public function getConsiderTenants()
     {
         return $this->considerTenants;

diff --git a/bundles/EcommerceFrameworkBundle/CoreExtensions/ClassDefinition/IndexFieldSelectionCombo.php b/bundles/EcommerceFrameworkBundle/CoreExtensions/ClassDefinition/IndexFieldSelectionCombo.php
@@ -72,31 +72,52 @@ protected function buildOptions(): array
         return $options;
     }
 
+    /**
+     * @param bool $specificPriceField
+     * @return void
+     */
     public function setSpecificPriceField($specificPriceField)
     {
         $this->specificPriceField = $specificPriceField;
     }
 
+    /**
+     * @return bool
+     */
     public function getSpecificPriceField()
     {
         return $this->specificPriceField;
     }
 
+    /**
+     * @param bool $showAllFields
+     * @return void
+     */
     public function setShowAllFields($showAllFields)
     {
         $this->showAllFields = $showAllFields;
     }
 
+    /**
+     * @return bool
+     */
     public function getShowAllFields()
     {
         return $this->showAllFields;
     }
 
+    /**
+     * @param bool $considerTenants
+     * @return void
+     */
     public function setConsiderTenants($considerTenants)
     {
         $this->considerTenants = $considerTenants;
     }
 
+    /**
+     * @return bool
+     */
     public function getConsiderTenants()
     {
         return $this->considerTenants;

diff --git a/bundles/EcommerceFrameworkBundle/CoreExtensions/ClassDefinition/IndexFieldSelectionField.php b/bundles/EcommerceFrameworkBundle/CoreExtensions/ClassDefinition/IndexFieldSelectionField.php
@@ -32,31 +32,52 @@ class IndexFieldSelectionField extends Textarea
 
     public $considerTenants = false;
 
+    /**
+     * @param bool $specificPriceField
+     * @return void
+     */
     public function setSpecificPriceField($specificPriceField)
     {
         $this->specificPriceField = $specificPriceField;
     }
 
+    /**
+     * @return bool
+     */
     public function getSpecificPriceField()
     {
         return $this->specificPriceField;
     }
 
+    /**
+     * @param bool $showAllFields
+     * @return void
+     */
     public function setShowAllFields($showAllFields)
     {
         $this->showAllFields = $showAllFields;
     }
 
+    /**
+     * @return bool
+     */
     public function getShowAllFields()
     {
         return $this->showAllFields;
     }
 
+    /**
+     * @param bool $considerTenants
+     * @return void
+     */
     public function setConsiderTenants($considerTenants)
     {
         $this->considerTenants = $considerTenants;
     }
 
+    /**
+     * @return bool
+     */
     public function getConsiderTenants()
     {
         return $this->considerTenants;

diff --git a/...rameworkBundle/DependencyInjection/ServiceLocator/AssortmentTenantAwareServiceLocator.php b/...rameworkBundle/DependencyInjection/ServiceLocator/AssortmentTenantAwareServiceLocator.php
@@ -19,6 +19,9 @@
 
 abstract class AssortmentTenantAwareServiceLocator extends TenantAwareServiceLocator
 {
+    /**
+     * @return string|null
+     */
     protected function getEnvironmentTenant()
     {
         return $this->environment->getCurrentAssortmentTenant();

diff --git a/...eFrameworkBundle/DependencyInjection/ServiceLocator/CheckoutTenantAwareServiceLocator.php b/...eFrameworkBundle/DependencyInjection/ServiceLocator/CheckoutTenantAwareServiceLocator.php
@@ -19,6 +19,9 @@
 
 abstract class CheckoutTenantAwareServiceLocator extends TenantAwareServiceLocator
 {
+    /**
+     * @return string|null
+     */
     protected function getEnvironmentTenant()
     {
         return $this->environment->getCurrentCheckoutTenant();

diff --git a/bundles/EcommerceFrameworkBundle/DependencyInjection/ServiceLocator/NameServiceLocator.php b/bundles/EcommerceFrameworkBundle/DependencyInjection/ServiceLocator/NameServiceLocator.php
@@ -37,6 +37,9 @@ public function __construct(PsrContainerInterface $locator)
         $this->locator = $locator;
     }
 
+    /**
+     * @return mixed
+     */
     protected function locate(string $name = null)
     {
         $name = $this->resolveName($name);

diff --git a/...EcommerceFrameworkBundle/DependencyInjection/ServiceLocator/TenantAwareServiceLocator.php b/...EcommerceFrameworkBundle/DependencyInjection/ServiceLocator/TenantAwareServiceLocator.php
@@ -55,6 +55,9 @@ public function __construct(
         $this->strictTenants = $strictTenants;
     }
 
+    /**
+     * @return mixed
+     */
     protected function locate(string $tenant = null)
     {
         $tenant = $this->resolveTenant($tenant);
@@ -87,5 +90,8 @@ protected function resolveTenant(string $tenant = null)
         return $this->defaultTenant;
     }
 
+    /**
+     * @return string|null
+     */
     abstract protected function getEnvironmentTenant();
 }
diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Config/DefaultFindologic.php b/bundles/EcommerceFrameworkBundle/IndexService/Config/DefaultFindologic.php
@@ -132,7 +132,7 @@ public function getSubTenantCondition()
      * creates object mockup for given data
      *
      * @param int $objectId
-     * @param mixed $data
+     * @param array $data
      * @param array $relations
      *
      * @return DefaultMockup

diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Config/Definition/Attribute.php b/bundles/EcommerceFrameworkBundle/IndexService/Config/Definition/Attribute.php
@@ -154,6 +154,11 @@ public function getOptions(): array
         return $this->options;
     }
 
+    /**
+     * @param string $name
+     * @param mixed $defaultValue
+     * @return mixed
+     */
     public function getOption(string $name, $defaultValue = null)
     {
         return $this->options[$name] ?? $defaultValue;

diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Config/ElasticSearch.php b/bundles/EcommerceFrameworkBundle/IndexService/Config/ElasticSearch.php
@@ -348,7 +348,7 @@ public function setTenantWorker(WorkerInterface $tenantWorker)
      * creates object mockup for given data
      *
      * @param int $objectId
-     * @param mixed $data
+     * @param array $data
      * @param array $relations
      *
      * @return DefaultMockup

diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Config/MockupConfigInterface.php b/bundles/EcommerceFrameworkBundle/IndexService/Config/MockupConfigInterface.php
@@ -24,7 +24,7 @@ interface MockupConfigInterface
      * creates object mockup for given data
      *
      * @param int $objectId
-     * @param mixed $data
+     * @param array $data
      * @param array $relations
      *
      * @return mixed

diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Config/OptimizedMysql.php b/bundles/EcommerceFrameworkBundle/IndexService/Config/OptimizedMysql.php
@@ -29,7 +29,7 @@ class OptimizedMysql extends DefaultMysql implements MockupConfigInterface
      * creates object mockup for given data
      *
      * @param int $objectId
-     * @param mixed $data
+     * @param array $data
      * @param array $relations
      *
      * @return DefaultMockup

diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Getter/DefaultBrickGetter.php b/bundles/EcommerceFrameworkBundle/IndexService/Getter/DefaultBrickGetter.php
@@ -22,6 +22,11 @@ class DefaultBrickGetter implements GetterInterface
 {
     use OptionsResolverTrait;
 
+    /**
+     * @param object $object
+     * @param array $config
+     * @return mixed
+     */
     public function get($object, $config = null)
     {
         $config = $this->resolveOptions($config ?? []);

diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Getter/DefaultBrickGetterSequence.php b/bundles/EcommerceFrameworkBundle/IndexService/Getter/DefaultBrickGetterSequence.php
@@ -22,6 +22,11 @@ class DefaultBrickGetterSequence implements GetterInterface
 {
     use OptionsResolverTrait;
 
+    /**
+     * @param object $object
+     * @param array $config
+     * @return mixed
+     */
     public function get($object, $config = null)
     {
         $config = $this->resolveOptions($config ?? []);

diff --git a/.../EcommerceFrameworkBundle/IndexService/Getter/DefaultBrickGetterSequenceToMultiselect.php b/.../EcommerceFrameworkBundle/IndexService/Getter/DefaultBrickGetterSequenceToMultiselect.php
@@ -22,6 +22,11 @@ class DefaultBrickGetterSequenceToMultiselect implements GetterInterface
 {
     use OptionsResolverTrait;
 
+    /**
+     * @param object $object
+     * @param array $config
+     * @return mixed
+     */
     public function get($object, $config = null)
     {
         $config = $this->resolveOptions($config ?? []);

diff --git a/...les/EcommerceFrameworkBundle/IndexService/Getter/DefaultClassificationAttributeGetter.php b/...les/EcommerceFrameworkBundle/IndexService/Getter/DefaultClassificationAttributeGetter.php
@@ -31,7 +31,7 @@ class DefaultClassificationAttributeGetter implements GetterInterface
      * note that this getter does not support localization at the moment
      *
      * @param object $object
-     * @param array|null $config
+     * @param array $config
      *
      * @return mixed
      */

diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Getter/ExtendedGetterInterface.php b/bundles/EcommerceFrameworkBundle/IndexService/Getter/ExtendedGetterInterface.php
@@ -22,5 +22,12 @@
  */
 interface ExtendedGetterInterface extends GetterInterface
 {
+    /**
+     * @param object $object
+     * @param array $config
+     * @param int|null $subObjectId
+     * @param ConfigInterface|null $tenantConfig
+     * @return mixed
+     */
     public function get($object, $config = null, $subObjectId = null, ConfigInterface $tenantConfig = null);
 }
diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Getter/GetterInterface.php b/bundles/EcommerceFrameworkBundle/IndexService/Getter/GetterInterface.php
@@ -17,5 +17,10 @@
 
 interface GetterInterface
 {
+    /**
+     * @param object $object
+     * @param array $config
+     * @return mixed
+     */
     public function get($object, $config = null);
 }
diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Getter/TagsGetter.php b/bundles/EcommerceFrameworkBundle/IndexService/Getter/TagsGetter.php
@@ -25,6 +25,11 @@ class TagsGetter implements GetterInterface
 {
     use OptionsResolverTrait;
 
+    /**
+     * @param object $element
+     * @param array $config
+     * @return mixed
+     */
     public function get($element, $config = null)
     {
         $config = $this->resolveOptions($config ?? []);

diff --git a/bundles/EcommerceFrameworkBundle/IndexService/Interpreter/AssetId.php b/bundles/EcommerceFrameworkBundle/IndexService/Interpreter/AssetId.php
@@ -19,6 +19,11 @@
 
 class AssetId implements InterpreterInterface
 {
+    /**
+     * @param mixed $value
+     * @param array|null $config
+     * @return int|null
+     */
     public function interpret($value, $config = null)
     {
         if (!empty($value) && $value instanceof Asset) {