Merge pull request #70 from alexander-schranz/enhancement/phpsta-anal…

…yzer Add phpstan to travis ci
sulu · Nov 17, 2017 · 68d9979 · 68d9979
2 parents 0324653 + 2fdcd44
commit 68d9979
Show file tree

Hide file tree

Showing 19 changed files with 92 additions and 60 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -9,25 +9,27 @@ cache:
 matrix:
   include:
     - php: 5.5
-      # env:
-      #   - COMPOSER_FLAGS="--prefer-lowest --prefer-dist --no-interaction"
+      env:
+         - COMPOSER_FLAGS="--prefer-dist --no-interaction" # --prefer-lowest not possible in sulu 1.3
     - php: 7.0
       env:
-      # - COMPOSER_FLAGS="--prefer-dist --no-interaction"
+        - COMPOSER_FLAGS="--prefer-dist --no-interaction"
         - CODE_COVERAGE=true
+        - PHPSTAN=true
 
 before_install:
   - phpenv config-add Tests/travis.php.ini
   - composer self-update
 
 install:
-  - travis_retry composer update $COMPOSER_FLAGS
+  - if [[ $PHPSTAN == 'true' ]]; then travis_retry composer require --dev phpstan/phpstan $COMPOSER_FLAGS ; else travis_retry composer update $COMPOSER_FLAGS ; fi
   - composer info -i
   - ./Tests/app/console doctrine:database:create
   - ./Tests/app/console doctrine:schema:update --force
 
 script:
   - ./vendor/bin/phpunit --coverage-clover=coverage.clover
+  - if [[ $PHPSTAN == 'true' ]]; then ./vendor/bin/phpstan analyse ./ --level 4 -c phpstan.neon ; fi
 
 after_script:
   - if [[ $CODE_COVERAGE == 'true' ]]; then wget https://scrutinizer-ci.com/ocular.phar ; fi

diff --git a/Controller/ConfirmationController.php b/Controller/ConfirmationController.php
@@ -12,6 +12,7 @@
 namespace Sulu\Bundle\CommunityBundle\Controller;
 
 use Sulu\Bundle\CommunityBundle\DependencyInjection\Configuration;
+use Sulu\Bundle\SecurityBundle\Entity\User;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
@@ -37,7 +38,9 @@ public function indexAction(Request $request, $token)
         $success = false;
 
         // Confirm user by token
