Merge pull request #285 from stephane-monnot/feature/fixdocblockissues

tgalopin · web-flow · commit cdb93fec8403 · 2016-08-26T15:03:38.000+02:00
Fix php docblock issues
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
@@ -58,7 +58,7 @@ abstract class Thread extends BaseThread
     /**
      * Gets the users participating in this conversation
      *
-     * @return array of ParticipantInterface
+     * @return ParticipantInterface[]
      */
     public function getParticipants()
     {
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/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
@@ -64,7 +64,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 +76,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
@@ -12,14 +12,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
@@ -36,7 +36,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
@@ -13,7 +13,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);
 

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ abstract class Thread extends AbstractThread`
`57`	`57`	`/**`
`58`	`58`	`* Gets the users participating in this conversation`
`59`	`59`	`*`
`60`		`- * @return array of ParticipantInterface`
	`60`	`+ * @return ParticipantInterface[]`
`61`	`61`	`*/`
`62`	`62`	`public function getParticipants()`
`63`	`63`	`{`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ public function getParticipantInboxThreadsQueryBuilder(ParticipantInterface $par`
`98`	`98`	`* In one word: an inbox.`
`99`	`99`	`*`
`100`	`100`	`* @param ParticipantInterface $participant`
`101`		`- * @return array of ThreadInterface`
	`101`	`+ * @return ThreadInterface[]`
`102`	`102`	`*/`
`103`	`103`	`public function findParticipantInboxThreads(ParticipantInterface $participant)`
`104`	`104`	`{`
`@@ -132,7 +132,7 @@ public function getParticipantSentThreadsQueryBuilder(ParticipantInterface $part`
`132`	`132`	`* In one word: an sentbox.`
`133`	`133`	`*`
`134`	`134`	`* @param ParticipantInterface $participant`
`135`		`- * @return array of ThreadInterface`
	`135`	`+ * @return ThreadInterface[]`
`136`	`136`	`*/`
`137`	`137`	`public function findParticipantSentThreads(ParticipantInterface $participant)`
`138`	`138`	`{`
`@@ -192,7 +192,7 @@ public function getParticipantThreadsBySearchQueryBuilder(ParticipantInterface $`
`192`	`192`	`*`
`193`	`193`	`* @param ParticipantInterface $participant`
`194`	`194`	`* @param string $search`
`195`		`- * @return array of ThreadInterface`
	`195`	`+ * @return ThreadInterface[]`
`196`	`196`	`*/`
`197`	`197`	`public function findParticipantThreadsBySearch(participantinterface $participant, $search)`
`198`	`198`	`{`
`@@ -203,7 +203,7 @@ public function findParticipantThreadsBySearch(participantinterface $participant`
`203`	`203`	`* Gets threads created by a participant`
`204`	`204`	`*`
`205`	`205`	`* @param ParticipantInterface $participant`
`206`		`- * @return array of ThreadInterface`
	`206`	`+ * @return ThreadInterface[]`
`207`	`207`	`*/`
`208`	`208`	`public function findThreadsCreatedBy(ParticipantInterface $participant)`
`209`	`209`	`{`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ abstract class Thread extends BaseThread`
`58`	`58`	`/**`
`59`	`59`	`* Gets the users participating in this conversation`
`60`	`60`	`*`
`61`		`- * @return array of ParticipantInterface`
	`61`	`+ * @return ParticipantInterface[]`
`62`	`62`	`*/`
`63`	`63`	`public function getParticipants()`
`64`	`64`	`{`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ public function getParticipantInboxThreadsQueryBuilder(ParticipantInterface $par`
`117`	`117`	`* In one word: an inbox.`
`118`	`118`	`*`
`119`	`119`	`* @param ParticipantInterface $participant`
`120`		`- * @return array of ThreadInterface`
	`120`	`+ * @return ThreadInterface[]`
`121`	`121`	`*/`
`122`	`122`	`public function findParticipantInboxThreads(ParticipantInterface $participant)`
`123`	`123`	`{`
`@@ -168,7 +168,7 @@ public function getParticipantSentThreadsQueryBuilder(ParticipantInterface $part`
`168`	`168`	`* In one word: an sentbox.`
`169`	`169`	`*`
`170`	`170`	`* @param ParticipantInterface $participant`
`171`		`- * @return array of ThreadInterface`
	`171`	`+ * @return ThreadInterface[]`
`172`	`172`	`*/`
`173`	`173`	`public function findParticipantSentThreads(ParticipantInterface $participant)`
`174`	`174`	`{`
`@@ -235,7 +235,7 @@ public function getParticipantThreadsBySearchQueryBuilder(ParticipantInterface $`
`235`	`235`	`*`
`236`	`236`	`* @param ParticipantInterface $participant`
`237`	`237`	`* @param string $search`
`238`		`- * @return array of ThreadInterface`
	`238`	`+ * @return ThreadInterface[]`
`239`	`239`	`*/`
`240`	`240`	`public function findParticipantThreadsBySearch(participantinterface $participant, $search)`
`241`	`241`	`{`
`@@ -248,7 +248,7 @@ public function findParticipantThreadsBySearch(participantinterface $participant`
`248`	`248`	`* Gets threads created by a participant`
`249`	`249`	`*`
`250`	`250`	`* @param ParticipantInterface $participant`
`251`		`- * @return array of ThreadInterface`
	`251`	`+ * @return ThreadInterface[]`
`252`	`252`	`*/`
`253`	`253`	`public function findThreadsCreatedBy(ParticipantInterface $participant)`
`254`	`254`	`{`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function __construct(ThreadManagerInterface $threadManager, MessageManage`
`64`	`64`	`/**`
`65`	`65`	`* Gets the thread in the inbox of the current user`
`66`	`66`	`*`
`67`		`- * @return array of ThreadInterface`
	`67`	`+ * @return ThreadInterface[]`
`68`	`68`	`*/`
`69`	`69`	`public function getInboxThreads()`
`70`	`70`	`{`
`@@ -76,7 +76,7 @@ public function getInboxThreads()`
`76`	`76`	`/**`
`77`	`77`	`* Gets the thread in the sentbox of the current user`
`78`	`78`	`*`
`79`		`- * @return array of ThreadInterface`
	`79`	`+ * @return ThreadInterface[]`
`80`	`80`	`*/`
`81`	`81`	`public function getSentThreads()`
`82`	`82`	`{`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function __construct(ParticipantProviderInterface $participantProvider, T`
`36`	`36`	`* Finds threads of a participant, matching a given query`
`37`	`37`	`*`
`38`	`38`	`* @param Query $query`
`39`		`- * @return array of ThreadInterface`
	`39`	`+ * @return ThreadInterface[]`
`40`	`40`	`*/`
`41`	`41`	`public function find(Query $query)`
`42`	`42`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ interface FinderInterface`
`13`	`13`	`* Finds threads of a participant, matching a given query`
`14`	`14`	`*`
`15`	`15`	`* @param Query $query`
`16`		`- * @return array of ThreadInterface`
	`16`	`+ * @return ThreadInterface[]`
`17`	`17`	`*/`
`18`	`18`	`function find(Query $query);`
`19`	`19`