IMA-1434: Codesniffer Warnings (#53)

* Improvements in the codebase, fixing the most relevant warnings.

Author: jsalguero94

Block/Adminhtml/Form/Field/MaskText.php

@@ -17,6 +17,7 @@ class MaskText extends \Magento\Framework\Data\Form\Element\Text
      * @param CollectionFactory $factoryCollection
      * @param Escaper $escaper
      * @param array $data
+     * @return void
      */
     public function __construct(
         \Magento\Framework\Data\Form\Element\Factory $factoryElement,
@@ -31,6 +32,12 @@ public function __construct(
         $this->setValue('');
     }
 
+    /**
+     * Mask text removing all but last 4 characters
+     *
+     * @param array $data
+     * @return array
+     */
     private function maskText($data)
     {
         if (isset($data["value"])) {

Block/IntegrationScript.php

@@ -13,9 +13,8 @@
 use Magento\Framework\View\Element\Template\Context;
 
 /**
- * Class IntegrationScript
+ * Class IntegrationScript - Integration script block
  *
- * @package Impact\Integration\Block
  */
 class IntegrationScript extends Template
 {

Block/System/Config/Button.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Impact: Partnership Cloud for Magento
  *
@@ -9,33 +10,19 @@
 namespace Impact\Integration\Block\System\Config;
 
 use Magento\Config\Block\System\Config\Form\Field;
-use Magento\Backend\Block\Template\Context;
+use Magento\Backend\Block\Widget\Button as ButtonBlock;
 
 /**
- * Class Button
+ * Class Button - Button controller
  *
- * @package IImpact\Integration\Block\System\Config
  */
 class Button extends Field
 {
     /**
      * @var string $_template
      */
     protected $_template = 'Impact_Integration::system/config/button.phtml';
-    
-    /**
-     * Button constructor.
-     *
-     * @param Context $context
-     * @param array $data
-     */
-    public function __construct(
-        Context $context,
-        array $data = []
-    ) {
-        parent::__construct($context, $data);
-    }
- 
+
     /**
      * Function render.
      *
@@ -59,29 +46,26 @@ protected function _getElementHtml(\Magento\Framework\Data\Form\Element\Abstract
 
     /**
      * Function getAjaxUrl.
-     *
      */
     public function getAjaxUrl()
     {
         return $this->getUrl('Impact_Integration/system_config/button');
     }
-    
+
     /**
      * Function getButtonHtml.
-     *
      */
     public function getButtonHtml()
     {
-        $button = $this->getLayout()->createBlock(
-            'Magento\Backend\Block\Widget\Button'
-        )->setData(
+        $button = $this->getLayout()->createBlock(ButtonBlock::class)
+        ->setData(
             [
                 'id' => 'btnid',
                 'class' => 'primary',
                 'label' => __('Uninstall'),
             ]
         );
- 
+
         return $button->toHtml();
     }
 }

Block/System/Config/NewPage.php

@@ -13,8 +13,6 @@
 
 /**
  * Class Button
- *
- * @package IImpact\Integration\Block\System\Config
  */
 class NewPage extends Field
 {
@@ -58,39 +56,40 @@ protected function _getElementHtml(\Magento\Framework\Data\Form\Element\Abstract
         return $this->_toHtml();
     }
 
-
     /**
      * Function getAjaxUrl.
-     *
      */
     public function getAjaxUrl()
     {
         return $this->getUrl('Impact_Integration/system_config/button');
     }
-    
+
     /**
      * Function getButtonHtml.
-     *
      */
     public function getButtonHtml()
     {
         $button = $this->getLayout()->createBlock(
-            'Magento\Backend\Block\Widget\Button'
+            \Magento\Backend\Block\Widget\Button::class
         )->setData(
             [
                 'id' => 'btnid',
                 'class' => 'primary',
                 'label' => __('Uninstall')
             ]
         );
-        
+
         return $button->toHtml();
     }
 
+    /**
+     * Function getButtonHtml.
+     */
     private function retrieveDataFromDb()
     {
         $object = \Magento\Framework\App\ObjectManager::getInstance();
-        $con = $object->get('Magento\Framework\App\ResourceConnection')->getConnection('\Magento\Framework\App\ResourceConnection::DEFAULT');
+        $con = $object->get(\Magento\Framework\App\ResourceConnection::class)
+        ->getConnection('\Magento\Framework\App\ResourceConnection::DEFAULT');
 
         $results = $con->fetchAll("
             SELECT * from core_config_data where path in ('impact_integration/existing_customer/account_sid',
@@ -104,6 +103,11 @@ private function retrieveDataFromDb()
         return $results;
     }
 
+    /**
+     * Function encapsulateValues.
+     *
+     * @param array $results
+     */
     private function encapsulateValues($results)
     {
         $var = [];

Controller/Adminhtml/System/Config/Button.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Impact: Partnership Cloud for Magento
  *
@@ -7,7 +8,7 @@
  */
 
 namespace Impact\Integration\Controller\Adminhtml\System\Config;
- 
+
 use Impact\Integration\Service\ImpactApiService;
 use Magento\Integration\Api\IntegrationServiceInterface;
 use Magento\Integration\Api\OauthServiceInterface;
@@ -17,19 +18,17 @@
 use Magento\Backend\App\Action;
 
 /**
- * Class Button
+ * Class Button - Button controller
  *
- * @package Impact\Integration\Controller\Adminhtml\System\Config
  */
 class Button extends Action
 {
     /**
      * API request endpoint integration
      */
-    const API_ENDPOINT_UNINSTALL = 'https://saasler-magento-impact.herokuapp.com/uninstall';
+    protected const API_ENDPOINT_UNINSTALL = 'https://saasler-magento-impact.herokuapp.com/uninstall';
 
     /**
-     * Integration service
      *
      * @var \Magento\Integration\Api\IntegrationServiceInterface
      */
@@ -57,7 +56,7 @@ class Button extends Action
     /**
      * Button constructor.
      *
-     * @param Context $context,
+     * @param Context $context
      * @param LoggerInterface $logger
      * @param IntegrationServiceInterface $integrationService
      * @param OauthServiceInterface $oauthService
@@ -92,9 +91,14 @@ public function execute()
             // Get accesstoken from integration
             $token = $this->oauthService->getAccessToken($integration->getConsumerId());
             $accessToken = $token->getToken();
-        
+
             // Send request uninstall in saasler
-            $impactApiService = new ImpactApiService($accessToken, static::API_ENDPOINT_UNINSTALL, 'DELETE', json_encode(['Deleted'=>'yes']));
+            $impactApiService = new ImpactApiService(
+                $accessToken,
+                static::API_ENDPOINT_UNINSTALL,
+                'DELETE',
+                json_encode(['Deleted' => 'yes'])
+            );
             $response = $impactApiService->execute();
 
             // Delete integration record

Helper/Data.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Impact: Partnership Cloud for Magento
  *
@@ -12,37 +13,36 @@
 use Magento\Store\Model\ScopeInterface;
 
 /**
- * Class Data
+ * Class Data - Helper for Data
  *
- * @package Impact\Integration\Helper
  */
 class Data extends AbstractHelper
 {
     /**
-    * Row in core_config_data table for enable extension
-    */
-    const MODULE_ENABLE_DISABLE = 'impact_integration/general/enabled';
+     * Row in core_config_data table for enable extension
+     */
+    protected const MODULE_ENABLE_DISABLE = 'impact_integration/general/enabled';
 
     /**
-    * Row in core_config_data table for conversion url
-    */
-    const  XML_CONVERSION_URL_PATH = 'impact_integration/existing_customer/conversion_url';
+     * Row in core_config_data table for conversion url
+     */
+    protected const  XML_CONVERSION_URL_PATH = 'impact_integration/existing_customer/conversion_url';
 
     /**
-    * Row in core_config_data table for refund url
-    */
-    const XML_REFUND_URL_PATH = 'impact_integration/existing_customer/refund_url';
+     * Row in core_config_data table for refund url
+     */
+    protected const XML_REFUND_URL_PATH = 'impact_integration/existing_customer/refund_url';
 
     /**
-    * Row in core_config_data table for utt script
-    */
-    const XML_UTT_DEFAULT_PATH = 'impact_integration/existing_customer/utt_default';
+     * Row in core_config_data table for utt script
+     */
+    protected const XML_UTT_DEFAULT_PATH = 'impact_integration/existing_customer/utt_default';
 
-     /**
-      * Get conversion url.
-      *
-      * @return string
-      */
+    /**
+     * Get conversion url.
+     *
+     * @return string
+     */
     public function getConversionUrl()
     {
         return $this->scopeConfig->getValue(static::XML_CONVERSION_URL_PATH);

Model/ConfigData.php

@@ -12,9 +12,8 @@
 use Magento\Config\Model\ResourceModel\Config;
 
 /**
- * Class ConfigData
+ * Class ConfigData - Model for ConfigData
  *
- * @package Impact\Integration\Model
  */
 class ConfigData
 {

Observer/CheckoutOnePageControllerSuccessAction.php

@@ -15,9 +15,8 @@
 use Impact\Integration\Helper\Data;
 
 /**
- * Class CheckoutOnePageControllerSuccessAction
+ * Class CheckoutOnePageControllerSuccessAction - Observer for CheckoutOnePageControllerSuccessAction
  *
- * @package Impact\Integration\Observer
  */
 class CheckoutOnePageControllerSuccessAction implements ObserverInterface
 {
@@ -46,19 +45,27 @@ public function __construct(
     }
 
     /**
+     * Execute Function - Send conversion to Impact
+     *
      * @param EventObserver $observer
      * @return $this
      */
     public function execute(EventObserver $observer)
     {
         // Validate if module is enable
-        if ($this->helper->isEnabled() && !empty($this->helper->getConversionUrl()) && !is_null($this->helper->getConversionUrl())) {
+        if ($this->helper->isEnabled()
+        && !empty($this->helper->getConversionUrl()) && $this->helper->getConversionUrl() !== null) {
             // Get data from order
             $order = $observer->getEvent()->getOrder();
             $entityId = $order->getEntityId();
             $irclickid = $this->cookieManager->getCookie('irclickid');
 
-            $saaslerApiService = new ImpactApiService('', $this->helper->getConversionUrl(), 'POST', json_encode(['order_id' => $entityId, 'irclickid' => $irclickid]));
+            $saaslerApiService = new ImpactApiService(
+                '',
+                $this->helper->getConversionUrl(),
+                'POST',
+                json_encode(['order_id' => $entityId, 'irclickid' => $irclickid])
+            );
             $response = $saaslerApiService->execute();
             $responseBody = $response->getBody();
             $responseContent = $responseBody->getContents();