Miliooo / MilioooMessageBundle

Messaging/Manager/DeleteThreadManagerInterface.php

Doc Comments +1 added lines

@@ -24,6 +24,7 @@
      *
      * @param ThreadInterface $thread The thread we want to delete
      * @param boolean         $flush  Whether to flush, defaults to true
+     * @return void
      */
     public function deleteThread(ThreadInterface $thread, $flush = true);
 }

Messaging/Manager/DeleteThreadManagerSecureInterface.php

Doc Comments +1 added lines

@@ -28,6 +28,7 @@
      * @param ThreadInterface      $thread      The given thread
      *
      * @throws AccessDeniedException if not enough rights to delete the thread.
+     * @return void
      */
     public function deleteThread(ParticipantInterface $participant, ThreadInterface $thread);
 }

Messaging/Manager/NewMessageManagerInterface.php

Doc Comments +2 added lines

@@ -31,6 +31,7 @@ 
      * Saves a new thread to the storage engine.
      *
      * @param MessageInterface $message
+     * @return void
      */
     public function saveNewThread(MessageInterface $message);
 
@@ -38,6 +39,7 @@ 
      * Saves a new reply to the storage engine.
      *
      * @param MessageInterface $message
+     * @return void
      */
     public function saveNewReply(MessageInterface $message);
 }

Messaging/Model/MessageInterface.php

Doc Comments +5 added lines

@@ -38,6 +38,7 @@ 
      * Sets the creation time of the message
      *
      * @param \DateTime $createdAt The time the message was created
+     * @return void
      */
     public function setCreatedAt(\DateTime $createdAt);
 
@@ -52,6 +53,7 @@ 
      * Sets the body of the message
      *
      * @param string $body The body
+     * @return void
      */
     public function setBody($body);
 
@@ -59,6 +61,7 @@ 
      * Sets the sender of the message
      *
      * @param ParticipantInterface $sender The sender of the message
+     * @return void
      */
     public function setSender(ParticipantInterface $sender);
 
@@ -73,6 +76,7 @@ 
      * Adds message meta to the messageMeta collection
      *
      * @param MessageMetaInterface $messageMeta
+     * @return void
      */
     public function addMessageMeta(MessageMetaInterface $messageMeta);
 
@@ -96,6 +100,7 @@ 
      * Sets the thread this message belongs to
      *
      * @param ThreadInterface $thread The thread this message belongs to
+     * @return void
      */
     public function setThread(ThreadInterface $thread);
 

Messaging/Model/MessageMetaInterface.php

Doc Comments +4 added lines, -1 removed lines

@@ -41,6 +41,7 @@ 
      * Sets the participant to the message meta
      *
      * @param ParticipantInterface $participant The participant we add to the meta
+     * @return void
      */
     public function setParticipant(ParticipantInterface $participant);
 
@@ -55,6 +56,7 @@ 
      * Sets the read status of the message for the given participant.
      *
      * @param ReadStatus $readStatus
+     * @return void
      */
     public function setReadStatus(ReadStatus $readStatus);
 
@@ -69,6 +71,7 @@ 
      * Sets the message this message meta belongs to
      *
      * @param MessageInterface $message The message this meta belongs to
+     * @return void
      */
     public function setMessage(MessageInterface $message);
 
@@ -87,7 +90,7 @@ 
      * Since we update the read status before we display the messages to the user we need to check the previous read
      * status to see if a message is a new read or not
      *
-     * @return $boolean
+     * @return integer|null
      */
     public function getPreviousReadStatus();
 }

Messaging/Model/ThreadInterface.php

Doc Comments +7 added lines

@@ -31,6 +31,7 @@ 
      * Sets the subject of the thread.
      *
      * @param string $subject The subject of the thread
+     * @return void
      */
     public function setSubject($subject);
 
@@ -45,6 +46,7 @@ 
      * Sets the participant who created the thread.
      *
      * @param ParticipantInterface $participant The participant who created the thread
+     * @return void
      */
     public function setCreatedBy(ParticipantInterface $participant);
 
@@ -59,11 +61,13 @@ 
      * Sets the datetime when the thread was created
      *
      * @param \DateTime $createdAt The creation datetime of the thread
