Merge branch 'pt-12044/5.2/introduce-phpstan' into 'master'

PT-12044 - Introduce PHPStan

See merge request shopware/5/services/swagpaymentpaypalunified!41

Author: mitelg

.githooks/pre-commit

@@ -31,6 +31,7 @@ class PreCommitChecks
 
         $this->runPhpLint($this->getCommittedFileList());
         $this->runPhpCsFixer($this->getCommittedFileList());
+        $this->runPHPStan($this->getCommittedFileList());
         $this->runEsLint($this->getCommittedFileList('js'));
 
         if ($this->error) {
@@ -139,6 +140,31 @@ class PreCommitChecks
         $this->writeln();
     }
 
+    private function runPHPStan(array $fileList)
+    {
+        $this->writeln('# Checking code with PHPStan');
+        $this->writeln('> phpstan.phar analyse');
+        $this->writeln();
+
+        if ($fileList === []) {
+            return;
+        }
+
+        if (!$this->isPHPStanAvailable()) {
+            $this->writeln('- PHPStan is NOT installed. Please install composer with dev dependencies or use higher Shopware version.', 2);
+            $this->writeln();
+
+            return;
+        }
+
+        exec('./../../../vendor/phpstan/phpstan/phpstan.phar analyse .', $output, $return);
+        if ($return !== 0) {
+            $this->error = true;
+        }
+
+        $this->writeln();
+    }
+
     /**
      * @param array $fileList
      */
@@ -171,6 +197,18 @@ class PreCommitChecks
         return !(bool) $return;
     }
 
+    /**
+     * @return bool
+     */
+    private function isPHPStanAvailable()
+    {
+        $output = [];
+        $return = 0;
+        exec('command -v ./../../../vendor/phpstan/phpstan/phpstan.phar >/dev/null 2>&1', $output, $return);
+
+        return !(bool) $return;
+    }
+
     /**
      * @return bool
      */

.gitlab-ci.yml

@@ -50,6 +50,7 @@ PHP analyze:
         - cp /usr/local/bin/composer composer.phar
         - php composer.phar install
         - vendor/bin/php-cs-fixer fix --dry-run -v --config=custom/plugins/SwagPaymentPayPalUnified/.php_cs.dist --format=junit | tee php-cs-fixer.xml
+        - vendor/phpstan/phpstan/phpstan.phar analyse custom/plugins/SwagPaymentPayPalUnified -c custom/plugins/SwagPaymentPayPalUnified/phpstan.neon
     artifacts:
         reports:
             junit: shopware/php-cs-fixer.xml

Bundle/AccountBundle/Service/Validator/AddressValidatorDecorator.php

@@ -12,6 +12,7 @@
 use Shopware\Components\Api\Exception\ValidationException;
 use Shopware\Models\Customer\Address;
 use Symfony\Component\Validator\ConstraintViolationInterface;
+use Symfony\Component\Validator\ConstraintViolationList;
 
 class AddressValidatorDecorator implements AddressValidatorInterface
 {
@@ -54,6 +55,7 @@ public function validate(Address $address)
         try {
             $this->innerValidator->validate($address);
         } catch (ValidationException $exception) {
+            /** @var ConstraintViolationList $violations */
             $violations = $exception->getViolations();
 
             // these values are not always provided by PayPal, but might be required due to the shop settings

Components/Backend/CaptureService.php

@@ -89,6 +89,7 @@ public function captureOrder($orderId, $amountToCapture, $currency, $isFinal)
     }
 
     /**
+     * @param string $authorizationId
      * @param string $amountToCapture
      * @param string $currency
      * @param bool   $isFinal

Components/Document/InstallmentsDocumentHandler.php

@@ -32,7 +32,7 @@ public function __construct(Connection $dbalConnection, OrderCreditInfoService $
     }
 
     /**
-     * @param int $orderNumber
+     * @param string $orderNumber
      */
     public function handleDocument($orderNumber, Document $document)
     {

Components/Document/InvoiceDocumentHandler.php

@@ -48,7 +48,7 @@ public function __construct(
     }
 
     /**
-     * @param int $orderNumber
+     * @param string $orderNumber
      */
     public function handleDocument($orderNumber, Document $document)
     {

Components/Exception/OrderNotFoundException.php

@@ -10,6 +10,11 @@
 
 class OrderNotFoundException extends \RuntimeException
 {
+    /**
+     * @param string $parameter
+     * @param string $value
+     * @param int    $code
+     */
     public function __construct($parameter, $value, $code = 0, \Throwable $previous = null)
     {
         $message = sprintf('Could not find order with search parameter "%s" and value "%s"', $parameter, $value);

Components/Services/OrderDataService.php

@@ -83,7 +83,7 @@ public function setOrderState($orderNumber, $orderStateId)
     {
         $builder = $this->dbalConnection->createQueryBuilder();
         $builder->update('s_order', 'o')
-            ->set('o.status', $orderStateId)
+            ->set('o.status', (string) $orderStateId)
             ->where('o.ordernumber = :orderNumber')
             ->setParameter(':orderNumber', $orderNumber)
             ->execute();

Components/Services/PaymentBuilderService.php

@@ -54,7 +54,7 @@ class PaymentBuilderService implements PaymentBuilderInterface
      */
     private $basketData;
 
-    /*
+    /**
      * @var array
      */
     private $userData;

Components/Services/Plus/PaymentInstructionService.php

@@ -49,7 +49,7 @@ public function createInstructions($orderNumber, PaymentInstruction $paymentInst
         $model->setBankName($paymentInstruction->getRecipientBanking()->getBankName());
         $model->setBic($paymentInstruction->getRecipientBanking()->getBic());
         $model->setIban($paymentInstruction->getRecipientBanking()->getIban());
-        $model->setAmount($paymentInstruction->getAmount()->getValue());
+        $model->setAmount((string) $paymentInstruction->getAmount()->getValue());
         $model->setDueDate($paymentInstruction->getDueDate());
         $model->setReference($paymentInstruction->getReferenceNumber());