Merge branch 'develop'

postcodeservice · Mar 21, 2023 · aeb2a15 · aeb2a15
2 parents 94291a9 + 691ccb1
commit aeb2a15
Show file tree

Hide file tree

Showing 107 changed files with 1,347 additions and 488 deletions.
diff --git a/Block/Adminhtml/Config/Credentials/Button.php b/Block/Adminhtml/Config/Credentials/Button.php
@@ -37,19 +37,17 @@
 
 class Button extends Template implements RendererInterface
 {
-    const MODULE_NAME = 'TIG_Postcode';
+    public const MODULE_NAME = 'TIG_Postcode';
 
-    const CREDENTIALS_URL = 'https://postcodeservice.nl';
+    public const CREDENTIALS_URL = 'https://postcodeservice.nl';
 
     // @codingStandardsIgnoreLine
     protected $_template = 'TIG_Postcode::config/credentials/button.phtml';
 
+    // @codeCoverageIgnoreStart
     /**
-     * @param AbstractElement $element
-     *
-     * @return string
+     * @inheritdoc
      */
-    // @codeCoverageIgnoreStart
     public function render(AbstractElement $element)
     {
         /** @noinspection PhpUndefinedMethodInspection */
@@ -60,15 +58,18 @@ public function render(AbstractElement $element)
     // @codeCoverageIgnoreEnd
 
     /**
+     * Get Label
+     *
      * @return \Magento\Framework\Phrase
      */
     public function getLabel()
     {
-        // @codingStandardsIgnoreLine
         return __('Request Credentails');
     }
 
     /**
+     * Get credentials Url
+     *
      * @return string
      */
     public function getCredentialsUrl()

diff --git a/Block/Adminhtml/Config/Form/Field/Disable.php b/Block/Adminhtml/Config/Form/Field/Disable.php
@@ -37,16 +37,15 @@
 class Disable extends Field
 {
     /**
+     * @inheritdoc
+     *
      * @param AbstractElement $element
      *
      * @return string
      */
-    // @codeCoverageIgnoreStart
-    // @codingStandardsIgnoreLine
     protected function _getElementHtml(AbstractElement $element)
     {
         $element->setDisabled('disabled');
         return parent::_getElementHtml($element);
     }
-    // @codeCoverageIgnoreEnd
 }
diff --git a/Block/Adminhtml/Config/Form/Field/Fieldset.php b/Block/Adminhtml/Config/Form/Field/Fieldset.php
@@ -36,16 +36,18 @@
 
 class Fieldset extends MagentoFieldset
 {
+    /**
+     * @var string[]
+     */
     private $classNames = [
         '1' => 'modus_live',
         '2' => 'modus_test',
         '0' => 'modus_off'
     ];
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
-    // @codingStandardsIgnoreLine
     protected function _getFrontendClass($element)
     {
         $modus = $this->_scopeConfig->getValue(ModuleConfiguration::XPATH_CONFIGURATION_MODUS);

diff --git a/Block/Adminhtml/Config/Parsing/Streets.php b/Block/Adminhtml/Config/Parsing/Streets.php
@@ -37,23 +37,21 @@
 
 class Streets extends Template implements RendererInterface
 {
-    const MODULE_NAME = 'TIG_Postcode';
+    public const MODULE_NAME = 'TIG_Postcode';
 
-    // @codingStandardsIgnoreLine
+    /**
+     * @var string
+     */
     protected $_template = 'TIG_Postcode::config/parsing/streets.phtml';
 
     /**
-     * @param AbstractElement $element
-     *
-     * @return string
+     * @inheritdoc
      */
-    // @codeCoverageIgnoreStart
     public function render(AbstractElement $element)
     {
         /** @noinspection PhpUndefinedMethodInspection */
         $this->setElement($element);
 
         return $this->toHtml();
     }
-    // @codeCoverageIgnoreEnd
 }
diff --git a/Block/Adminhtml/Config/Support/BodyClass.php b/Block/Adminhtml/Config/Support/BodyClass.php
@@ -38,10 +38,10 @@
 class BodyClass extends Template implements BlockInterface
 {
     /**
+     * @inheritdoc
+     *
      * @return $this
      */
-    // @codeCoverageIgnoreStart
-    // @codingStandardsIgnoreLine
     protected function _prepareLayout()
     {
         if ($this->_request->getParam('section') == 'tig_postcode') {
@@ -50,5 +50,4 @@ protected function _prepareLayout()
 
         return parent::_prepareLayout();
     }
-    // @codeCoverageIgnoreEnd
 }
diff --git a/Block/Adminhtml/Config/Support/Tab.php b/Block/Adminhtml/Config/Support/Tab.php
@@ -40,7 +40,7 @@ class Tab extends Template implements RendererInterface
 {
     const MODULE_NAME = 'TIG_Postcode';
 
-    const EXTENSION_VERSION = '1.5.2';
+    const EXTENSION_VERSION = '1.5.3';
 
     // @codingStandardsIgnoreLine
     protected $_template = 'TIG_Postcode::config/support/tab.phtml';
@@ -68,7 +68,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function render(AbstractElement $element)
     {
@@ -89,6 +89,8 @@ public function getVersionNumber()
     }
 
     /**
+     * Get supported magento version
+     *
      * @return string
      */
     public function getSupportedMagentoVersions()

diff --git a/Config/CheckoutConfiguration/ActionUrl.php b/Config/CheckoutConfiguration/ActionUrl.php
@@ -52,6 +52,8 @@ public function __construct(
     }
 
     /**
+     * Get value and return belgium postcode URLs
+     *
      * @return array
      */
     public function getValue()

diff --git a/Config/CheckoutConfiguration/CheckoutConfigurationInterface.php b/Config/CheckoutConfiguration/CheckoutConfigurationInterface.php
@@ -34,6 +34,8 @@
 interface CheckoutConfigurationInterface
 {
     /**
+     * Get value
+     *
      * @return bool|string
      */
     public function getValue();

diff --git a/Config/CheckoutConfiguration/StreetParser.php b/Config/CheckoutConfiguration/StreetParser.php
@@ -36,6 +36,9 @@
 
 class StreetParser implements CheckoutConfigurationInterface
 {
+    /**
+     * @var ModuleConfiguration
+     */
     private $moduleConfiguration;
 
     /**
@@ -55,6 +58,8 @@ public function __construct(
     }
 
     /**
+     * Get value and return the housenumber information
+     *
      * @return mixed
      */
     public function getValue()

diff --git a/Config/Provider/AbstractConfigProvider.php b/Config/Provider/AbstractConfigProvider.php
@@ -84,8 +84,8 @@ public function __construct(
     /**
      * Get Config value with xpath
      *
-     * @param      $xpath
-     * @param null $store
+     * @param string|int    $xpath
+     * @param null          $store
      *
      * @return mixed
      */
@@ -100,7 +100,12 @@ protected function getConfigFromXpath($xpath, $store = null)
     }
 
     /**
+     * Check if the output is enabled
+     *
      * @return bool
+     *
+     * @deprecated unused method
+     * @since v1.5.0
      */
     // @codingStandardsIgnoreLine
     protected function isModuleOutputEnabled()
@@ -109,9 +114,12 @@ protected function isModuleOutputEnabled()
     }
 
     /**
-     * @param $type
+     * Get the base Url
+     *
+     * @param string|UrlInterface $type
      *
      * @return mixed
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
      */
     // @codingStandardsIgnoreLine
     protected function getBaseUrl($type = UrlInterface::URL_TYPE_WEB)

diff --git a/Config/Provider/ApiConfiguration.php b/Config/Provider/ApiConfiguration.php
@@ -33,15 +33,17 @@
 
 class ApiConfiguration extends AbstractConfigProvider
 {
-    const XPATH_API_BASE                 = 'tig_postcode/api/base';
-    const XPATH_API_VERSION              = 'tig_postcode/api/version';
-    const XPATH_API_TYPE                 = 'tig_postcode/api/type';
+    public const XPATH_API_BASE                 = 'tig_postcode/api/base';
+    public const XPATH_API_VERSION              = 'tig_postcode/api/version';
+    public const XPATH_API_TYPE                 = 'tig_postcode/api/type';
 
-    const XPATH_API_BE_BASE              = 'tig_postcode/api_be/base';
-    const XPATH_API_BE_POSTCODE_VERSION  = 'tig_postcode/api_be/postcode_version';
-    const XPATH_API_BE_STREET_VERSION    = 'tig_postcode/api_be/street_version';
+    public const XPATH_API_BE_BASE              = 'tig_postcode/api_be/base';
+    public const XPATH_API_BE_POSTCODE_VERSION  = 'tig_postcode/api_be/postcode_version';
+    public const XPATH_API_BE_STREET_VERSION    = 'tig_postcode/api_be/street_version';
 
     /**
+     * Get base Uri
+     *
      * @return string
      */
     public function getBaseUri()
@@ -50,6 +52,8 @@ public function getBaseUri()
     }
 
     /**
+     * Get Belgium base Uri
+     *
      * @param string $endpoint
      *
      * @return string
@@ -60,8 +64,10 @@ public function getBeBaseUri($endpoint)
     }
 
     /**
-     * @param null   $store
-     * @param string $country
+     * Get base path via country and store ID
+     *
+     * @param string            $country
+     * @param string|int|null   $store
      *
      * @return mixed
      */
@@ -78,9 +84,9 @@ public function getBase($country = 'NL', $store = null)
     /**
      * Versioning for BE is not live yet. Implement this function in getBeBaseUri when this goes live.
      *
-     * @param null          $store
-     * @param string|null   $country
-     * @param string|null   $endpoint
+     * @param string                $country
+     * @param string|null           $endpoint
+     * @param string|int|null       $store
      *
      * @return mixed
      */
@@ -99,7 +105,9 @@ public function getVersion($country = 'NL', $endpoint = null, $store = null)
     }
 
     /**
-     * @param null $store
+     * Get type via store ID
+     *
+     * @param string|int|null $store
      *
      * @return mixed
      */

diff --git a/Config/Provider/CheckoutConfiguration.php b/Config/Provider/CheckoutConfiguration.php
@@ -41,28 +41,38 @@
 
 class CheckoutConfiguration extends AbstractConfigProvider implements ConfigProviderInterface
 {
-    const XPATH_POSTCODE_SORT_ORDER = 'tig_postcode/checkout/postcode_sort_order';
-    const XPATH_CITY_SORT_ORDER     = 'tig_postcode/checkout/city_sort_order';
-    const XPATH_COUNTRY_SORT_ORDER  = 'tig_postcode/checkout/country_sort_order';
+    private const XPATH_POSTCODE_SORT_ORDER = 'tig_postcode/checkout/postcode_sort_order';
+    private const XPATH_CITY_SORT_ORDER     = 'tig_postcode/checkout/city_sort_order';
+    private const XPATH_COUNTRY_SORT_ORDER  = 'tig_postcode/checkout/country_sort_order';
 
     /**
      * @var array
      */
     private $postcodeConfiguration;
 
+    /**
+     * @param ScopeConfigInterface      $scopeConfig
+     * @param Manager                   $moduleManager
+     * @param Encryptor                 $crypt
+     * @param StoreManagerInterface     $storeManager
+     * @param array                     $postcodeConfiguration
+     */
     public function __construct(
         ScopeConfigInterface $scopeConfig,
         Manager $moduleManager,
         Encryptor $crypt,
         StoreManagerInterface $storeManager,
         $postcodeConfiguration = []
     ) {
-        $this->postcodeConfiguration = $postcodeConfiguration;
+        $this->postcodeConfiguration    = $postcodeConfiguration;
         parent::__construct($scopeConfig, $moduleManager, $crypt, $storeManager);
     }
 
     /**
+     * Get config for postcode
+     *
      * @return array
+     * @throws Exception
      */
     public function getConfig()
     {
@@ -78,8 +88,10 @@ public function getConfig()
     }
 
     /**
-     * @param $configuration
-     * @param $key
+     * Check Implementationn of the configuration
+     *
+     * @param CheckoutConfigurationInterface    $configuration
+     * @param string|int                        $key
      *
      * @throws Exception
      */
@@ -92,7 +104,9 @@ private function checkImplementation($configuration, $key)
     }
 
     /**
-     * @param null $store
+     * Get Postcode sortOrder by store ID
+     *
+     * @param string|int|null $store
      *
      * @return string
      */
@@ -102,7 +116,9 @@ public function getPostcodeSortOrder($store = null)
     }
 
     /**
-     * @param null $store
+     * Get City sortOrder by store ID
+     *
+     * @param string|int|null $store
      *
      * @return string
      */
@@ -112,7 +128,9 @@ public function getCitySortOrder($store = null)
     }
 
     /**
-     * @param null $store
+     * Get Country sortOrder by store ID
+     *
+     * @param string|int|null $store
      *
      * @return string
      */
-Original file line number
+Diff line change
@@ Expand Up / @@ -52,6 +52,8 @@ public function __construct( @@
         }
         /**
+         * Get value and return belgium postcode URLs
+         *
          * @return array
          */
         public function getValue()
@@ Expand Down @@