@@ -24,6 +24,7 @@ |
||
| 24 | 24 | * |
| 25 | 25 | * @param ThreadInterface $thread The thread we want to delete |
| 26 | 26 | * @param boolean $flush Whether to flush, defaults to true |
| 27 | + * @return void |
|
| 27 | 28 | */ |
| 28 | 29 | public function deleteThread(ThreadInterface $thread, $flush = true); |
| 29 | 30 | } |
@@ -28,6 +28,7 @@ |
||
| 28 | 28 | * @param ThreadInterface $thread The given thread |
| 29 | 29 | * |
| 30 | 30 | * @throws AccessDeniedException if not enough rights to delete the thread. |
| 31 | + * @return void |
|
| 31 | 32 | */ |
| 32 | 33 | public function deleteThread(ParticipantInterface $participant, ThreadInterface $thread); |
| 33 | 34 | } |
@@ -31,6 +31,7 @@ discard block |
||
| 31 | 31 | * Saves a new thread to the storage engine. |
| 32 | 32 | * |
| 33 | 33 | * @param MessageInterface $message |
| 34 | + * @return void |
|
| 34 | 35 | */ |
| 35 | 36 | public function saveNewThread(MessageInterface $message); |
| 36 | 37 | |
@@ -38,6 +39,7 @@ discard block |
||
| 38 | 39 | * Saves a new reply to the storage engine. |
| 39 | 40 | * |
| 40 | 41 | * @param MessageInterface $message |
| 42 | + * @return void |
|
| 41 | 43 | */ |
| 42 | 44 | public function saveNewReply(MessageInterface $message); |
| 43 | 45 | } |
@@ -38,6 +38,7 @@ discard block |
||
| 38 | 38 | * Sets the creation time of the message |
| 39 | 39 | * |
| 40 | 40 | * @param \DateTime $createdAt The time the message was created |
| 41 | + * @return void |
|
| 41 | 42 | */ |
| 42 | 43 | public function setCreatedAt(\DateTime $createdAt); |
| 43 | 44 | |
@@ -52,6 +53,7 @@ discard block |
||
| 52 | 53 | * Sets the body of the message |
| 53 | 54 | * |
| 54 | 55 | * @param string $body The body |
| 56 | + * @return void |
|
| 55 | 57 | */ |
| 56 | 58 | public function setBody($body); |
| 57 | 59 | |
@@ -59,6 +61,7 @@ discard block |
||
| 59 | 61 | * Sets the sender of the message |
| 60 | 62 | * |
| 61 | 63 | * @param ParticipantInterface $sender The sender of the message |
| 64 | + * @return void |
|
| 62 | 65 | */ |
| 63 | 66 | public function setSender(ParticipantInterface $sender); |
| 64 | 67 | |
@@ -73,6 +76,7 @@ discard block |
||
| 73 | 76 | * Adds message meta to the messageMeta collection |
| 74 | 77 | * |
| 75 | 78 | * @param MessageMetaInterface $messageMeta |
| 79 | + * @return void |
|
| 76 | 80 | */ |
| 77 | 81 | public function addMessageMeta(MessageMetaInterface $messageMeta); |
| 78 | 82 | |
@@ -96,6 +100,7 @@ discard block |
||
| 96 | 100 | * Sets the thread this message belongs to |
| 97 | 101 | * |
| 98 | 102 | * @param ThreadInterface $thread The thread this message belongs to |
| 103 | + * @return void |
|
| 99 | 104 | */ |
| 100 | 105 | public function setThread(ThreadInterface $thread); |
| 101 | 106 | |
@@ -41,6 +41,7 @@ discard block |
||
| 41 | 41 | * Sets the participant to the message meta |
| 42 | 42 | * |
| 43 | 43 | * @param ParticipantInterface $participant The participant we add to the meta |
| 44 | + * @return void |
|
| 44 | 45 | */ |
| 45 | 46 | public function setParticipant(ParticipantInterface $participant); |
| 46 | 47 | |
@@ -55,6 +56,7 @@ discard block |
||
| 55 | 56 | * Sets the read status of the message for the given participant. |
| 56 | 57 | * |
| 57 | 58 | * @param ReadStatus $readStatus |
| 59 | + * @return void |
|
| 58 | 60 | */ |
| 59 | 61 | public function setReadStatus(ReadStatus $readStatus); |
| 60 | 62 | |
@@ -69,6 +71,7 @@ discard block |
||
| 69 | 71 | * Sets the message this message meta belongs to |
| 70 | 72 | * |
| 71 | 73 | * @param MessageInterface $message The message this meta belongs to |
| 74 | + * @return void |
|
| 72 | 75 | */ |
| 73 | 76 | public function setMessage(MessageInterface $message); |
| 74 | 77 | |
@@ -87,7 +90,7 @@ discard block |
||
| 87 | 90 | * Since we update the read status before we display the messages to the user we need to check the previous read |
| 88 | 91 | * status to see if a message is a new read or not |
| 89 | 92 | * |
| 90 | - * @return $boolean |
|
| 93 | + * @return integer|null |
|
| 91 | 94 | */ |
| 92 | 95 | public function getPreviousReadStatus(); |
| 93 | 96 | } |
@@ -31,6 +31,7 @@ discard block |
||
| 31 | 31 | * Sets the subject of the thread. |
| 32 | 32 | * |
| 33 | 33 | * @param string $subject The subject of the thread |
| 34 | + * @return void |
|
| 34 | 35 | */ |
| 35 | 36 | public function setSubject($subject); |
| 36 | 37 | |
@@ -45,6 +46,7 @@ discard block |
||
| 45 | 46 | * Sets the participant who created the thread. |
| 46 | 47 | * |
| 47 | 48 | * @param ParticipantInterface $participant The participant who created the thread |
| 49 | + * @return void |
|
| 48 | 50 | */ |
| 49 | 51 | public function setCreatedBy(ParticipantInterface $participant); |
| 50 | 52 | |
@@ -59,11 +61,13 @@ discard block |
||
| 59 | 61 | * Sets the datetime when the thread was created |
| 60 | 62 | * |
| 61 | 63 | * @param \DateTime $createdAt The creation datetime of the thread |
| 64 | + * @return void |
|
| 62 | 65 | */ |
| 63 | 66 | public function setCreatedAt(\DateTime $createdAt); |
| 64 | 67 | |
| 65 | 68 | /** |
| 66 | 69 | * Gets the datetime when the thread was created. |
| 70 | + * @return \DateTime |
|
| 67 | 71 | */ |
| 68 | 72 | public function getCreatedAt(); |
| 69 | 73 | |
@@ -71,6 +75,7 @@ discard block |
||
| 71 | 75 | * Adds a message to the thread |
| 72 | 76 | * |
| 73 | 77 | * @param MessageInterface $message |
| 78 | + * @return void |
|
| 74 | 79 | */ |
| 75 | 80 | public function addMessage(MessageInterface $message); |
| 76 | 81 | |
@@ -105,6 +110,7 @@ discard block |
||
| 105 | 110 | * you can use $this->messages->last(); |
| 106 | 111 | * |
| 107 | 112 | * @param MessageInterface $message |
| 113 | + * @return void |
|
| 108 | 114 | */ |
| 109 | 115 | public function setLastMessage(MessageInterface $message); |
| 110 | 116 | |
@@ -112,6 +118,7 @@ discard block |
||
| 112 | 118 | * Adds thread meta to the thread meta collection |
| 113 | 119 | * |
| 114 | 120 | * @param ThreadMetaInterface $threadMeta |
| 121 | + * @return void |
|
| 115 | 122 | */ |
| 116 | 123 | public function addThreadMeta(ThreadMetaInterface $threadMeta); |
| 117 | 124 | |
@@ -79,7 +79,7 @@ |
||
| 79 | 79 | /** |
| 80 | 80 | * Gets the unique id |
| 81 | 81 | * |
| 82 | - * @return integer|null |
|
| 82 | + * @return integer |
|
| 83 | 83 | */ |
| 84 | 84 | public function getId() |
| 85 | 85 | { |
@@ -40,6 +40,7 @@ discard block |
||
| 40 | 40 | * Sets the participant of the thread meta |
| 41 | 41 | * |
| 42 | 42 | * @param ParticipantInterface $participant The participant |
| 43 | + * @return void |
|
| 43 | 44 | */ |
| 44 | 45 | public function setParticipant(ParticipantInterface $participant); |
| 45 | 46 | |
@@ -47,6 +48,7 @@ discard block |
||
| 47 | 48 | * Sets the thread for this thread meta |
| 48 | 49 | * |
| 49 | 50 | * @param ThreadInterface $thread The thread this meta belongs to |
| 51 | + * @return void |
|
| 50 | 52 | */ |
| 51 | 53 | public function setThread(ThreadInterface $thread); |
| 52 | 54 | |
@@ -68,6 +70,7 @@ discard block |
||
| 68 | 70 | * Sets the status of the thread for the given participant. |
| 69 | 71 | * |
| 70 | 72 | * @param integer $status |
| 73 | + * @return void |
|
| 71 | 74 | */ |
| 72 | 75 | public function setStatus($status); |
| 73 | 76 | |
@@ -83,6 +86,7 @@ discard block |
||
| 83 | 86 | * Sets the datetime when the participant has written his last message for the given thread |
| 84 | 87 | * |
| 85 | 88 | * @param \DateTime $dateTime DateTime of participant's last message |
| 89 | + * @return void |
|
| 86 | 90 | */ |
| 87 | 91 | public function setLastParticipantMessageDate(\DateTime $dateTime); |
| 88 | 92 | |
@@ -97,6 +101,7 @@ discard block |
||
| 97 | 101 | * Sets the date of the last message written by another participant |
| 98 | 102 | * |
| 99 | 103 | * @param \DateTime $lastMessageDate datetime of the last message by another participant |
| 104 | + * @return void |
|
| 100 | 105 | */ |
| 101 | 106 | public function setLastMessageDate(\DateTime $lastMessageDate); |
| 102 | 107 | |
@@ -111,6 +116,7 @@ discard block |
||
| 111 | 116 | * Sets the number of unread messages for the participant from the given thread. |
| 112 | 117 | * |
| 113 | 118 | * @param integer $unreadCount The number of unread messages from the thread for the given participant |
| 119 | + * @return void |
|
| 114 | 120 | */ |
| 115 | 121 | public function setUnreadMessageCount($unreadCount); |
| 116 | 122 | } |
@@ -33,6 +33,7 @@ discard block |
||
| 33 | 33 | * |
| 34 | 34 | * @param MessageInterface $message The message we save |
| 35 | 35 | * @param bool $flush Whether to flush or not defaults to true |
| 36 | + * @return void |
|
| 36 | 37 | */ |
| 37 | 38 | public function save(MessageInterface $message, $flush = true); |
| 38 | 39 | |
@@ -41,6 +42,7 @@ discard block |
||
| 41 | 42 | * |
| 42 | 43 | * If you want to persist multiple objects but only flush once you can call this method. |
| 43 | 44 | * This calls flush to the entity manager and all persisted objects will be saved. |
| 45 | + * @return void |
|
| 44 | 46 | */ |
| 45 | 47 | public function flush(); |
| 46 | 48 | } |