+     * @return void
      */
     public function setCreatedAt(\DateTime $createdAt);
 
     /**
      * Gets the datetime when the thread was created.
+     * @return \DateTime
      */
     public function getCreatedAt();
 
@@ -71,6 +75,7 @@ 
      * Adds a message to the thread
      *
      * @param MessageInterface $message
+     * @return void
      */
     public function addMessage(MessageInterface $message);
 
@@ -105,6 +110,7 @@ 
      * you can use $this->messages->last();
      *
      * @param MessageInterface $message
+     * @return void
      */
     public function setLastMessage(MessageInterface $message);
 
@@ -112,6 +118,7 @@ 
      * Adds thread meta to the thread meta collection
      *
      * @param ThreadMetaInterface $threadMeta
+     * @return void
      */
     public function addThreadMeta(ThreadMetaInterface $threadMeta);
 

Messaging/Model/ThreadMetaInterface.php

Doc Comments +6 added lines

@@ -40,6 +40,7 @@ 
      * Sets the participant of the thread meta
      *
      * @param ParticipantInterface $participant The participant
+     * @return void
      */
     public function setParticipant(ParticipantInterface $participant);
 
@@ -47,6 +48,7 @@ 
      * Sets the thread for this thread meta
      *
      * @param ThreadInterface $thread The thread this meta belongs to
+     * @return void
      */
     public function setThread(ThreadInterface $thread);
 
@@ -68,6 +70,7 @@ 
      * Sets the status of the thread for the given participant.
      *
      * @param integer $status
+     * @return void
      */
     public function setStatus($status);
 
@@ -83,6 +86,7 @@ 
      * Sets the datetime when the participant has written his last message for the given thread
      *
      * @param \DateTime $dateTime DateTime of participant's last message
+     * @return void
      */
     public function setLastParticipantMessageDate(\DateTime $dateTime);
 
@@ -97,6 +101,7 @@ 
      * Sets the date of the last message written by another participant
      *
      * @param \DateTime $lastMessageDate datetime of the last message by another participant
+     * @return void
      */
     public function setLastMessageDate(\DateTime $lastMessageDate);
 
@@ -111,6 +116,7 @@ 
      * Sets the number of unread messages for the participant from the given thread.
      *
      * @param integer $unreadCount The number of unread messages from the thread for the given participant
+     * @return void
      */
     public function setUnreadMessageCount($unreadCount);
 }

Messaging/Repository/MessageRepositoryInterface.php

Doc Comments +2 added lines

@@ -33,6 +33,7 @@ 
      *
      * @param MessageInterface $message The message we save
      * @param bool $flush Whether to flush or not defaults to true
+     * @return void
      */
     public function save(MessageInterface $message, $flush = true);
 
@@ -41,6 +42,7 @@ 
      *
      * If you want to persist multiple objects but only flush once you can call this method.
      * This calls flush to the entity manager and all persisted objects will be saved.
+     * @return void
      */
     public function flush();
 }

Messaging/Repository/ThreadRepositoryInterface.php

Doc Comments +4 added lines, -1 removed lines

@@ -92,7 +92,7 @@ 
      * threads if they are not participants, eg an admin) Then this query should still work since we use a left join
      * on the metas.
      *
-     * @param $id
+     * @param integer $id
      * @param ParticipantInterface $participant
      *
      * @return ThreadInterface|null
@@ -104,6 +104,7 @@ 
      *
      * @param ThreadInterface $thread The thread we save
      * @param boolean $flush Whether to flush or not, defaults to true
+     * @return void
      */
     public function save(ThreadInterface $thread, $flush = true);
 
@@ -121,6 +122,7 @@ 
      *
      * If you want to persist multiple objects but only flush once you can call this method.
      * This calls flush to the entity manager and all persisted objects will be saved.
+     * @return void
      */
     public function flush();
 
@@ -129,6 +131,7 @@ 
      *
      * @param ThreadInterface $thread The thread we want to delete
      * @param boolean         $flush  Whether to flush or not, defaults to true
+     * @return void
      */
     public function delete(ThreadInterface $thread, $flush = true);
 }