1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCP\Comments;
/**
* Interface IComment
*
* This class represents a comment
*
* @package OCP\Comments
* @since 9.0.0
*/
interface IComment {
const MAX_MESSAGE_LENGTH = 1000;
/**
* returns the ID of the comment
*
* It may return an empty string, if the comment was not stored.
* It is expected that the concrete Comment implementation gives an ID
* by itself (e.g. after saving).
*
* @return string
* @since 9.0.0
*/
public function getId();
/**
* sets the ID of the comment and returns itself
*
* It is only allowed to set the ID only, if the current id is an empty
* string (which means it is not stored in a database, storage or whatever
* the concrete implementation does), or vice versa. Changing a given ID is
* not permitted and must result in an IllegalIDChangeException.
*
* @param string $id
* @return IComment
* @throws IllegalIDChangeException
* @since 9.0.0
*/
public function setId($id);
/**
* returns the parent ID of the comment
*
* @return string
* @since 9.0.0
*/
public function getParentId();
/**
* sets the parent ID and returns itself
* @param string $parentId
* @return IComment
* @since 9.0.0
*/
public function setParentId($parentId);
/**
* returns the topmost parent ID of the comment
*
* @return string
* @since 9.0.0
*/
public function getTopmostParentId();
/**
* sets the topmost parent ID and returns itself
*
* @param string $id
* @return IComment
* @since 9.0.0
*/
public function setTopmostParentId($id);
/**
* returns the number of children
*
* @return int
* @since 9.0.0
*/
public function getChildrenCount();
/**
* sets the number of children
*
* @param int $count
* @return IComment
* @since 9.0.0
*/
public function setChildrenCount($count);
/**
* returns the message of the comment
*
* @return string
* @since 9.0.0
*/
public function getMessage();
/**
* sets the message of the comment and returns itself
*
* When the given message length exceeds MAX_MESSAGE_LENGTH an
* MessageTooLongException shall be thrown.
*
* @param string $message
* @return IComment
* @throws MessageTooLongException
* @since 9.0.0
*/
public function setMessage($message);
/**
* returns an array containing mentions that are included in the comment
*
* @return array each mention provides a 'type' and an 'id', see example below
* @since 11.0.0
*
* The return array looks like:
* [
* [
* 'type' => 'user',
* 'id' => 'citizen4'
* ],
* [
* 'type' => 'group',
* 'id' => 'media'
* ],
* …
* ]
*
*/
public function getMentions();
/**
* returns the verb of the comment
*
* @return string
* @since 9.0.0
*/
public function getVerb();
/**
* sets the verb of the comment, e.g. 'comment' or 'like'
*
* @param string $verb
* @return IComment
* @since 9.0.0
*/
public function setVerb($verb);
/**
* returns the actor type
*
* @return string
* @since 9.0.0
*/
public function getActorType();
/**
* returns the actor ID
*
* @return string
* @since 9.0.0
*/
public function getActorId();
/**
* sets (overwrites) the actor type and id
*
* @param string $actorType e.g. 'users'
* @param string $actorId e.g. 'zombie234'
* @return IComment
* @since 9.0.0
*/
public function setActor($actorType, $actorId);
/**
* returns the creation date of the comment.
*
* If not explicitly set, it shall default to the time of initialization.
*
* @return \DateTime
* @since 9.0.0
*/
public function getCreationDateTime();
/**
* sets the creation date of the comment and returns itself
*
* @param \DateTime $dateTime
* @return IComment
* @since 9.0.0
*/
public function setCreationDateTime(\DateTime $dateTime);
/**
* returns the date of the most recent child
*
* @return \DateTime
* @since 9.0.0
*/
public function getLatestChildDateTime();
/**
* sets the date of the most recent child
*
* @param \DateTime $dateTime
* @return IComment
* @since 9.0.0
*/
public function setLatestChildDateTime(\DateTime $dateTime);
/**
* returns the object type the comment is attached to
*
* @return string
* @since 9.0.0
*/
public function getObjectType();
/**
* returns the object id the comment is attached to
*
* @return string
* @since 9.0.0
*/
public function getObjectId();
/**
* sets (overwrites) the object of the comment
*
* @param string $objectType e.g. 'files'
* @param string $objectId e.g. '16435'
* @return IComment
* @since 9.0.0
*/
public function setObject($objectType, $objectId);
}
|