-        if ($user = $communityManager->confirm($token)) {
+        $user = $communityManager->confirm($token);
+
+        if ($user instanceof User) {
             // Save User
             $this->saveEntities();
 

diff --git a/Controller/ProfileController.php b/Controller/ProfileController.php
@@ -93,13 +93,13 @@ public function indexAction(Request $request)
      * @param User $user
      * @param string $locale
      *
-     * @return Media
+     * @return Media|null
      */
     protected function saveAvatar(Form $form, User $user, $locale)
     {
         $uploadedFile = $form->get('contact')->get('avatar')->getData();
         if (null === $uploadedFile) {
-            return;
+            return null;
         }
 
         $systemCollectionManager = $this->get('sulu_media.system_collections.manager');

diff --git a/Entity/BlacklistItem.php b/Entity/BlacklistItem.php
@@ -30,17 +30,17 @@ class BlacklistItem
     private $id;
 
     /**
-     * @var string
+     * @var string|null
      */
     private $pattern;
 
     /**
-     * @var string
+     * @var string|null
      */
     private $regexp;
 
     /**
-     * @var string
+     * @var string|null
      */
     private $type;
 
@@ -70,7 +70,7 @@ public function getId()
     /**
      * Get pattern.
      *
-     * @return string
+     * @return string|null
      */
     public function getPattern()
     {
@@ -95,7 +95,7 @@ public function setPattern($pattern)
     /**
      * Get regexp.
      *
-     * @return string
+     * @return string|null
      */
     public function getRegexp()
     {
@@ -105,7 +105,7 @@ public function getRegexp()
     /**
      * Get type.
      *
-     * @return string
+     * @return string|null
      */
     public function getType()
     {

diff --git a/Entity/BlacklistUser.php b/Entity/BlacklistUser.php
@@ -28,7 +28,7 @@ class BlacklistUser
     private $id;
 
     /**
-     * @var string
+     * @var string|null
      */
     private $token;
 
@@ -74,7 +74,7 @@ public function getId()
     /**
      * Returns token.
      *
-     * @return string
+     * @return string|null
      */
     public function getToken()
     {

diff --git a/Entity/BlacklistUserRepository.php b/Entity/BlacklistUserRepository.php
@@ -22,16 +22,16 @@ class BlacklistUserRepository extends EntityRepository
      *
      * @param string $token
      *
-     * @return BlacklistUser
+     * @return BlacklistUser|null
      */
     public function findByToken($token)
     {
         try {
             return $this->findOneBy(['token' => $token]);
         } catch (NonUniqueResultException $e) {
-            return;
+            return null;
         } catch (NoResultException $e) {
-            return;
+            return null;
         }
     }
 }
diff --git a/Entity/EmailConfirmationTokenRepository.php b/Entity/EmailConfirmationTokenRepository.php
@@ -26,16 +26,16 @@ class EmailConfirmationTokenRepository extends EntityRepository
      *
      * @param string $token
      *
-     * @return EmailConfirmationToken
+     * @return EmailConfirmationToken|null
      */
     public function findByToken($token)
     {
         try {
             return $this->findOneBy(['token' => $token]);
         } catch (NonUniqueResultException $e) {
-            return;
+            return null;
         } catch (NoResultException $e) {
-            return;
+            return null;
         }
     }
 
@@ -44,16 +44,16 @@ public function findByToken($token)
      *
      * @param UserInterface $user
      *
-     * @return EmailConfirmationToken
+     * @return EmailConfirmationToken|null
      */
     public function findByUser($user)
     {
         try {
             return $this->findOneBy(['user' => $user]);
         } catch (NonUniqueResultException $e) {
-            return;
+            return null;
         } catch (NoResultException $e) {
-            return;
+            return null;
         }
     }
 }
diff --git a/EventListener/BlacklistListener.php b/EventListener/BlacklistListener.php
@@ -101,14 +101,14 @@ public function validateEmail(CommunityEvent $event)
      *
      * @param string $email
      *
-     * @return string
+     * @return string|null
      */
     private function getType($email)
     {
         $items = $this->blacklistItemRepository->findBySender($email);
 
         if (0 === count($items)) {
-            return;
+            return null;
         }
 
         foreach ($items as $item) {

diff --git a/EventListener/CompletionListener.php b/EventListener/CompletionListener.php
@@ -18,6 +18,7 @@
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 
 /**
  * Validates the current user entity.
@@ -93,6 +94,10 @@ public function onRequest(GetResponseEvent $event)
 
         $token = $this->tokenStorage->getToken();
 
+        if (!$token instanceof TokenInterface) {
+            return;
+        }
+
         /** @var User $user */
         $user = $token->getUser();
 
@@ -131,12 +136,12 @@ public function addValidator(CompletionInterface $validator, $webspaceKey)
     /**
      * @param string $webspaceKey
      *
-     * @return CompletionInterface
+     * @return CompletionInterface|null
      */
     protected function getValidator($webspaceKey)
     {
         if (!isset($this->validators[$webspaceKey])) {
-            return;
+            return null;
         }
 
         return $this->validators[$webspaceKey];

diff --git a/EventListener/EmailConfirmationListener.php b/EventListener/EmailConfirmationListener.php
@@ -18,6 +18,7 @@
 use Sulu\Bundle\CommunityBundle\Event\CommunityEvent;
 use Sulu\Bundle\CommunityBundle\Mail\Mail;
 use Sulu\Bundle\CommunityBundle\Mail\MailFactoryInterface;
+use Sulu\Bundle\SecurityBundle\Entity\User;
 use Sulu\Bundle\SecurityBundle\Util\TokenGeneratorInterface;
 
 /**
@@ -72,6 +73,11 @@ public function __construct(
     public function sendConfirmationOnEmailChange(CommunityEvent $event)
     {
         $user = $event->getUser();
+
+        if (!$user instanceof User) {
+            throw new \RuntimeException('Community bundle user need to be instance uf Sulu User');
+        }
+
         if ($user->getEmail() === $user->getContact()->getMainEmail()) {
             return;
         }

diff --git a/Manager/CommunityManager.php b/Manager/CommunityManager.php
@@ -161,7 +161,7 @@ public function completion(User $user)
     public function login(User $user, Request $request)
     {
         if (!$user->getEnabled()) {
-            return;
+            return null;
         }
 
         $token = new UsernamePasswordToken(
@@ -187,7 +187,7 @@ public function confirm($token)
         $user = $this->userManager->findByConfirmationKey($token);
 
         if (!$user) {
-            return;
+            return null;
         }
 
         // Remove Confirmation Key
@@ -209,7 +209,7 @@ public function passwordForget($emailUsername)
         $user = $this->userManager->findUser($emailUsername);
 
         if (!$user) {
-            return;
+            return null;
         }
 
         $user->setPasswordResetToken($this->userManager->getUniqueToken('passwordResetToken'));

diff --git a/Manager/CommunityManagerInterface.php b/Manager/CommunityManagerInterface.php
@@ -52,7 +52,7 @@ public function completion(User $user);
      * @param User $user
      * @param Request $request
      *
-     * @return UsernamePasswordToken
+     * @return UsernamePasswordToken|null
      */
     public function login(User $user, Request $request);
 
@@ -61,7 +61,7 @@ public function login(User $user, Request $request);
      *
      * @param string $token
      *
-     * @return User
+     * @return User|null
      */
     public function confirm($token);
 
@@ -70,14 +70,14 @@ public function confirm($token);
      *
      * @param string $emailUsername
      *
-     * @return User
+     * @return User|null
      */
     public function passwordForget($emailUsername);
 
     /**
      * Reset user password token.
      *
-     * @param User $user
+     * @param User $user|null
      *
      * @return User
      */
@@ -107,7 +107,7 @@ public function getConfigProperty($property);
      * @param string $type
      * @param string $property
      *
-     * @return string
+     * @return mixed
      *
      * @throws \Exception
      */