@@ -31,233 +31,233 @@ |
||
31 | 31 | * @since 9.0.0 |
32 | 32 | */ |
33 | 33 | interface IComment { |
34 | - const MAX_MESSAGE_LENGTH = 1000; |
|
34 | + const MAX_MESSAGE_LENGTH = 1000; |
|
35 | 35 | |
36 | - /** |
|
37 | - * returns the ID of the comment |
|
38 | - * |
|
39 | - * It may return an empty string, if the comment was not stored. |
|
40 | - * It is expected that the concrete Comment implementation gives an ID |
|
41 | - * by itself (e.g. after saving). |
|
42 | - * |
|
43 | - * @return string |
|
44 | - * @since 9.0.0 |
|
45 | - */ |
|
46 | - public function getId(); |
|
36 | + /** |
|
37 | + * returns the ID of the comment |
|
38 | + * |
|
39 | + * It may return an empty string, if the comment was not stored. |
|
40 | + * It is expected that the concrete Comment implementation gives an ID |
|
41 | + * by itself (e.g. after saving). |
|
42 | + * |
|
43 | + * @return string |
|
44 | + * @since 9.0.0 |
|
45 | + */ |
|
46 | + public function getId(); |
|
47 | 47 | |
48 | - /** |
|
49 | - * sets the ID of the comment and returns itself |
|
50 | - * |
|
51 | - * It is only allowed to set the ID only, if the current id is an empty |
|
52 | - * string (which means it is not stored in a database, storage or whatever |
|
53 | - * the concrete implementation does), or vice versa. Changing a given ID is |
|
54 | - * not permitted and must result in an IllegalIDChangeException. |
|
55 | - * |
|
56 | - * @param string $id |
|
57 | - * @return IComment |
|
58 | - * @throws IllegalIDChangeException |
|
59 | - * @since 9.0.0 |
|
60 | - */ |
|
61 | - public function setId($id); |
|
48 | + /** |
|
49 | + * sets the ID of the comment and returns itself |
|
50 | + * |
|
51 | + * It is only allowed to set the ID only, if the current id is an empty |
|
52 | + * string (which means it is not stored in a database, storage or whatever |
|
53 | + * the concrete implementation does), or vice versa. Changing a given ID is |
|
54 | + * not permitted and must result in an IllegalIDChangeException. |
|
55 | + * |
|
56 | + * @param string $id |
|
57 | + * @return IComment |
|
58 | + * @throws IllegalIDChangeException |
|
59 | + * @since 9.0.0 |
|
60 | + */ |
|
61 | + public function setId($id); |
|
62 | 62 | |
63 | - /** |
|
64 | - * returns the parent ID of the comment |
|
65 | - * |
|
66 | - * @return string |
|
67 | - * @since 9.0.0 |
|
68 | - */ |
|
69 | - public function getParentId(); |
|
63 | + /** |
|
64 | + * returns the parent ID of the comment |
|
65 | + * |
|
66 | + * @return string |
|
67 | + * @since 9.0.0 |
|
68 | + */ |
|
69 | + public function getParentId(); |
|
70 | 70 | |
71 | - /** |
|
72 | - * sets the parent ID and returns itself |
|
73 | - * @param string $parentId |
|
74 | - * @return IComment |
|
75 | - * @since 9.0.0 |
|
76 | - */ |
|
77 | - public function setParentId($parentId); |
|
71 | + /** |
|
72 | + * sets the parent ID and returns itself |
|
73 | + * @param string $parentId |
|
74 | + * @return IComment |
|
75 | + * @since 9.0.0 |
|
76 | + */ |
|
77 | + public function setParentId($parentId); |
|
78 | 78 | |
79 | - /** |
|
80 | - * returns the topmost parent ID of the comment |
|
81 | - * |
|
82 | - * @return string |
|
83 | - * @since 9.0.0 |
|
84 | - */ |
|
85 | - public function getTopmostParentId(); |
|
79 | + /** |
|
80 | + * returns the topmost parent ID of the comment |
|
81 | + * |
|
82 | + * @return string |
|
83 | + * @since 9.0.0 |
|
84 | + */ |
|
85 | + public function getTopmostParentId(); |
|
86 | 86 | |
87 | 87 | |
88 | - /** |
|
89 | - * sets the topmost parent ID and returns itself |
|
90 | - * |
|
91 | - * @param string $id |
|
92 | - * @return IComment |
|
93 | - * @since 9.0.0 |
|
94 | - */ |
|
95 | - public function setTopmostParentId($id); |
|
88 | + /** |
|
89 | + * sets the topmost parent ID and returns itself |
|
90 | + * |
|
91 | + * @param string $id |
|
92 | + * @return IComment |
|
93 | + * @since 9.0.0 |
|
94 | + */ |
|
95 | + public function setTopmostParentId($id); |
|
96 | 96 | |
97 | - /** |
|
98 | - * returns the number of children |
|
99 | - * |
|
100 | - * @return int |
|
101 | - * @since 9.0.0 |
|
102 | - */ |
|
103 | - public function getChildrenCount(); |
|
97 | + /** |
|
98 | + * returns the number of children |
|
99 | + * |
|
100 | + * @return int |
|
101 | + * @since 9.0.0 |
|
102 | + */ |
|
103 | + public function getChildrenCount(); |
|
104 | 104 | |
105 | - /** |
|
106 | - * sets the number of children |
|
107 | - * |
|
108 | - * @param int $count |
|
109 | - * @return IComment |
|
110 | - * @since 9.0.0 |
|
111 | - */ |
|
112 | - public function setChildrenCount($count); |
|
105 | + /** |
|
106 | + * sets the number of children |
|
107 | + * |
|
108 | + * @param int $count |
|
109 | + * @return IComment |
|
110 | + * @since 9.0.0 |
|
111 | + */ |
|
112 | + public function setChildrenCount($count); |
|
113 | 113 | |
114 | - /** |
|
115 | - * returns the message of the comment |
|
116 | - * |
|
117 | - * @return string |
|
118 | - * @since 9.0.0 |
|
119 | - */ |
|
120 | - public function getMessage(); |
|
114 | + /** |
|
115 | + * returns the message of the comment |
|
116 | + * |
|
117 | + * @return string |
|
118 | + * @since 9.0.0 |
|
119 | + */ |
|
120 | + public function getMessage(); |
|
121 | 121 | |
122 | - /** |
|
123 | - * sets the message of the comment and returns itself |
|
124 | - * |
|
125 | - * When the given message length exceeds MAX_MESSAGE_LENGTH an |
|
126 | - * MessageTooLongException shall be thrown. |
|
127 | - * |
|
128 | - * @param string $message |
|
129 | - * @return IComment |
|
130 | - * @throws MessageTooLongException |
|
131 | - * @since 9.0.0 |
|
132 | - */ |
|
133 | - public function setMessage($message); |
|
122 | + /** |
|
123 | + * sets the message of the comment and returns itself |
|
124 | + * |
|
125 | + * When the given message length exceeds MAX_MESSAGE_LENGTH an |
|
126 | + * MessageTooLongException shall be thrown. |
|
127 | + * |
|
128 | + * @param string $message |
|
129 | + * @return IComment |
|
130 | + * @throws MessageTooLongException |
|
131 | + * @since 9.0.0 |
|
132 | + */ |
|
133 | + public function setMessage($message); |
|
134 | 134 | |
135 | - /** |
|
136 | - * returns an array containing mentions that are included in the comment |
|
137 | - * |
|
138 | - * @return array each mention provides a 'type' and an 'id', see example below |
|
139 | - * @since 11.0.0 |
|
140 | - * |
|
141 | - * The return array looks like: |
|
142 | - * [ |
|
143 | - * [ |
|
144 | - * 'type' => 'user', |
|
145 | - * 'id' => 'citizen4' |
|
146 | - * ], |
|
147 | - * [ |
|
148 | - * 'type' => 'group', |
|
149 | - * 'id' => 'media' |
|
150 | - * ], |
|
151 | - * … |
|
152 | - * ] |
|
153 | - * |
|
154 | - */ |
|
155 | - public function getMentions(); |
|
135 | + /** |
|
136 | + * returns an array containing mentions that are included in the comment |
|
137 | + * |
|
138 | + * @return array each mention provides a 'type' and an 'id', see example below |
|
139 | + * @since 11.0.0 |
|
140 | + * |
|
141 | + * The return array looks like: |
|
142 | + * [ |
|
143 | + * [ |
|
144 | + * 'type' => 'user', |
|
145 | + * 'id' => 'citizen4' |
|
146 | + * ], |
|
147 | + * [ |
|
148 | + * 'type' => 'group', |
|
149 | + * 'id' => 'media' |
|
150 | + * ], |
|
151 | + * … |
|
152 | + * ] |
|
153 | + * |
|
154 | + */ |
|
155 | + public function getMentions(); |
|
156 | 156 | |
157 | - /** |
|
158 | - * returns the verb of the comment |
|
159 | - * |
|
160 | - * @return string |
|
161 | - * @since 9.0.0 |
|
162 | - */ |
|
163 | - public function getVerb(); |
|
157 | + /** |
|
158 | + * returns the verb of the comment |
|
159 | + * |
|
160 | + * @return string |
|
161 | + * @since 9.0.0 |
|
162 | + */ |
|
163 | + public function getVerb(); |
|
164 | 164 | |
165 | - /** |
|
166 | - * sets the verb of the comment, e.g. 'comment' or 'like' |
|
167 | - * |
|
168 | - * @param string $verb |
|
169 | - * @return IComment |
|
170 | - * @since 9.0.0 |
|
171 | - */ |
|
172 | - public function setVerb($verb); |
|
165 | + /** |
|
166 | + * sets the verb of the comment, e.g. 'comment' or 'like' |
|
167 | + * |
|
168 | + * @param string $verb |
|
169 | + * @return IComment |
|
170 | + * @since 9.0.0 |
|
171 | + */ |
|
172 | + public function setVerb($verb); |
|
173 | 173 | |
174 | - /** |
|
175 | - * returns the actor type |
|
176 | - * |
|
177 | - * @return string |
|
178 | - * @since 9.0.0 |
|
179 | - */ |
|
180 | - public function getActorType(); |
|
174 | + /** |
|
175 | + * returns the actor type |
|
176 | + * |
|
177 | + * @return string |
|
178 | + * @since 9.0.0 |
|
179 | + */ |
|
180 | + public function getActorType(); |
|
181 | 181 | |
182 | - /** |
|
183 | - * returns the actor ID |
|
184 | - * |
|
185 | - * @return string |
|
186 | - * @since 9.0.0 |
|
187 | - */ |
|
188 | - public function getActorId(); |
|
182 | + /** |
|
183 | + * returns the actor ID |
|
184 | + * |
|
185 | + * @return string |
|
186 | + * @since 9.0.0 |
|
187 | + */ |
|
188 | + public function getActorId(); |
|
189 | 189 | |
190 | - /** |
|
191 | - * sets (overwrites) the actor type and id |
|
192 | - * |
|
193 | - * @param string $actorType e.g. 'users' |
|
194 | - * @param string $actorId e.g. 'zombie234' |
|
195 | - * @return IComment |
|
196 | - * @since 9.0.0 |
|
197 | - */ |
|
198 | - public function setActor($actorType, $actorId); |
|
190 | + /** |
|
191 | + * sets (overwrites) the actor type and id |
|
192 | + * |
|
193 | + * @param string $actorType e.g. 'users' |
|
194 | + * @param string $actorId e.g. 'zombie234' |
|
195 | + * @return IComment |
|
196 | + * @since 9.0.0 |
|
197 | + */ |
|
198 | + public function setActor($actorType, $actorId); |
|
199 | 199 | |
200 | - /** |
|
201 | - * returns the creation date of the comment. |
|
202 | - * |
|
203 | - * If not explicitly set, it shall default to the time of initialization. |
|
204 | - * |
|
205 | - * @return \DateTime |
|
206 | - * @since 9.0.0 |
|
207 | - */ |
|
208 | - public function getCreationDateTime(); |
|
200 | + /** |
|
201 | + * returns the creation date of the comment. |
|
202 | + * |
|
203 | + * If not explicitly set, it shall default to the time of initialization. |
|
204 | + * |
|
205 | + * @return \DateTime |
|
206 | + * @since 9.0.0 |
|
207 | + */ |
|
208 | + public function getCreationDateTime(); |
|
209 | 209 | |
210 | - /** |
|
211 | - * sets the creation date of the comment and returns itself |
|
212 | - * |
|
213 | - * @param \DateTime $dateTime |
|
214 | - * @return IComment |
|
215 | - * @since 9.0.0 |
|
216 | - */ |
|
217 | - public function setCreationDateTime(\DateTime $dateTime); |
|
210 | + /** |
|
211 | + * sets the creation date of the comment and returns itself |
|
212 | + * |
|
213 | + * @param \DateTime $dateTime |
|
214 | + * @return IComment |
|
215 | + * @since 9.0.0 |
|
216 | + */ |
|
217 | + public function setCreationDateTime(\DateTime $dateTime); |
|
218 | 218 | |
219 | - /** |
|
220 | - * returns the date of the most recent child |
|
221 | - * |
|
222 | - * @return \DateTime |
|
223 | - * @since 9.0.0 |
|
224 | - */ |
|
225 | - public function getLatestChildDateTime(); |
|
219 | + /** |
|
220 | + * returns the date of the most recent child |
|
221 | + * |
|
222 | + * @return \DateTime |
|
223 | + * @since 9.0.0 |
|
224 | + */ |
|
225 | + public function getLatestChildDateTime(); |
|
226 | 226 | |
227 | - /** |
|
228 | - * sets the date of the most recent child |
|
229 | - * |
|
230 | - * @param \DateTime $dateTime |
|
231 | - * @return IComment |
|
232 | - * @since 9.0.0 |
|
233 | - */ |
|
234 | - public function setLatestChildDateTime(\DateTime $dateTime); |
|
227 | + /** |
|
228 | + * sets the date of the most recent child |
|
229 | + * |
|
230 | + * @param \DateTime $dateTime |
|
231 | + * @return IComment |
|
232 | + * @since 9.0.0 |
|
233 | + */ |
|
234 | + public function setLatestChildDateTime(\DateTime $dateTime); |
|
235 | 235 | |
236 | - /** |
|
237 | - * returns the object type the comment is attached to |
|
238 | - * |
|
239 | - * @return string |
|
240 | - * @since 9.0.0 |
|
241 | - */ |
|
242 | - public function getObjectType(); |
|
236 | + /** |
|
237 | + * returns the object type the comment is attached to |
|
238 | + * |
|
239 | + * @return string |
|
240 | + * @since 9.0.0 |
|
241 | + */ |
|
242 | + public function getObjectType(); |
|
243 | 243 | |
244 | - /** |
|
245 | - * returns the object id the comment is attached to |
|
246 | - * |
|
247 | - * @return string |
|
248 | - * @since 9.0.0 |
|
249 | - */ |
|
250 | - public function getObjectId(); |
|
244 | + /** |
|
245 | + * returns the object id the comment is attached to |
|
246 | + * |
|
247 | + * @return string |
|
248 | + * @since 9.0.0 |
|
249 | + */ |
|
250 | + public function getObjectId(); |
|
251 | 251 | |
252 | - /** |
|
253 | - * sets (overwrites) the object of the comment |
|
254 | - * |
|
255 | - * @param string $objectType e.g. 'files' |
|
256 | - * @param string $objectId e.g. '16435' |
|
257 | - * @return IComment |
|
258 | - * @since 9.0.0 |
|
259 | - */ |
|
260 | - public function setObject($objectType, $objectId); |
|
252 | + /** |
|
253 | + * sets (overwrites) the object of the comment |
|
254 | + * |
|
255 | + * @param string $objectType e.g. 'files' |
|
256 | + * @param string $objectId e.g. '16435' |
|
257 | + * @return IComment |
|
258 | + * @since 9.0.0 |
|
259 | + */ |
|
260 | + public function setObject($objectType, $objectId); |
|
261 | 261 | |
262 | 262 | } |
263 | 263 |
@@ -32,46 +32,46 @@ |
||
32 | 32 | */ |
33 | 33 | class CommentsEntityEvent extends Event { |
34 | 34 | |
35 | - const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity'; |
|
35 | + const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity'; |
|
36 | 36 | |
37 | - /** @var string */ |
|
38 | - protected $event; |
|
39 | - /** @var \Closure[] */ |
|
40 | - protected $collections; |
|
37 | + /** @var string */ |
|
38 | + protected $event; |
|
39 | + /** @var \Closure[] */ |
|
40 | + protected $collections; |
|
41 | 41 | |
42 | - /** |
|
43 | - * DispatcherEvent constructor. |
|
44 | - * |
|
45 | - * @param string $event |
|
46 | - * @since 9.1.0 |
|
47 | - */ |
|
48 | - public function __construct($event) { |
|
49 | - $this->event = $event; |
|
50 | - $this->collections = []; |
|
51 | - } |
|
42 | + /** |
|
43 | + * DispatcherEvent constructor. |
|
44 | + * |
|
45 | + * @param string $event |
|
46 | + * @since 9.1.0 |
|
47 | + */ |
|
48 | + public function __construct($event) { |
|
49 | + $this->event = $event; |
|
50 | + $this->collections = []; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * @param string $name |
|
55 | - * @param \Closure $entityExistsFunction The closure should take one |
|
56 | - * argument, which is the id of the entity, that comments |
|
57 | - * should be handled for. The return should then be bool, |
|
58 | - * depending on whether comments are allowed (true) or not. |
|
59 | - * @throws \OutOfBoundsException when the entity name is already taken |
|
60 | - * @since 9.1.0 |
|
61 | - */ |
|
62 | - public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
63 | - if (isset($this->collections[$name])) { |
|
64 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
65 | - } |
|
53 | + /** |
|
54 | + * @param string $name |
|
55 | + * @param \Closure $entityExistsFunction The closure should take one |
|
56 | + * argument, which is the id of the entity, that comments |
|
57 | + * should be handled for. The return should then be bool, |
|
58 | + * depending on whether comments are allowed (true) or not. |
|
59 | + * @throws \OutOfBoundsException when the entity name is already taken |
|
60 | + * @since 9.1.0 |
|
61 | + */ |
|
62 | + public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
63 | + if (isset($this->collections[$name])) { |
|
64 | + throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
65 | + } |
|
66 | 66 | |
67 | - $this->collections[$name] = $entityExistsFunction; |
|
68 | - } |
|
67 | + $this->collections[$name] = $entityExistsFunction; |
|
68 | + } |
|
69 | 69 | |
70 | - /** |
|
71 | - * @return \Closure[] |
|
72 | - * @since 9.1.0 |
|
73 | - */ |
|
74 | - public function getEntityCollections() { |
|
75 | - return $this->collections; |
|
76 | - } |
|
70 | + /** |
|
71 | + * @return \Closure[] |
|
72 | + * @since 9.1.0 |
|
73 | + */ |
|
74 | + public function getEntityCollections() { |
|
75 | + return $this->collections; |
|
76 | + } |
|
77 | 77 | } |
@@ -61,7 +61,7 @@ |
||
61 | 61 | */ |
62 | 62 | public function addEntityCollection($name, \Closure $entityExistsFunction) { |
63 | 63 | if (isset($this->collections[$name])) { |
64 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
64 | + throw new \OutOfBoundsException('Duplicate entity name "'.$name.'"'); |
|
65 | 65 | } |
66 | 66 | |
67 | 67 | $this->collections[$name] = $entityExistsFunction; |
@@ -36,19 +36,19 @@ |
||
36 | 36 | */ |
37 | 37 | interface ICommentsManagerFactory { |
38 | 38 | |
39 | - /** |
|
40 | - * Constructor for the comments manager factory |
|
41 | - * |
|
42 | - * @param IServerContainer $serverContainer server container |
|
43 | - * @since 9.0.0 |
|
44 | - */ |
|
45 | - public function __construct(IServerContainer $serverContainer); |
|
39 | + /** |
|
40 | + * Constructor for the comments manager factory |
|
41 | + * |
|
42 | + * @param IServerContainer $serverContainer server container |
|
43 | + * @since 9.0.0 |
|
44 | + */ |
|
45 | + public function __construct(IServerContainer $serverContainer); |
|
46 | 46 | |
47 | - /** |
|
48 | - * creates and returns an instance of the ICommentsManager |
|
49 | - * |
|
50 | - * @return ICommentsManager |
|
51 | - * @since 9.0.0 |
|
52 | - */ |
|
53 | - public function getManager(); |
|
47 | + /** |
|
48 | + * creates and returns an instance of the ICommentsManager |
|
49 | + * |
|
50 | + * @return ICommentsManager |
|
51 | + * @since 9.0.0 |
|
52 | + */ |
|
53 | + public function getManager(); |
|
54 | 54 | } |
@@ -30,51 +30,51 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface ICertificate { |
33 | - /** |
|
34 | - * @return string |
|
35 | - * @since 8.0.0 |
|
36 | - */ |
|
37 | - public function getName(); |
|
33 | + /** |
|
34 | + * @return string |
|
35 | + * @since 8.0.0 |
|
36 | + */ |
|
37 | + public function getName(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return string |
|
41 | - * @since 8.0.0 |
|
42 | - */ |
|
43 | - public function getCommonName(); |
|
39 | + /** |
|
40 | + * @return string |
|
41 | + * @since 8.0.0 |
|
42 | + */ |
|
43 | + public function getCommonName(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return string |
|
47 | - * @since 8.0.0 |
|
48 | - */ |
|
49 | - public function getOrganization(); |
|
45 | + /** |
|
46 | + * @return string |
|
47 | + * @since 8.0.0 |
|
48 | + */ |
|
49 | + public function getOrganization(); |
|
50 | 50 | |
51 | - /** |
|
52 | - * @return \DateTime |
|
53 | - * @since 8.0.0 |
|
54 | - */ |
|
55 | - public function getIssueDate(); |
|
51 | + /** |
|
52 | + * @return \DateTime |
|
53 | + * @since 8.0.0 |
|
54 | + */ |
|
55 | + public function getIssueDate(); |
|
56 | 56 | |
57 | - /** |
|
58 | - * @return \DateTime |
|
59 | - * @since 8.0.0 |
|
60 | - */ |
|
61 | - public function getExpireDate(); |
|
57 | + /** |
|
58 | + * @return \DateTime |
|
59 | + * @since 8.0.0 |
|
60 | + */ |
|
61 | + public function getExpireDate(); |
|
62 | 62 | |
63 | - /** |
|
64 | - * @return bool |
|
65 | - * @since 8.0.0 |
|
66 | - */ |
|
67 | - public function isExpired(); |
|
63 | + /** |
|
64 | + * @return bool |
|
65 | + * @since 8.0.0 |
|
66 | + */ |
|
67 | + public function isExpired(); |
|
68 | 68 | |
69 | - /** |
|
70 | - * @return string |
|
71 | - * @since 8.0.0 |
|
72 | - */ |
|
73 | - public function getIssuerName(); |
|
69 | + /** |
|
70 | + * @return string |
|
71 | + * @since 8.0.0 |
|
72 | + */ |
|
73 | + public function getIssuerName(); |
|
74 | 74 | |
75 | - /** |
|
76 | - * @return string |
|
77 | - * @since 8.0.0 |
|
78 | - */ |
|
79 | - public function getIssuerOrganization(); |
|
75 | + /** |
|
76 | + * @return string |
|
77 | + * @since 8.0.0 |
|
78 | + */ |
|
79 | + public function getIssuerOrganization(); |
|
80 | 80 | } |
@@ -29,78 +29,78 @@ |
||
29 | 29 | * @since 9.0.0 |
30 | 30 | */ |
31 | 31 | interface IAction { |
32 | - /** |
|
33 | - * @param string $label |
|
34 | - * @return $this |
|
35 | - * @throws \InvalidArgumentException if the label is invalid |
|
36 | - * @since 9.0.0 |
|
37 | - */ |
|
38 | - public function setLabel($label); |
|
32 | + /** |
|
33 | + * @param string $label |
|
34 | + * @return $this |
|
35 | + * @throws \InvalidArgumentException if the label is invalid |
|
36 | + * @since 9.0.0 |
|
37 | + */ |
|
38 | + public function setLabel($label); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @return string |
|
42 | - * @since 9.0.0 |
|
43 | - */ |
|
44 | - public function getLabel(); |
|
40 | + /** |
|
41 | + * @return string |
|
42 | + * @since 9.0.0 |
|
43 | + */ |
|
44 | + public function getLabel(); |
|
45 | 45 | |
46 | - /** |
|
47 | - * @param string $label |
|
48 | - * @return $this |
|
49 | - * @throws \InvalidArgumentException if the label is invalid |
|
50 | - * @since 9.0.0 |
|
51 | - */ |
|
52 | - public function setParsedLabel($label); |
|
46 | + /** |
|
47 | + * @param string $label |
|
48 | + * @return $this |
|
49 | + * @throws \InvalidArgumentException if the label is invalid |
|
50 | + * @since 9.0.0 |
|
51 | + */ |
|
52 | + public function setParsedLabel($label); |
|
53 | 53 | |
54 | - /** |
|
55 | - * @return string |
|
56 | - * @since 9.0.0 |
|
57 | - */ |
|
58 | - public function getParsedLabel(); |
|
54 | + /** |
|
55 | + * @return string |
|
56 | + * @since 9.0.0 |
|
57 | + */ |
|
58 | + public function getParsedLabel(); |
|
59 | 59 | |
60 | - /** |
|
61 | - * @param $primary bool |
|
62 | - * @return $this |
|
63 | - * @throws \InvalidArgumentException if $primary is invalid |
|
64 | - * @since 9.0.0 |
|
65 | - */ |
|
66 | - public function setPrimary($primary); |
|
60 | + /** |
|
61 | + * @param $primary bool |
|
62 | + * @return $this |
|
63 | + * @throws \InvalidArgumentException if $primary is invalid |
|
64 | + * @since 9.0.0 |
|
65 | + */ |
|
66 | + public function setPrimary($primary); |
|
67 | 67 | |
68 | - /** |
|
69 | - * @return bool |
|
70 | - * @since 9.0.0 |
|
71 | - */ |
|
72 | - public function isPrimary(); |
|
68 | + /** |
|
69 | + * @return bool |
|
70 | + * @since 9.0.0 |
|
71 | + */ |
|
72 | + public function isPrimary(); |
|
73 | 73 | |
74 | - /** |
|
75 | - * @param string $link |
|
76 | - * @param string $requestType |
|
77 | - * @return $this |
|
78 | - * @throws \InvalidArgumentException if the link is invalid |
|
79 | - * @since 9.0.0 |
|
80 | - */ |
|
81 | - public function setLink($link, $requestType); |
|
74 | + /** |
|
75 | + * @param string $link |
|
76 | + * @param string $requestType |
|
77 | + * @return $this |
|
78 | + * @throws \InvalidArgumentException if the link is invalid |
|
79 | + * @since 9.0.0 |
|
80 | + */ |
|
81 | + public function setLink($link, $requestType); |
|
82 | 82 | |
83 | - /** |
|
84 | - * @return string |
|
85 | - * @since 9.0.0 |
|
86 | - */ |
|
87 | - public function getLink(); |
|
83 | + /** |
|
84 | + * @return string |
|
85 | + * @since 9.0.0 |
|
86 | + */ |
|
87 | + public function getLink(); |
|
88 | 88 | |
89 | - /** |
|
90 | - * @return string |
|
91 | - * @since 9.0.0 |
|
92 | - */ |
|
93 | - public function getRequestType(); |
|
89 | + /** |
|
90 | + * @return string |
|
91 | + * @since 9.0.0 |
|
92 | + */ |
|
93 | + public function getRequestType(); |
|
94 | 94 | |
95 | - /** |
|
96 | - * @return bool |
|
97 | - * @since 9.0.0 |
|
98 | - */ |
|
99 | - public function isValid(); |
|
95 | + /** |
|
96 | + * @return bool |
|
97 | + * @since 9.0.0 |
|
98 | + */ |
|
99 | + public function isValid(); |
|
100 | 100 | |
101 | - /** |
|
102 | - * @return bool |
|
103 | - * @since 9.0.0 |
|
104 | - */ |
|
105 | - public function isValidParsed(); |
|
101 | + /** |
|
102 | + * @return bool |
|
103 | + * @since 9.0.0 |
|
104 | + */ |
|
105 | + public function isValidParsed(); |
|
106 | 106 | } |
@@ -29,252 +29,252 @@ |
||
29 | 29 | * @since 9.0.0 |
30 | 30 | */ |
31 | 31 | interface INotification { |
32 | - /** |
|
33 | - * @param string $app |
|
34 | - * @return $this |
|
35 | - * @throws \InvalidArgumentException if the app id is invalid |
|
36 | - * @since 9.0.0 |
|
37 | - */ |
|
38 | - public function setApp($app); |
|
39 | - |
|
40 | - /** |
|
41 | - * @return string |
|
42 | - * @since 9.0.0 |
|
43 | - */ |
|
44 | - public function getApp(); |
|
45 | - |
|
46 | - /** |
|
47 | - * @param string $user |
|
48 | - * @return $this |
|
49 | - * @throws \InvalidArgumentException if the user id is invalid |
|
50 | - * @since 9.0.0 |
|
51 | - */ |
|
52 | - public function setUser($user); |
|
53 | - |
|
54 | - /** |
|
55 | - * @return string |
|
56 | - * @since 9.0.0 |
|
57 | - */ |
|
58 | - public function getUser(); |
|
59 | - |
|
60 | - /** |
|
61 | - * @param \DateTime $dateTime |
|
62 | - * @return $this |
|
63 | - * @throws \InvalidArgumentException if the $dateTime is invalid |
|
64 | - * @since 9.0.0 |
|
65 | - */ |
|
66 | - public function setDateTime(\DateTime $dateTime); |
|
67 | - |
|
68 | - /** |
|
69 | - * @return \DateTime |
|
70 | - * @since 9.0.0 |
|
71 | - */ |
|
72 | - public function getDateTime(); |
|
73 | - |
|
74 | - /** |
|
75 | - * @param string $type |
|
76 | - * @param string $id |
|
77 | - * @return $this |
|
78 | - * @throws \InvalidArgumentException if the object type or id is invalid |
|
79 | - * @since 9.0.0 |
|
80 | - */ |
|
81 | - public function setObject($type, $id); |
|
82 | - |
|
83 | - /** |
|
84 | - * @return string |
|
85 | - * @since 9.0.0 |
|
86 | - */ |
|
87 | - public function getObjectType(); |
|
88 | - |
|
89 | - /** |
|
90 | - * @return string |
|
91 | - * @since 9.0.0 |
|
92 | - */ |
|
93 | - public function getObjectId(); |
|
94 | - |
|
95 | - /** |
|
96 | - * @param string $subject |
|
97 | - * @param array $parameters |
|
98 | - * @return $this |
|
99 | - * @throws \InvalidArgumentException if the subject or parameters are invalid |
|
100 | - * @since 9.0.0 |
|
101 | - */ |
|
102 | - public function setSubject($subject, array $parameters = []); |
|
103 | - |
|
104 | - /** |
|
105 | - * @return string |
|
106 | - * @since 9.0.0 |
|
107 | - */ |
|
108 | - public function getSubject(); |
|
109 | - |
|
110 | - /** |
|
111 | - * @return string[] |
|
112 | - * @since 9.0.0 |
|
113 | - */ |
|
114 | - public function getSubjectParameters(); |
|
115 | - |
|
116 | - /** |
|
117 | - * @param string $subject |
|
118 | - * @return $this |
|
119 | - * @throws \InvalidArgumentException if the subject is invalid |
|
120 | - * @since 9.0.0 |
|
121 | - */ |
|
122 | - public function setParsedSubject($subject); |
|
123 | - |
|
124 | - /** |
|
125 | - * @return string |
|
126 | - * @since 9.0.0 |
|
127 | - */ |
|
128 | - public function getParsedSubject(); |
|
129 | - |
|
130 | - /** |
|
131 | - * @param string $subject |
|
132 | - * @param array $parameters |
|
133 | - * @return $this |
|
134 | - * @throws \InvalidArgumentException if the subject or parameters are invalid |
|
135 | - * @since 11.0.0 |
|
136 | - */ |
|
137 | - public function setRichSubject($subject, array $parameters = []); |
|
138 | - |
|
139 | - /** |
|
140 | - * @return string |
|
141 | - * @since 11.0.0 |
|
142 | - */ |
|
143 | - public function getRichSubject(); |
|
144 | - |
|
145 | - /** |
|
146 | - * @return array[] |
|
147 | - * @since 11.0.0 |
|
148 | - */ |
|
149 | - public function getRichSubjectParameters(); |
|
150 | - |
|
151 | - /** |
|
152 | - * @param string $message |
|
153 | - * @param array $parameters |
|
154 | - * @return $this |
|
155 | - * @throws \InvalidArgumentException if the message or parameters are invalid |
|
156 | - * @since 9.0.0 |
|
157 | - */ |
|
158 | - public function setMessage($message, array $parameters = []); |
|
159 | - |
|
160 | - /** |
|
161 | - * @return string |
|
162 | - * @since 9.0.0 |
|
163 | - */ |
|
164 | - public function getMessage(); |
|
165 | - |
|
166 | - /** |
|
167 | - * @return string[] |
|
168 | - * @since 9.0.0 |
|
169 | - */ |
|
170 | - public function getMessageParameters(); |
|
171 | - |
|
172 | - /** |
|
173 | - * @param string $message |
|
174 | - * @return $this |
|
175 | - * @throws \InvalidArgumentException if the message is invalid |
|
176 | - * @since 9.0.0 |
|
177 | - */ |
|
178 | - public function setParsedMessage($message); |
|
179 | - |
|
180 | - /** |
|
181 | - * @return string |
|
182 | - * @since 9.0.0 |
|
183 | - */ |
|
184 | - public function getParsedMessage(); |
|
185 | - |
|
186 | - /** |
|
187 | - * @param string $message |
|
188 | - * @param array $parameters |
|
189 | - * @return $this |
|
190 | - * @throws \InvalidArgumentException if the message or parameters are invalid |
|
191 | - * @since 11.0.0 |
|
192 | - */ |
|
193 | - public function setRichMessage($message, array $parameters = []); |
|
194 | - |
|
195 | - /** |
|
196 | - * @return string |
|
197 | - * @since 11.0.0 |
|
198 | - */ |
|
199 | - public function getRichMessage(); |
|
200 | - |
|
201 | - /** |
|
202 | - * @return array[] |
|
203 | - * @since 11.0.0 |
|
204 | - */ |
|
205 | - public function getRichMessageParameters(); |
|
206 | - |
|
207 | - /** |
|
208 | - * @param string $link |
|
209 | - * @return $this |
|
210 | - * @throws \InvalidArgumentException if the link is invalid |
|
211 | - * @since 9.0.0 |
|
212 | - */ |
|
213 | - public function setLink($link); |
|
214 | - |
|
215 | - /** |
|
216 | - * @return string |
|
217 | - * @since 9.0.0 |
|
218 | - */ |
|
219 | - public function getLink(); |
|
220 | - |
|
221 | - /** |
|
222 | - * @param string $icon |
|
223 | - * @return $this |
|
224 | - * @throws \InvalidArgumentException if the icon is invalid |
|
225 | - * @since 11.0.0 |
|
226 | - */ |
|
227 | - public function setIcon($icon); |
|
228 | - |
|
229 | - /** |
|
230 | - * @return string |
|
231 | - * @since 11.0.0 |
|
232 | - */ |
|
233 | - public function getIcon(); |
|
234 | - |
|
235 | - /** |
|
236 | - * @return IAction |
|
237 | - * @since 9.0.0 |
|
238 | - */ |
|
239 | - public function createAction(); |
|
240 | - |
|
241 | - /** |
|
242 | - * @param IAction $action |
|
243 | - * @return $this |
|
244 | - * @throws \InvalidArgumentException if the action is invalid |
|
245 | - * @since 9.0.0 |
|
246 | - */ |
|
247 | - public function addAction(IAction $action); |
|
248 | - |
|
249 | - /** |
|
250 | - * @return IAction[] |
|
251 | - * @since 9.0.0 |
|
252 | - */ |
|
253 | - public function getActions(); |
|
254 | - |
|
255 | - /** |
|
256 | - * @param IAction $action |
|
257 | - * @return $this |
|
258 | - * @throws \InvalidArgumentException if the action is invalid |
|
259 | - * @since 9.0.0 |
|
260 | - */ |
|
261 | - public function addParsedAction(IAction $action); |
|
262 | - |
|
263 | - /** |
|
264 | - * @return IAction[] |
|
265 | - * @since 9.0.0 |
|
266 | - */ |
|
267 | - public function getParsedActions(); |
|
268 | - |
|
269 | - /** |
|
270 | - * @return bool |
|
271 | - * @since 9.0.0 |
|
272 | - */ |
|
273 | - public function isValid(); |
|
274 | - |
|
275 | - /** |
|
276 | - * @return bool |
|
277 | - * @since 9.0.0 |
|
278 | - */ |
|
279 | - public function isValidParsed(); |
|
32 | + /** |
|
33 | + * @param string $app |
|
34 | + * @return $this |
|
35 | + * @throws \InvalidArgumentException if the app id is invalid |
|
36 | + * @since 9.0.0 |
|
37 | + */ |
|
38 | + public function setApp($app); |
|
39 | + |
|
40 | + /** |
|
41 | + * @return string |
|
42 | + * @since 9.0.0 |
|
43 | + */ |
|
44 | + public function getApp(); |
|
45 | + |
|
46 | + /** |
|
47 | + * @param string $user |
|
48 | + * @return $this |
|
49 | + * @throws \InvalidArgumentException if the user id is invalid |
|
50 | + * @since 9.0.0 |
|
51 | + */ |
|
52 | + public function setUser($user); |
|
53 | + |
|
54 | + /** |
|
55 | + * @return string |
|
56 | + * @since 9.0.0 |
|
57 | + */ |
|
58 | + public function getUser(); |
|
59 | + |
|
60 | + /** |
|
61 | + * @param \DateTime $dateTime |
|
62 | + * @return $this |
|
63 | + * @throws \InvalidArgumentException if the $dateTime is invalid |
|
64 | + * @since 9.0.0 |
|
65 | + */ |
|
66 | + public function setDateTime(\DateTime $dateTime); |
|
67 | + |
|
68 | + /** |
|
69 | + * @return \DateTime |
|
70 | + * @since 9.0.0 |
|
71 | + */ |
|
72 | + public function getDateTime(); |
|
73 | + |
|
74 | + /** |
|
75 | + * @param string $type |
|
76 | + * @param string $id |
|
77 | + * @return $this |
|
78 | + * @throws \InvalidArgumentException if the object type or id is invalid |
|
79 | + * @since 9.0.0 |
|
80 | + */ |
|
81 | + public function setObject($type, $id); |
|
82 | + |
|
83 | + /** |
|
84 | + * @return string |
|
85 | + * @since 9.0.0 |
|
86 | + */ |
|
87 | + public function getObjectType(); |
|
88 | + |
|
89 | + /** |
|
90 | + * @return string |
|
91 | + * @since 9.0.0 |
|
92 | + */ |
|
93 | + public function getObjectId(); |
|
94 | + |
|
95 | + /** |
|
96 | + * @param string $subject |
|
97 | + * @param array $parameters |
|
98 | + * @return $this |
|
99 | + * @throws \InvalidArgumentException if the subject or parameters are invalid |
|
100 | + * @since 9.0.0 |
|
101 | + */ |
|
102 | + public function setSubject($subject, array $parameters = []); |
|
103 | + |
|
104 | + /** |
|
105 | + * @return string |
|
106 | + * @since 9.0.0 |
|
107 | + */ |
|
108 | + public function getSubject(); |
|
109 | + |
|
110 | + /** |
|
111 | + * @return string[] |
|
112 | + * @since 9.0.0 |
|
113 | + */ |
|
114 | + public function getSubjectParameters(); |
|
115 | + |
|
116 | + /** |
|
117 | + * @param string $subject |
|
118 | + * @return $this |
|
119 | + * @throws \InvalidArgumentException if the subject is invalid |
|
120 | + * @since 9.0.0 |
|
121 | + */ |
|
122 | + public function setParsedSubject($subject); |
|
123 | + |
|
124 | + /** |
|
125 | + * @return string |
|
126 | + * @since 9.0.0 |
|
127 | + */ |
|
128 | + public function getParsedSubject(); |
|
129 | + |
|
130 | + /** |
|
131 | + * @param string $subject |
|
132 | + * @param array $parameters |
|
133 | + * @return $this |
|
134 | + * @throws \InvalidArgumentException if the subject or parameters are invalid |
|
135 | + * @since 11.0.0 |
|
136 | + */ |
|
137 | + public function setRichSubject($subject, array $parameters = []); |
|
138 | + |
|
139 | + /** |
|
140 | + * @return string |
|
141 | + * @since 11.0.0 |
|
142 | + */ |
|
143 | + public function getRichSubject(); |
|
144 | + |
|
145 | + /** |
|
146 | + * @return array[] |
|
147 | + * @since 11.0.0 |
|
148 | + */ |
|
149 | + public function getRichSubjectParameters(); |
|
150 | + |
|
151 | + /** |
|
152 | + * @param string $message |
|
153 | + * @param array $parameters |
|
154 | + * @return $this |
|
155 | + * @throws \InvalidArgumentException if the message or parameters are invalid |
|
156 | + * @since 9.0.0 |
|
157 | + */ |
|
158 | + public function setMessage($message, array $parameters = []); |
|
159 | + |
|
160 | + /** |
|
161 | + * @return string |
|
162 | + * @since 9.0.0 |
|
163 | + */ |
|
164 | + public function getMessage(); |
|
165 | + |
|
166 | + /** |
|
167 | + * @return string[] |
|
168 | + * @since 9.0.0 |
|
169 | + */ |
|
170 | + public function getMessageParameters(); |
|
171 | + |
|
172 | + /** |
|
173 | + * @param string $message |
|
174 | + * @return $this |
|
175 | + * @throws \InvalidArgumentException if the message is invalid |
|
176 | + * @since 9.0.0 |
|
177 | + */ |
|
178 | + public function setParsedMessage($message); |
|
179 | + |
|
180 | + /** |
|
181 | + * @return string |
|
182 | + * @since 9.0.0 |
|
183 | + */ |
|
184 | + public function getParsedMessage(); |
|
185 | + |
|
186 | + /** |
|
187 | + * @param string $message |
|
188 | + * @param array $parameters |
|
189 | + * @return $this |
|
190 | + * @throws \InvalidArgumentException if the message or parameters are invalid |
|
191 | + * @since 11.0.0 |
|
192 | + */ |
|
193 | + public function setRichMessage($message, array $parameters = []); |
|
194 | + |
|
195 | + /** |
|
196 | + * @return string |
|
197 | + * @since 11.0.0 |
|
198 | + */ |
|
199 | + public function getRichMessage(); |
|
200 | + |
|
201 | + /** |
|
202 | + * @return array[] |
|
203 | + * @since 11.0.0 |
|
204 | + */ |
|
205 | + public function getRichMessageParameters(); |
|
206 | + |
|
207 | + /** |
|
208 | + * @param string $link |
|
209 | + * @return $this |
|
210 | + * @throws \InvalidArgumentException if the link is invalid |
|
211 | + * @since 9.0.0 |
|
212 | + */ |
|
213 | + public function setLink($link); |
|
214 | + |
|
215 | + /** |
|
216 | + * @return string |
|
217 | + * @since 9.0.0 |
|
218 | + */ |
|
219 | + public function getLink(); |
|
220 | + |
|
221 | + /** |
|
222 | + * @param string $icon |
|
223 | + * @return $this |
|
224 | + * @throws \InvalidArgumentException if the icon is invalid |
|
225 | + * @since 11.0.0 |
|
226 | + */ |
|
227 | + public function setIcon($icon); |
|
228 | + |
|
229 | + /** |
|
230 | + * @return string |
|
231 | + * @since 11.0.0 |
|
232 | + */ |
|
233 | + public function getIcon(); |
|
234 | + |
|
235 | + /** |
|
236 | + * @return IAction |
|
237 | + * @since 9.0.0 |
|
238 | + */ |
|
239 | + public function createAction(); |
|
240 | + |
|
241 | + /** |
|
242 | + * @param IAction $action |
|
243 | + * @return $this |
|
244 | + * @throws \InvalidArgumentException if the action is invalid |
|
245 | + * @since 9.0.0 |
|
246 | + */ |
|
247 | + public function addAction(IAction $action); |
|
248 | + |
|
249 | + /** |
|
250 | + * @return IAction[] |
|
251 | + * @since 9.0.0 |
|
252 | + */ |
|
253 | + public function getActions(); |
|
254 | + |
|
255 | + /** |
|
256 | + * @param IAction $action |
|
257 | + * @return $this |
|
258 | + * @throws \InvalidArgumentException if the action is invalid |
|
259 | + * @since 9.0.0 |
|
260 | + */ |
|
261 | + public function addParsedAction(IAction $action); |
|
262 | + |
|
263 | + /** |
|
264 | + * @return IAction[] |
|
265 | + * @since 9.0.0 |
|
266 | + */ |
|
267 | + public function getParsedActions(); |
|
268 | + |
|
269 | + /** |
|
270 | + * @return bool |
|
271 | + * @since 9.0.0 |
|
272 | + */ |
|
273 | + public function isValid(); |
|
274 | + |
|
275 | + /** |
|
276 | + * @return bool |
|
277 | + * @since 9.0.0 |
|
278 | + */ |
|
279 | + public function isValidParsed(); |
|
280 | 280 | } |
@@ -29,23 +29,23 @@ |
||
29 | 29 | * @since 9.0.0 |
30 | 30 | */ |
31 | 31 | interface IApp { |
32 | - /** |
|
33 | - * @param INotification $notification |
|
34 | - * @throws \InvalidArgumentException When the notification is not valid |
|
35 | - * @since 9.0.0 |
|
36 | - */ |
|
37 | - public function notify(INotification $notification); |
|
32 | + /** |
|
33 | + * @param INotification $notification |
|
34 | + * @throws \InvalidArgumentException When the notification is not valid |
|
35 | + * @since 9.0.0 |
|
36 | + */ |
|
37 | + public function notify(INotification $notification); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @param INotification $notification |
|
41 | - * @since 9.0.0 |
|
42 | - */ |
|
43 | - public function markProcessed(INotification $notification); |
|
39 | + /** |
|
40 | + * @param INotification $notification |
|
41 | + * @since 9.0.0 |
|
42 | + */ |
|
43 | + public function markProcessed(INotification $notification); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @param INotification $notification |
|
47 | - * @return int |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function getCount(INotification $notification); |
|
45 | + /** |
|
46 | + * @param INotification $notification |
|
47 | + * @return int |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function getCount(INotification $notification); |
|
51 | 51 | } |
@@ -29,12 +29,12 @@ |
||
29 | 29 | * @since 9.0.0 |
30 | 30 | */ |
31 | 31 | interface INotifier { |
32 | - /** |
|
33 | - * @param INotification $notification |
|
34 | - * @param string $languageCode The code of the language that should be used to prepare the notification |
|
35 | - * @return INotification |
|
36 | - * @throws \InvalidArgumentException When the notification was not prepared by a notifier |
|
37 | - * @since 9.0.0 |
|
38 | - */ |
|
39 | - public function prepare(INotification $notification, $languageCode); |
|
32 | + /** |
|
33 | + * @param INotification $notification |
|
34 | + * @param string $languageCode The code of the language that should be used to prepare the notification |
|
35 | + * @return INotification |
|
36 | + * @throws \InvalidArgumentException When the notification was not prepared by a notifier |
|
37 | + * @since 9.0.0 |
|
38 | + */ |
|
39 | + public function prepare(INotification $notification, $languageCode); |
|
40 | 40 | } |
@@ -41,39 +41,39 @@ |
||
41 | 41 | */ |
42 | 42 | class API { |
43 | 43 | |
44 | - /** |
|
45 | - * API authentication levels |
|
46 | - * @since 8.1.0 |
|
47 | - */ |
|
48 | - const GUEST_AUTH = 0; |
|
49 | - const USER_AUTH = 1; |
|
50 | - const SUBADMIN_AUTH = 2; |
|
51 | - const ADMIN_AUTH = 3; |
|
44 | + /** |
|
45 | + * API authentication levels |
|
46 | + * @since 8.1.0 |
|
47 | + */ |
|
48 | + const GUEST_AUTH = 0; |
|
49 | + const USER_AUTH = 1; |
|
50 | + const SUBADMIN_AUTH = 2; |
|
51 | + const ADMIN_AUTH = 3; |
|
52 | 52 | |
53 | - /** |
|
54 | - * API Response Codes |
|
55 | - * @since 8.1.0 |
|
56 | - */ |
|
57 | - const RESPOND_UNAUTHORISED = 997; |
|
58 | - const RESPOND_SERVER_ERROR = 996; |
|
59 | - const RESPOND_NOT_FOUND = 998; |
|
60 | - const RESPOND_UNKNOWN_ERROR = 999; |
|
53 | + /** |
|
54 | + * API Response Codes |
|
55 | + * @since 8.1.0 |
|
56 | + */ |
|
57 | + const RESPOND_UNAUTHORISED = 997; |
|
58 | + const RESPOND_SERVER_ERROR = 996; |
|
59 | + const RESPOND_NOT_FOUND = 998; |
|
60 | + const RESPOND_UNKNOWN_ERROR = 999; |
|
61 | 61 | |
62 | - /** |
|
63 | - * registers an api call |
|
64 | - * @param string $method the http method |
|
65 | - * @param string $url the url to match |
|
66 | - * @param callable $action the function to run |
|
67 | - * @param string $app the id of the app registering the call |
|
68 | - * @param int $authLevel the level of authentication required for the call (See `self::*_AUTH` constants) |
|
69 | - * @param array $defaults |
|
70 | - * @param array $requirements |
|
71 | - * @since 5.0.0 |
|
72 | - * @deprecated 9.1.0 Use the AppFramework |
|
73 | - */ |
|
74 | - public static function register($method, $url, $action, $app, $authLevel = self::USER_AUTH, |
|
75 | - $defaults = array(), $requirements = array()){ |
|
76 | - \OC_API::register($method, $url, $action, $app, $authLevel, $defaults, $requirements); |
|
77 | - } |
|
62 | + /** |
|
63 | + * registers an api call |
|
64 | + * @param string $method the http method |
|
65 | + * @param string $url the url to match |
|
66 | + * @param callable $action the function to run |
|
67 | + * @param string $app the id of the app registering the call |
|
68 | + * @param int $authLevel the level of authentication required for the call (See `self::*_AUTH` constants) |
|
69 | + * @param array $defaults |
|
70 | + * @param array $requirements |
|
71 | + * @since 5.0.0 |
|
72 | + * @deprecated 9.1.0 Use the AppFramework |
|
73 | + */ |
|
74 | + public static function register($method, $url, $action, $app, $authLevel = self::USER_AUTH, |
|
75 | + $defaults = array(), $requirements = array()){ |
|
76 | + \OC_API::register($method, $url, $action, $app, $authLevel, $defaults, $requirements); |
|
77 | + } |
|
78 | 78 | |
79 | 79 | } |
@@ -72,7 +72,7 @@ |
||
72 | 72 | * @deprecated 9.1.0 Use the AppFramework |
73 | 73 | */ |
74 | 74 | public static function register($method, $url, $action, $app, $authLevel = self::USER_AUTH, |
75 | - $defaults = array(), $requirements = array()){ |
|
75 | + $defaults = array(), $requirements = array()) { |
|
76 | 76 | \OC_API::register($method, $url, $action, $app, $authLevel, $defaults, $requirements); |
77 | 77 | } |
78 | 78 |