Introduce common codding standart and fix inconsistencies

Author: IvanChepurnyi

composer.json

@@ -32,8 +32,8 @@
     }
   },
   "scripts": {
-    "phpcs": "phpcs --standard=PSR1,PSR2 src/",
-    "phpcbf": "phpcbf --standard=PSR1,PSR2 src/",
+    "phpcs": "phpcs",
+    "phpcbf": "phpcbf",
     "phpstan": "phpstan analyze src"
   }
 }

phpcs.xml.dist

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<ruleset name="Compiler">
+    <description>The coding standard for EcomDev packages.</description>
+
+    <file>src</file>
+
+    <arg value="np"/>
+
+    <!-- Include some additional sniffs from the Generic standard -->
+    <rule ref="Generic.Commenting.DocComment"/>
+
+    <!-- Use Unix newlines -->
+    <rule ref="Generic.Files.LineEndings">
+      <properties>
+         <property name="eolChar" value="\n"/>
+      </properties>
+    </rule>
+
+    <rule ref="PSR2"/>
+    <rule ref="PSR2"/>
+</ruleset>

src/DataService/CustomerGroupProvider.php

@@ -13,7 +13,6 @@
 
 /**
  * Customer group provider for dynamic resolution of it
- *
  */
 class CustomerGroupProvider
 {

src/DataService/DataLoader.php

@@ -24,6 +24,7 @@ interface DataLoader
      *
      * @param ScopeFilter $filter
      * @param ProductWrapper[] $products
+     *
      * @return array
      */
     public function load(ScopeFilter $filter, array $products): array;
@@ -32,6 +33,7 @@ public function load(ScopeFilter $filter, array $products): array;
      * Checks if the preloader is applicable for this type of data.
      *
      * @param string $type
+     *
      * @return bool
      */
     public function isApplicable(string $type): bool;

src/DataService/LoadService.php

@@ -13,16 +13,22 @@
 class LoadService
 {
     /**
+     * Storage for preloaded data
+     *
      * @var array
      */
     private $storage = [];
 
     /**
+     * Mapping of SKU to ids
+     *
      * @var array
      */
     private $skuToId = [];
 
     /**
+     * List of registered data loaders by code
+     *
      * @var DataLoader[]
      */
     private $loaders;
@@ -45,6 +51,7 @@ public function __construct(array $loaders)
      * When SKU is not found it returns null
      *
      * @param string $sku
+     *
      * @return int|null
      */
     public function skuToId(string $sku): ?int
@@ -58,6 +65,7 @@ public function skuToId(string $sku): ?int
      *
      * @param int $productId
      * @param string $type
+     *
      * @return bool
      */
     public function has(int $productId, string $type): bool
@@ -70,6 +78,7 @@ public function has(int $productId, string $type): bool
      *
      * @param int $productId
      * @param string $type
+     *
      * @return array
      */
     public function get(int $productId, string $type): array

src/DataService/MagentoProductWrapper.php

@@ -14,6 +14,8 @@
 class MagentoProductWrapper implements ProductWrapper
 {
     /**
+     * Wrapped product model
+     *
      * @var Product
      */
     private $product;
@@ -29,41 +31,32 @@ public function __construct(Product $product)
     }
 
     /**
-     * Returns product SKU
-     *
-     * @return string
+     * {@inheritDoc}
      */
     public function getSku(): string
     {
         return $this->product->getSku();
     }
 
+
     /**
-     * Returns product ID
-     *
-     * @return int
+     * {@inheritDoc}
      */
     public function getId(): int
     {
         return (int)$this->product->getId();
     }
 
     /**
-     * Check if product is of a type
-     *
-     * @param string ...$type
-     * @return bool
+     * {@inheritDoc}
      */
     public function isType(string ...$type): bool
     {
         return in_array($this->product->getTypeId(), $type, true);
     }
 
     /**
-     * Updates field in wrapped product
-     *
-     * @param string $fieldName
-     * @param $value
+     * {@inheritDoc}
      */
     public function updateField(string $fieldName, $value): void
     {

src/DataService/MagentoScopeFilter.php

@@ -15,19 +15,33 @@
 class MagentoScopeFilter implements ScopeFilter
 {
     /**
+     * Provider of the customer group
+     *
      * @var CustomerGroupProvider
      */
     private $customerGroupProvider;
+
     /**
+     * Store manager interface
+     *
      * @var StoreManagerInterface
      */
     private $storeManager;
 
     /**
+     * List of provided filter options
+     *
      * @var array
      */
     private $options;
 
+    /**
+     * MagentoScopeFilter constructor.
+     *
+     * @param CustomerGroupProvider $customerGroupProvider
+     * @param StoreManagerInterface $storeManager
+     * @param array $options
+     */
     public function __construct(
         CustomerGroupProvider $customerGroupProvider,
         StoreManagerInterface $storeManager,
@@ -39,10 +53,9 @@ public function __construct(
         $this->options = $options;
     }
 
+
     /**
-     * Scope of the filtered data to be loaded
-     *
-     * @return int
+     * {@inheritDoc}
      */
     public function getWebsiteId(): int
     {
@@ -51,43 +64,31 @@ public function getWebsiteId(): int
     }
 
     /**
-     * Store ID scope of data to be loaded
-     *
-     * @return int
+     * {@inheritDoc}
      */
     public function getStoreId(): int
     {
         return (int)$this->options['store_id'];
     }
 
     /**
-     * Returns true if customer group has been explicitly set
-     *
-     * @return bool
+     * {@inheritDoc}
      */
     public function hasCustomerGroupId(): bool
     {
         return isset($this->options['group_id']);
     }
 
     /**
-     * Returns currently applied customer group
-     *
-     * Call this method only if your functionality relies on a customer group to provide functionality
-     *
-     * Otherwise check for hasCustomerGroup() call to make sure you only filter if customer group filter is set
-     *
-     * @return int
+     * {@inheritDoc}
      */
     public function getCustomerGroupId(): int
     {
         return (int)($this->options['group_id'] ?? $this->customerGroupProvider->getCustomerGroupId());
     }
 
     /**
-     * Returns a cache for grouping data loaders together
-     *
-     * @return string
+     * {@inheritDoc}
      */
     public function getCacheKey(): string
     {

src/DataService/ProductWrapper.php

@@ -32,15 +32,18 @@ public function getId(): int;
      * Check if product is of a type
      *
      * @param string ...$type
+     *
      * @return bool
      */
     public function isType(string ...$type): bool;
 
     /**
-     * Updates field in wrapped product
+     * Updates field in a wrapped product
      *
      * @param string $fieldName
-     * @param $value
+     * @param mixed $value
+     *
+     * @return void
      */
     public function updateField(string $fieldName, $value): void;
 }

src/DataService/ScopeFilterFactory.php

@@ -13,7 +13,6 @@
 
 /**
  * Scope filter factory
- *
  */
 class ScopeFilterFactory
 {
@@ -38,6 +37,7 @@ public function __construct(ObjectManagerInterface $objectManager)
      * Create scope filter from shopping cart
      *
      * @param CartInterface $cart
+     *
      * @return MagentoScopeFilter
      */
     public function createFromCart(CartInterface $cart): MagentoScopeFilter
@@ -54,6 +54,7 @@ public function createFromCart(CartInterface $cart): MagentoScopeFilter
      * Create scope filter from store identifier
      *
      * @param int $storeId
+     *
      * @return MagentoScopeFilter
      */
     public function createFromStore(int $storeId): MagentoScopeFilter
@@ -70,6 +71,7 @@ public function createFromStore(int $storeId): MagentoScopeFilter
      *
      * @param int $storeId
      * @param ProductLimitation $productLimitation
+     *
      * @return MagentoScopeFilter
      */
     public function createFromLimitation(int $storeId, ProductLimitation $productLimitation): MagentoScopeFilter

src/Observer/CartCollectionAfterLoad.php

@@ -69,7 +69,7 @@ public function setCart(CartInterface $cart)
      */
     public function execute(Observer $observer)
     {
-        /** @var Collection $collection */
+        /* @var Collection $collection */
         $collection = $observer->getData('collection');
 
         if (!$collection instanceof Collection) {