Merge pull request #288 from FriendsOfSymfony/fix-287

Fix #287 and improve CS/readability of various parts of the code

Author: tgalopin

Command/MongoDBMigrateMetadataCommand.php

@@ -3,6 +3,8 @@
 namespace FOS\MessageBundle\Command;
 
 use Doctrine\Common\Persistence\ManagerRegistry;
+use FOS\MessageBundle\Document\Message;
+use FOS\MessageBundle\Document\Thread;
 use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -37,7 +39,7 @@ class MongoDBMigrateMetadataCommand extends ContainerAwareCommand
     private $printStatusCallback;
 
     /**
-     * @see Symfony\Component\Console\Command\Command::isEnabled()
+     * {@inheritdoc}
      */
     public function isEnabled()
     {
@@ -49,7 +51,7 @@ public function isEnabled()
     }
 
     /**
-     * @see Symfony\Component\Console\Command\Command::configure()
+     * {@inheritdoc}
      */
     protected function configure()
     {
@@ -92,7 +94,7 @@ protected function configure()
     }
 
     /**
-     * @see Symfony\Bundle\FrameworkBundle\Command\Command::initialize()
+     * {@inheritdoc}
      */
     protected function initialize(InputInterface $input, OutputInterface $output)
     {
@@ -113,7 +115,7 @@ protected function initialize(InputInterface $input, OutputInterface $output)
     }
 
     /**
-     * @see Symfony\Component\Console\Command\Command::execute()
+     * {@inheritdoc}
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
@@ -122,13 +124,11 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $size = memory_get_peak_usage(true);
         $unit = array('b', 'k', 'm', 'g', 't', 'p');
-        $output->writeln(sprintf("Peak Memory Usage: <comment>%s</comment>", round($size / pow(1024, ($i = floor(log($size, 1024)))), 2).$unit[$i]));
+        $output->writeln(sprintf('Peak Memory Usage: <comment>%s</comment>', round($size / pow(1024, $i = floor(log($size, 1024))), 2).$unit[$i]));
     }
 
     /**
      * Migrate message documents
-     *
-     * @param OutputInterface $output
      */
     private function migrateMessages(OutputInterface $output)
     {
@@ -175,8 +175,6 @@ private function migrateMessages(OutputInterface $output)
 
     /**
      * Migrate thread documents
-     *
-     * @param OutputInterface $output
      */
     private function migrateThreads(OutputInterface $output)
     {
@@ -233,8 +231,6 @@ private function migrateThreads(OutputInterface $output)
      *
      * By default, Mongo will not include "$db" when creating the participant
      * reference. We'll add that manually to be consistent with Doctrine.
-     *
-     * @param array &$message
      */
     private function createMessageMetadata(array &$message)
     {
@@ -253,7 +249,7 @@ private function createMessageMetadata(array &$message)
     /**
      * Sets the unreadForParticipants array on the message.
      *
-     * @see FOS\MessageBundle\Document\Message::doEnsureUnreadForParticipantsArray()
+     * @see Message::doEnsureUnreadForParticipantsArray()
      * @param array &$message
      */
     private function createMessageUnreadForParticipants(array &$message)
@@ -331,7 +327,7 @@ private function createThreadLastMessageDate(array &$thread)
     /**
      * Sets the active participant arrays on the thread.
      *
-     * @see FOS\MessageBundle\Document\Thread::doEnsureActiveParticipantArrays()
+     * @see Thread::doEnsureActiveParticipantArrays()
      * @param array $thread
      */
     private function createThreadActiveParticipantArrays(array &$thread)
@@ -342,7 +338,7 @@ private function createThreadActiveParticipantArrays(array &$thread)
 
         foreach ($thread['participants'] as $participantRef) {
             foreach ($thread['metadata'] as $metadata) {
-                if ($participantRef['$id'] == $metadata['participant']['$id'] && $metadata['isDeleted']) {
+                if ($metadata['isDeleted'] && $participantRef['$id'] === $metadata['participant']['$id']) {
                     continue 2;
                 }
             }

Composer/ComposerInterface.php

@@ -2,6 +2,7 @@
 
 namespace FOS\MessageBundle\Composer;
 
+use FOS\MessageBundle\MessageBuilder\AbstractMessageBuilder;
 use FOS\MessageBundle\Model\ThreadInterface;
 
 /**
@@ -14,14 +15,14 @@ interface ComposerInterface
     /**
      * Starts composing a message, starting a new thread
      *
-     * @return MessageBuilderInterface
+     * @return AbstractMessageBuilder
      */
-    function newThread();
+    public function newThread();
 
     /**
      * Starts composing a message in a reply to a thread
      *
-     * @return MessageBuilderInterface
+     * @return AbstractMessageBuilder
      */
-    function reply(ThreadInterface $thread);
+    public function reply(ThreadInterface $thread);
 }

Controller/MessageController.php

@@ -2,10 +2,10 @@
 
 namespace FOS\MessageBundle\Controller;
 
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\DependencyInjection\ContainerAware;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use FOS\MessageBundle\Provider\ProviderInterface;
+use Symfony\Component\HttpFoundation\Response;
 
 class MessageController extends ContainerAware
 {

DataTransformer/RecipientsDataTransformer.php

@@ -5,7 +5,6 @@
 use Symfony\Component\Form\Exception\TransformationFailedException;
 use Symfony\Component\Form\Exception\UnexpectedTypeException;
 use Symfony\Component\Security\Core\User\UserInterface;
-use Doctrine\Common\Persistence\ObjectManager;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\Common\Collections\ArrayCollection;
 /**
@@ -20,9 +19,6 @@ class RecipientsDataTransformer implements DataTransformerInterface
      */
     private $userToUsernameTransformer;
 
-    /**
-     * @param DataTransformerInterface $userToUsernameTransformer
-     */
     public function __construct(DataTransformerInterface $userToUsernameTransformer)
     {
         $this->userToUsernameTransformer = $userToUsernameTransformer;
@@ -37,8 +33,8 @@ public function __construct(DataTransformerInterface $userToUsernameTransformer)
      */
     public function transform($recipients)
     {
-        if ($recipients === null || $recipients->count() == 0) {
-            return "";
+        if ($recipients === null || $recipients->count() === 0) {
+            return '';
         }
 
         $usernames = array();
@@ -84,4 +80,4 @@ public function reverseTransform($usernames)
 
         return $recipients;
     }
-}
+}

Deleter/Deleter.php

@@ -2,6 +2,7 @@
 
 namespace FOS\MessageBundle\Deleter;
 
+use FOS\MessageBundle\Model\ParticipantInterface;
 use FOS\MessageBundle\Security\AuthorizerInterface;
 use FOS\MessageBundle\Model\ThreadInterface;
 use FOS\MessageBundle\Security\ParticipantProviderInterface;
@@ -46,9 +47,7 @@ public function __construct(AuthorizerInterface $authorizer, ParticipantProvider
     }
 
     /**
-     * Marks the thread as deleted by the current authenticated user
-     *
-     * @param ThreadInterface $thread
+     * {@inheritdoc}
      */
     public function markAsDeleted(ThreadInterface $thread)
     {
@@ -61,9 +60,7 @@ public function markAsDeleted(ThreadInterface $thread)
     }
 
     /**
-     * Marks the thread as undeleted by the current authenticated user
-     *
-     * @param ThreadInterface $thread
+     * {@inheritdoc}
      */
     public function markAsUndeleted(ThreadInterface $thread)
     {

Deleter/DeleterInterface.php

@@ -13,15 +13,11 @@ interface DeleterInterface
 {
     /**
      * Marks the thread as deleted by the current authenticated user
-     *
-     * @param ThreadInterface $thread
      */
-    function markAsDeleted(ThreadInterface $thread);
+    public function markAsDeleted(ThreadInterface $thread);
 
     /**
      * Marks the thread as undeleted by the current authenticated user
-     *
-     * @param ThreadInterface $thread
      */
-    function markAsUndeleted(ThreadInterface $thread);
+    public function markAsUndeleted(ThreadInterface $thread);
 }

DependencyInjection/Configuration.php

@@ -3,7 +3,6 @@
 namespace FOS\MessageBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
-use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 /**

Document/Message.php

@@ -23,15 +23,14 @@ abstract class Message extends BaseMessage
     protected $unreadForParticipants = array();
 
     /**
-     * @param  boolean
-     * @return null
+     * @param boolean $isSpam
      */
     public function setIsSpam($isSpam)
     {
         $this->isSpam = (boolean) $isSpam;
     }
 
-    /**
+    /*
      * DENORMALIZATION
      *
      * All following methods are relative to denormalization

Document/Thread.php

@@ -3,9 +3,6 @@
 namespace FOS\MessageBundle\Document;
 
 use FOS\MessageBundle\Model\Thread as AbstractThread;
-use FOS\MessageBundle\Model\MessageInterface;
-use Doctrine\Common\Collections\Collection;
-use Doctrine\Common\Collections\ArrayCollection;
 use FOS\MessageBundle\Model\ParticipantInterface;
 
 abstract class Thread extends AbstractThread
@@ -16,7 +13,7 @@ abstract class Thread extends AbstractThread
      * This denormalization field is used for sorting threads in the inbox and
      * sent list.
      *
-     * @var DateTime
+     * @var \DateTime
      */
     protected $lastMessageDate;
 
@@ -69,7 +66,7 @@ public function getParticipants()
      * If it already exists, nothing is done.
      *
      * @param ParticipantInterface $participant
-     * @return null
+     * @return void
      */
     public function addParticipant(ParticipantInterface $participant)
     {
@@ -89,7 +86,7 @@ public function isParticipant(ParticipantInterface $participant)
         return $this->participants->contains($participant);
     }
 
-    /**
+    /*
      * DENORMALIZATION
      *
      * All following methods are relative to denormalization

DocumentManager/MessageManager.php

@@ -4,6 +4,7 @@
 
 use Doctrine\ODM\MongoDB\DocumentManager;
 use FOS\MessageBundle\Document\Message;
+use FOS\MessageBundle\Document\MessageMetadata;
 use FOS\MessageBundle\Model\MessageInterface;
 use FOS\MessageBundle\ModelManager\MessageManager as BaseMessageManager;
 use FOS\MessageBundle\Model\ReadableInterface;
@@ -39,8 +40,6 @@ class MessageManager extends BaseMessageManager
     protected $metaClass;
 
     /**
-     * Constructor.
-     *
      * @param DocumentManager $dm
      * @param string          $class
      * @param string          $metaClass
@@ -54,10 +53,7 @@ public function __construct(DocumentManager $dm, $class, $metaClass)
     }
 
     /**
-     * Tells how many unread, non-spam, messages this participant has
-     *
-     * @param ParticipantInterface $participant
-     * @return int the number of unread messages
+     * {@inheritDoc}
      */
     public function getNbUnreadMessageByParticipant(ParticipantInterface $participant)
     {
@@ -68,29 +64,19 @@ public function getNbUnreadMessageByParticipant(ParticipantInterface $participan
     }
 
     /**
-     * Marks the readable as read by this participant
-     * Must be applied directly to the storage,
-     * without modifying the readable state.
-     * We want to show the unread readables on the page,
-     * as well as marking the as read.
-     *
-     * @param ReadableInterface $readable
-     * @param ParticipantInterface $participant
+     * {@inheritDoc}
      */
     public function markAsReadByParticipant(ReadableInterface $readable, ParticipantInterface $participant)
     {
-        return $this->markIsReadByParticipant($readable, $participant, true);
+        $this->markIsReadByParticipant($readable, $participant, true);
     }
 
     /**
-     * Marks the readable as unread by this participant
-     *
-     * @param ReadableInterface $readable
-     * @param ParticipantInterface $participant
+     * {@inheritDoc}
      */
     public function markAsUnreadByParticipant(ReadableInterface $readable, ParticipantInterface $participant)
     {
-        return $this->markIsReadByParticipant($readable, $participant, false);
+        $this->markIsReadByParticipant($readable, $participant, false);
     }
 
     /**
@@ -167,10 +153,7 @@ protected function markIsReadByCondition(ParticipantInterface $participant, $isR
     }
 
     /**
-     * Saves a message
-     *
-     * @param MessageInterface $message
-     * @param Boolean $andFlush Whether to flush the changes (default true)
+     * {@inheritDoc}
      */
     public function saveMessage(MessageInterface $message, $andFlush = true)
     {
@@ -182,9 +165,7 @@ public function saveMessage(MessageInterface $message, $andFlush = true)
     }
 
     /**
-     * Returns the fully qualified comment thread class name
-     *
-     * @return string
+     * {@inheritDoc}
      */
     public function getClass()
     {
@@ -201,7 +182,7 @@ protected function createMessageMetadata()
         return new $this->metaClass();
     }
 
-    /**
+    /*
      * DENORMALIZATION
      *
      * All following methods are relative to denormalization