update phpdoc standards

angrobg · Sep 26, 2019 · 55fbcba · 55fbcba
1 parent 6306ec7
commit 55fbcba
Show file tree

Hide file tree

Showing 45 changed files with 182 additions and 507 deletions.
diff --git a/Model/Entity/DataCollectorInterface.php b/Model/Entity/DataCollectorInterface.php
@@ -12,9 +12,5 @@
  */
 interface DataCollectorInterface
 {
-    /**
-     * @param object $entity
-     * @return array
-     */
-    public function collect($entity): array;
+    public function collect(object $entity): array;
 }
diff --git a/Service/Anonymize/Anonymizer/AlphaLower.php b/Service/Anonymize/Anonymizer/AlphaLower.php
@@ -7,22 +7,19 @@
 
 namespace Opengento\Gdpr\Service\Anonymize\Anonymizer;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Math\Random;
 use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface;
 
-/**
- * Class AlphaLower
- */
 final class AlphaLower implements AnonymizerInterface
 {
-    /**#@+
+    /**
      * Constants for alpha lower anonymizer
      */
     private const DEFAULT_LENGTH = 5;
-    /**#@-*/
 
     /**
-     * @var \Magento\Framework\Math\Random
+     * @var Random
      */
     private $mathRandom;
 
@@ -31,10 +28,6 @@ final class AlphaLower implements AnonymizerInterface
      */
     private $length;
 
-    /**
-     * @param \Magento\Framework\Math\Random $mathRandom
-     * @param int $length
-     */
     public function __construct(
         Random $mathRandom,
         int $length = self::DEFAULT_LENGTH
@@ -45,7 +38,7 @@ public function __construct(
 
     /**
      * @inheritdoc
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function anonymize($value): string
     {

diff --git a/Service/Anonymize/Anonymizer/AlphaNum.php b/Service/Anonymize/Anonymizer/AlphaNum.php
@@ -7,22 +7,19 @@
 
 namespace Opengento\Gdpr\Service\Anonymize\Anonymizer;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Math\Random;
 use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface;
 
-/**
- * Class AlphaNum
- */
 final class AlphaNum implements AnonymizerInterface
 {
-    /**#@+
+    /**
      * Constants for alpha numeric anonymizer
      */
     private const DEFAULT_LENGTH = 5;
-    /**#@-*/
 
     /**
-     * @var \Magento\Framework\Math\Random
+     * @var Random
      */
     private $mathRandom;
 
@@ -31,10 +28,6 @@ final class AlphaNum implements AnonymizerInterface
      */
     private $length;
 
-    /**
-     * @param \Magento\Framework\Math\Random $mathRandom
-     * @param int $length
-     */
     public function __construct(
         Random $mathRandom,
         int $length = self::DEFAULT_LENGTH
@@ -45,7 +38,7 @@ public function __construct(
 
     /**
      * @inheritdoc
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function anonymize($value): string
     {

diff --git a/Service/Anonymize/Anonymizer/AlphaUpper.php b/Service/Anonymize/Anonymizer/AlphaUpper.php
@@ -7,22 +7,19 @@
 
 namespace Opengento\Gdpr\Service\Anonymize\Anonymizer;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Math\Random;
 use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface;
 
-/**
- * Class AlphaUpper
- */
 final class AlphaUpper implements AnonymizerInterface
 {
-    /**#@+
+    /**
      * Constants for alpha upper anonymizer
      */
     private const DEFAULT_LENGTH = 5;
-    /**#@-*/
 
     /**
-     * @var \Magento\Framework\Math\Random
+     * @var Random
      */
     private $mathRandom;
 
@@ -31,10 +28,6 @@ final class AlphaUpper implements AnonymizerInterface
      */
     private $length;
 
-    /**
-     * @param \Magento\Framework\Math\Random $mathRandom
-     * @param int $length
-     */
     public function __construct(
         Random $mathRandom,
         int $length = self::DEFAULT_LENGTH
@@ -45,7 +38,7 @@ public function __construct(
 
     /**
      * @inheritdoc
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function anonymize($value): string
     {

diff --git a/Service/Anonymize/Anonymizer/Anonymous.php b/Service/Anonymize/Anonymizer/Anonymous.php
@@ -7,31 +7,25 @@
 
 namespace Opengento\Gdpr\Service\Anonymize\Anonymizer;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Math\Random;
 use Magento\Framework\Phrase;
 use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface;
 
-/**
- * Class Anonymous
- */
 final class Anonymous implements AnonymizerInterface
 {
-    /**#@+
+    /**
      * Constants for anonymous anonymizer
      */
     private const PHRASE = '%1Anonymous%2';
     private const PREFIX_LENGTH = 3;
     private const SUFFIX_LENGTH = 2;
-    /**#@-*/
 
     /**
-     * @var \Magento\Framework\Math\Random
+     * @var Random
      */
     private $mathRandom;
 
-    /**
-     * @param \Magento\Framework\Math\Random $mathRandom
-     */
     public function __construct(
         Random $mathRandom
     ) {
@@ -40,7 +34,7 @@ public function __construct(
 
     /**
      * @inheritdoc
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function anonymize($value): string
     {

diff --git a/Service/Anonymize/Anonymizer/ArrayValue.php b/Service/Anonymize/Anonymizer/ArrayValue.php
@@ -8,19 +8,17 @@
 namespace Opengento\Gdpr\Service\Anonymize\Anonymizer;
 
 use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface;
+use function array_reduce;
 
-/**
- * Class ArrayValue
- */
 final class ArrayValue implements AnonymizerInterface
 {
     /**
-     * @var \Opengento\Gdpr\Service\Anonymize\AnonymizerInterface[]
+     * @var AnonymizerInterface[]
      */
     private $anonymizers;
 
     /**
-     * @param \Opengento\Gdpr\Service\Anonymize\AnonymizerInterface[] $anonymizers
+     * @param AnonymizerInterface[] $anonymizers
      */
     public function __construct(
         array $anonymizers
@@ -30,12 +28,9 @@ public function __construct(
         })(... $anonymizers);
     }
 
-    /**
-     * @inheritdoc
-     */
     public function anonymize($value): array
     {
-        return \array_reduce(
+        return array_reduce(
             $this->anonymizers,
             static function ($array, AnonymizerInterface $anonymizer) use ($value) {
                 $array[] = $anonymizer->anonymize($value);

diff --git a/Service/Anonymize/Anonymizer/Date.php b/Service/Anonymize/Anonymizer/Date.php
@@ -7,25 +7,22 @@
 
 namespace Opengento\Gdpr\Service\Anonymize\Anonymizer;
 
+use Exception;
 use Magento\Framework\Math\Random;
 use Magento\Framework\Stdlib\DateTime;
 use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface;
 
-/**
- * Class Date
- */
 final class Date implements AnonymizerInterface
 {
-    /**#@+
+    /**
      * Constants for date anonymizer
      */
     private const MIN_TIMESTAMP = 0;
     private const MAX_TIMESTAMP = 1557480188;
-    /**#@-*/
 
     /**
      * @inheritdoc
-     * @throws \Exception
+     * @throws Exception
      */
     public function anonymize($value): string
     {

diff --git a/Service/Anonymize/Anonymizer/Email.php b/Service/Anonymize/Anonymizer/Email.php
@@ -7,31 +7,25 @@
 
 namespace Opengento\Gdpr\Service\Anonymize\Anonymizer;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Math\Random;
 use Magento\Framework\Phrase;
 use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface;
 
-/**
- * Class Email
- */
 final class Email implements AnonymizerInterface
 {
-    /**#@+
+    /**
      * Constants for value anonymizer
      */
     private const PHRASE = '%1-anonymous-%[email protected]';
     private const PREFIX_LENGTH = 3;
     private const SUFFIX_LENGTH = 2;
-    /**#@-*/
 
     /**
-     * @var \Magento\Framework\Math\Random
+     * @var Random
      */
     private $mathRandom;
 
-    /**
-     * @param \Magento\Framework\Math\Random $mathRandom
-     */
     public function __construct(
         Random $mathRandom
     ) {
@@ -40,7 +34,7 @@ public function __construct(
 
     /**
      * @inheritdoc
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function anonymize($value): string
     {

diff --git a/Service/Anonymize/Anonymizer/Entity.php b/Service/Anonymize/Anonymizer/Entity.php
@@ -7,36 +7,33 @@
 
 namespace Opengento\Gdpr\Service\Anonymize\Anonymizer;
 
+use Exception;
+use InvalidArgumentException;
 use Magento\Framework\EntityManager\HydratorPool;
 use Magento\Framework\EntityManager\TypeResolver;
 use Opengento\Gdpr\Model\Entity\DataCollectorInterface;
 use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface;
+use function gettype;
+use function is_object;
+use function sprintf;
 
-/**
- * Class Entity
- */
 final class Entity implements AnonymizerInterface
 {
     /**
-     * @var \Opengento\Gdpr\Model\Entity\DataCollectorInterface
+     * @var DataCollectorInterface
      */
     private $dataCollector;
 
     /**
-     * @var \Magento\Framework\EntityManager\TypeResolver
+     * @var TypeResolver
      */
     private $typeResolver;
 
     /**
-     * @var \Magento\Framework\EntityManager\HydratorPool
+     * @var HydratorPool
      */
     private $hydratorPool;
 
-    /**
-     * @param \Opengento\Gdpr\Model\Entity\DataCollectorInterface $dataCollector
-     * @param \Magento\Framework\EntityManager\TypeResolver $typeResolver
-     * @param \Magento\Framework\EntityManager\HydratorPool $hydratorPool
-     */
     public function __construct(
         DataCollectorInterface $dataCollector,
         TypeResolver $typeResolver,
@@ -49,13 +46,13 @@ public function __construct(
 
     /**
      * @inheritdoc
-     * @throws \Exception
+     * @throws Exception
      */
     public function anonymize($entity)
     {
-        if (!\is_object($entity)) {
-            throw new \InvalidArgumentException(
-                \sprintf('Argument "$entity" must be an object, type "%s" given.', \gettype($entity))
+        if (!is_object($entity)) {
+            throw new InvalidArgumentException(
+                sprintf('Argument "$entity" must be an object, type "%s" given.', gettype($entity))
             );
         }
 

diff --git a/Service/Anonymize/Anonymizer/NullValue.php b/Service/Anonymize/Anonymizer/NullValue.php
@@ -9,14 +9,8 @@
 
 use Opengento\Gdpr\Service\Anonymize\AnonymizerInterface;
 
-/**
- * Class NullValue
- */
 final class NullValue implements AnonymizerInterface
 {
-    /**
-     * @inheritdoc
-     */
     public function anonymize($value)
     {
         return null;