Improve idea completion

commit d89f441 Author: Monnot Stéphane <[email protected]> Date: Fri Aug 26 15:59:18 2016 +0200 Add empty line between namespace and use lines commit 9050a33 Author: Monnot Stéphane <[email protected]> Date: Fri Aug 26 15:52:37 2016 +0200 Fix "collection of " doc blocks commit 6089bb0 Author: Monnot Stéphane <[email protected]> Date: Fri Aug 26 15:32:12 2016 +0200 Add empty line between namespace and use lines commit 90556e3 Author: Monnot Stéphane <[email protected]> Date: Fri Aug 26 15:24:32 2016 +0200 Add some imports for doc block commit 342c31a Author: Monnot Stéphane <[email protected]> Date: Fri Aug 26 14:47:22 2016 +0200 Fix php docblock issues
FriendsOfSymfony · Aug 26, 2016 · 0592aa1 · 0592aa1
1 parent f824ef8
commit 0592aa1
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 31 deletions.
diff --git a/Document/Thread.php b/Document/Thread.php
@@ -57,7 +57,7 @@ abstract class Thread extends AbstractThread
     /**
      * Gets the users participating in this conversation
      *
-     * @return array of ParticipantInterface
+     * @return ParticipantInterface[]
      */
     public function getParticipants()
     {

diff --git a/DocumentManager/ThreadManager.php b/DocumentManager/ThreadManager.php
@@ -98,7 +98,7 @@ public function getParticipantInboxThreadsQueryBuilder(ParticipantInterface $par
      * In one word: an inbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantInboxThreads(ParticipantInterface $participant)
     {
@@ -132,7 +132,7 @@ public function getParticipantSentThreadsQueryBuilder(ParticipantInterface $part
      * In one word: an sentbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantSentThreads(ParticipantInterface $participant)
     {
@@ -192,7 +192,7 @@ public function getParticipantThreadsBySearchQueryBuilder(ParticipantInterface $
      *
      * @param ParticipantInterface $participant
      * @param string $search
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantThreadsBySearch(participantinterface $participant, $search)
     {
@@ -203,7 +203,7 @@ public function findParticipantThreadsBySearch(participantinterface $participant
      * Gets threads created by a participant
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findThreadsCreatedBy(ParticipantInterface $participant)
     {

diff --git a/Entity/Thread.php b/Entity/Thread.php
@@ -9,27 +9,28 @@
 use FOS\MessageBundle\Model\ParticipantInterface;
 
 use FOS\MessageBundle\Model\ThreadMetadata as ModelThreadMetadata;
+use FOS\MessageBundle\Model\ThreadMetadata;
 
 abstract class Thread extends BaseThread
 {
     /**
      * Messages contained in this thread
      *
-     * @var Collection of MessageInterface
+     * @var Collection|MessageInterface[]
      */
     protected $messages;
 
     /**
      * Users participating in this conversation
      *
-     * @var Collection of ParticipantInterface
+     * @var Collection|ParticipantInterface[]
      */
     protected $participants;
 
     /**
      * Thread metadata
      *
-     * @var Collection of ThreadMetadata
+     * @var Collection|ThreadMetadata[]
      */
     protected $metadata;
 
@@ -58,7 +59,7 @@ abstract class Thread extends BaseThread
     /**
      * Gets the users participating in this conversation
      *
-     * @return array of ParticipantInterface
+     * @return ParticipantInterface[]
      */
     public function getParticipants()
     {
@@ -71,7 +72,7 @@ public function getParticipants()
      * Since the ORM schema does not map the participants collection field, it
      * must be created on demand.
      *
-     * @return ArrayCollection
+     * @return ArrayCollection|ParticipantInterface[]
      */
     protected function getParticipantsCollection()
     {

diff --git a/EntityManager/ThreadManager.php b/EntityManager/ThreadManager.php
@@ -117,7 +117,7 @@ public function getParticipantInboxThreadsQueryBuilder(ParticipantInterface $par
      * In one word: an inbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantInboxThreads(ParticipantInterface $participant)
     {
@@ -168,7 +168,7 @@ public function getParticipantSentThreadsQueryBuilder(ParticipantInterface $part
      * In one word: an sentbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantSentThreads(ParticipantInterface $participant)
     {
@@ -235,7 +235,7 @@ public function getParticipantThreadsBySearchQueryBuilder(ParticipantInterface $
      *
      * @param ParticipantInterface $participant
      * @param string $search
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantThreadsBySearch(participantinterface $participant, $search)
     {
@@ -248,7 +248,7 @@ public function findParticipantThreadsBySearch(participantinterface $participant
      * Gets threads created by a participant
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findThreadsCreatedBy(ParticipantInterface $participant)
     {

diff --git a/Model/Message.php b/Model/Message.php
@@ -51,7 +51,7 @@ abstract class Message implements MessageInterface
     /**
      * Collection of MessageMetadata
      *
-     * @var Collection of MessageMetadata
+     * @var Collection|MessageMetadata[]
      */
     protected $metadata;
 

diff --git a/Model/Thread.php b/Model/Thread.php
@@ -37,21 +37,21 @@ abstract class Thread implements ThreadInterface
     /**
      * Messages contained in this thread
      *
-     * @var Collection of MessageInterface
+     * @var Collection|MessageInterface[]
      */
     protected $messages;
 
     /**
      * Thread metadata
      *
-     * @var Collection of ThreadMetadata
+     * @var Collection|ThreadMetadata[]
      */
     protected $metadata;
 
     /**
      * Users participating in this conversation
      *
-     * @var Collection of ParticipantInterface
+     * @var Collection|ParticipantInterface[]
      */
     protected $participants;
 

diff --git a/Model/ThreadInterface.php b/Model/ThreadInterface.php
@@ -80,14 +80,14 @@ function getCreatedAt();
      * Sets the date this thread was created at
      * Generally the date of the first message
      *
-     * @param DateTime
+     * @param \DateTime $createdAt
      */
     function setCreatedAt(\DateTime $createdAt);
 
     /**
      * Gets the users participating in this conversation
      *
-     * @return array of ParticipantInterface
+     * @return ParticipantInterface[]
      */
     function getParticipants();
 
@@ -133,7 +133,9 @@ function setIsDeleted($isDeleted);
     /**
      * Get the participants this participant is talking with.
      *
-     * @return array of ParticipantInterface
+     * @param ParticipantInterface $participant
+     *
+     * @return ParticipantInterface[]
      */
     function getOtherParticipants(ParticipantInterface $participant);
 }
diff --git a/ModelManager/ThreadManagerInterface.php b/ModelManager/ThreadManagerInterface.php
@@ -40,7 +40,7 @@ function getParticipantInboxThreadsQueryBuilder(ParticipantInterface $participan
      * In one word: an inbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function findParticipantInboxThreads(ParticipantInterface $participant);
 
@@ -62,7 +62,7 @@ function getParticipantSentThreadsQueryBuilder(ParticipantInterface $participant
      * In one word: an sentbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function findParticipantSentThreads(ParticipantInterface $participant);
 
@@ -102,15 +102,15 @@ function getParticipantThreadsBySearchQueryBuilder(ParticipantInterface $partici
      *
      * @param ParticipantInterface $participant
      * @param string $search
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function findParticipantThreadsBySearch(ParticipantInterface $participant, $search);
 
     /**
      * Gets threads created by a participant
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function findThreadsCreatedBy(ParticipantInterface $participant);
 

diff --git a/Provider/Provider.php b/Provider/Provider.php
@@ -2,6 +2,7 @@
 
 namespace FOS\MessageBundle\Provider;
 
+use FOS\MessageBundle\Model\ThreadInterface;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 use FOS\MessageBundle\ModelManager\ThreadManagerInterface;
@@ -64,7 +65,7 @@ public function __construct(ThreadManagerInterface $threadManager, MessageManage
     /**
      * Gets the thread in the inbox of the current user
      *
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function getInboxThreads()
     {
@@ -76,7 +77,7 @@ public function getInboxThreads()
     /**
      * Gets the thread in the sentbox of the current user
      *
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function getSentThreads()
     {

diff --git a/Provider/ProviderInterface.php b/Provider/ProviderInterface.php
@@ -2,6 +2,8 @@
 
 namespace FOS\MessageBundle\Provider;
 
+use FOS\MessageBundle\Model\ThreadInterface;
+
 /**
  * Provides threads for the current authenticated user
  *
@@ -12,14 +14,14 @@ interface ProviderInterface
     /**
      * Gets the thread in the inbox of the current user
      *
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function getInboxThreads();
 
     /**
      * Gets the thread in the sentbox of the current user
      *
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
      function getSentThreads();
 

diff --git a/Search/Finder.php b/Search/Finder.php
@@ -2,6 +2,7 @@
 
 namespace FOS\MessageBundle\Search;
 
+use FOS\MessageBundle\Model\ThreadInterface;
 use FOS\MessageBundle\ModelManager\ThreadManagerInterface;
 use FOS\MessageBundle\Security\ParticipantProviderInterface;
 
@@ -36,7 +37,7 @@ public function __construct(ParticipantProviderInterface $participantProvider, T
      * Finds threads of a participant, matching a given query
      *
      * @param Query $query
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function find(Query $query)
     {

diff --git a/Search/FinderInterface.php b/Search/FinderInterface.php
@@ -2,6 +2,8 @@
 
 namespace FOS\MessageBundle\Search;
 
+use FOS\MessageBundle\Model\ThreadInterface;
+
 /**
  * Finds threads of a participant, matching a given query
  *
@@ -13,7 +15,7 @@ interface FinderInterface
      * Finds threads of a participant, matching a given query
      *
      * @param Query $query
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function find(Query $query);