@@ -31,9 +31,9 @@ |
||
31 | 31 | */ |
32 | 32 | interface ICommentsEventHandler { |
33 | 33 | |
34 | - /** |
|
35 | - * @param CommentsEvent $event |
|
36 | - * @since 11.0.0 |
|
37 | - */ |
|
38 | - public function handle(CommentsEvent $event); |
|
34 | + /** |
|
35 | + * @param CommentsEvent $event |
|
36 | + * @since 11.0.0 |
|
37 | + */ |
|
38 | + public function handle(CommentsEvent $event); |
|
39 | 39 | } |
@@ -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 |
@@ -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 | } |
@@ -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 | } |
@@ -31,18 +31,18 @@ |
||
31 | 31 | * @since 9.1 |
32 | 32 | */ |
33 | 33 | interface IManager { |
34 | - /** |
|
35 | - * @param IStorage $storage |
|
36 | - * @param string $path |
|
37 | - * @since 9.1 |
|
38 | - */ |
|
39 | - public function setFileInfo(IStorage $storage, $path); |
|
34 | + /** |
|
35 | + * @param IStorage $storage |
|
36 | + * @param string $path |
|
37 | + * @since 9.1 |
|
38 | + */ |
|
39 | + public function setFileInfo(IStorage $storage, $path); |
|
40 | 40 | |
41 | - /** |
|
42 | - * @param string $class |
|
43 | - * @param bool $returnFirstMatchingOperationOnly |
|
44 | - * @return array |
|
45 | - * @since 9.1 |
|
46 | - */ |
|
47 | - public function getMatchingOperations($class, $returnFirstMatchingOperationOnly = true); |
|
41 | + /** |
|
42 | + * @param string $class |
|
43 | + * @param bool $returnFirstMatchingOperationOnly |
|
44 | + * @return array |
|
45 | + * @since 9.1 |
|
46 | + */ |
|
47 | + public function getMatchingOperations($class, $returnFirstMatchingOperationOnly = true); |
|
48 | 48 | } |
@@ -28,12 +28,12 @@ |
||
28 | 28 | * @since 9.1 |
29 | 29 | */ |
30 | 30 | interface IOperation { |
31 | - /** |
|
32 | - * @param string $name |
|
33 | - * @param array[] $checks |
|
34 | - * @param string $operation |
|
35 | - * @throws \UnexpectedValueException |
|
36 | - * @since 9.1 |
|
37 | - */ |
|
38 | - public function validateOperation($name, array $checks, $operation); |
|
31 | + /** |
|
32 | + * @param string $name |
|
33 | + * @param array[] $checks |
|
34 | + * @param string $operation |
|
35 | + * @throws \UnexpectedValueException |
|
36 | + * @since 9.1 |
|
37 | + */ |
|
38 | + public function validateOperation($name, array $checks, $operation); |
|
39 | 39 | } |
@@ -31,26 +31,26 @@ |
||
31 | 31 | * @since 9.1 |
32 | 32 | */ |
33 | 33 | interface ICheck { |
34 | - /** |
|
35 | - * @param IStorage $storage |
|
36 | - * @param string $path |
|
37 | - * @since 9.1 |
|
38 | - */ |
|
39 | - public function setFileInfo(IStorage $storage, $path); |
|
34 | + /** |
|
35 | + * @param IStorage $storage |
|
36 | + * @param string $path |
|
37 | + * @since 9.1 |
|
38 | + */ |
|
39 | + public function setFileInfo(IStorage $storage, $path); |
|
40 | 40 | |
41 | - /** |
|
42 | - * @param string $operator |
|
43 | - * @param string $value |
|
44 | - * @return bool |
|
45 | - * @since 9.1 |
|
46 | - */ |
|
47 | - public function executeCheck($operator, $value); |
|
41 | + /** |
|
42 | + * @param string $operator |
|
43 | + * @param string $value |
|
44 | + * @return bool |
|
45 | + * @since 9.1 |
|
46 | + */ |
|
47 | + public function executeCheck($operator, $value); |
|
48 | 48 | |
49 | - /** |
|
50 | - * @param string $operator |
|
51 | - * @param string $value |
|
52 | - * @throws \UnexpectedValueException |
|
53 | - * @since 9.1 |
|
54 | - */ |
|
55 | - public function validateCheck($operator, $value); |
|
49 | + /** |
|
50 | + * @param string $operator |
|
51 | + * @param string $value |
|
52 | + * @throws \UnexpectedValueException |
|
53 | + * @since 9.1 |
|
54 | + */ |
|
55 | + public function validateCheck($operator, $value); |
|
56 | 56 | } |
@@ -36,92 +36,92 @@ |
||
36 | 36 | */ |
37 | 37 | interface IRouter { |
38 | 38 | |
39 | - /** |
|
40 | - * Get the files to load the routes from |
|
41 | - * |
|
42 | - * @return string[] |
|
43 | - * @since 7.0.0 |
|
44 | - * @deprecated 9.0.0 |
|
45 | - */ |
|
46 | - public function getRoutingFiles(); |
|
39 | + /** |
|
40 | + * Get the files to load the routes from |
|
41 | + * |
|
42 | + * @return string[] |
|
43 | + * @since 7.0.0 |
|
44 | + * @deprecated 9.0.0 |
|
45 | + */ |
|
46 | + public function getRoutingFiles(); |
|
47 | 47 | |
48 | - /** |
|
49 | - * @return string |
|
50 | - * @since 7.0.0 |
|
51 | - * @deprecated 9.0.0 |
|
52 | - */ |
|
53 | - public function getCacheKey(); |
|
48 | + /** |
|
49 | + * @return string |
|
50 | + * @since 7.0.0 |
|
51 | + * @deprecated 9.0.0 |
|
52 | + */ |
|
53 | + public function getCacheKey(); |
|
54 | 54 | |
55 | - /** |
|
56 | - * Loads the routes |
|
57 | - * |
|
58 | - * @param null|string $app |
|
59 | - * @since 7.0.0 |
|
60 | - * @deprecated 9.0.0 |
|
61 | - */ |
|
62 | - public function loadRoutes($app = null); |
|
55 | + /** |
|
56 | + * Loads the routes |
|
57 | + * |
|
58 | + * @param null|string $app |
|
59 | + * @since 7.0.0 |
|
60 | + * @deprecated 9.0.0 |
|
61 | + */ |
|
62 | + public function loadRoutes($app = null); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Sets the collection to use for adding routes |
|
66 | - * |
|
67 | - * @param string $name Name of the collection to use. |
|
68 | - * @return void |
|
69 | - * @since 7.0.0 |
|
70 | - * @deprecated 9.0.0 |
|
71 | - */ |
|
72 | - public function useCollection($name); |
|
64 | + /** |
|
65 | + * Sets the collection to use for adding routes |
|
66 | + * |
|
67 | + * @param string $name Name of the collection to use. |
|
68 | + * @return void |
|
69 | + * @since 7.0.0 |
|
70 | + * @deprecated 9.0.0 |
|
71 | + */ |
|
72 | + public function useCollection($name); |
|
73 | 73 | |
74 | - /** |
|
75 | - * returns the current collection name in use for adding routes |
|
76 | - * |
|
77 | - * @return string the collection name |
|
78 | - * @since 8.0.0 |
|
79 | - * @deprecated 9.0.0 |
|
80 | - */ |
|
81 | - public function getCurrentCollection(); |
|
74 | + /** |
|
75 | + * returns the current collection name in use for adding routes |
|
76 | + * |
|
77 | + * @return string the collection name |
|
78 | + * @since 8.0.0 |
|
79 | + * @deprecated 9.0.0 |
|
80 | + */ |
|
81 | + public function getCurrentCollection(); |
|
82 | 82 | |
83 | - /** |
|
84 | - * Create a \OCP\Route\IRoute. |
|
85 | - * |
|
86 | - * @param string $name Name of the route to create. |
|
87 | - * @param string $pattern The pattern to match |
|
88 | - * @param array $defaults An array of default parameter values |
|
89 | - * @param array $requirements An array of requirements for parameters (regexes) |
|
90 | - * @return \OCP\Route\IRoute |
|
91 | - * @since 7.0.0 |
|
92 | - * @deprecated 9.0.0 |
|
93 | - */ |
|
94 | - public function create($name, $pattern, array $defaults = array(), array $requirements = array()); |
|
83 | + /** |
|
84 | + * Create a \OCP\Route\IRoute. |
|
85 | + * |
|
86 | + * @param string $name Name of the route to create. |
|
87 | + * @param string $pattern The pattern to match |
|
88 | + * @param array $defaults An array of default parameter values |
|
89 | + * @param array $requirements An array of requirements for parameters (regexes) |
|
90 | + * @return \OCP\Route\IRoute |
|
91 | + * @since 7.0.0 |
|
92 | + * @deprecated 9.0.0 |
|
93 | + */ |
|
94 | + public function create($name, $pattern, array $defaults = array(), array $requirements = array()); |
|
95 | 95 | |
96 | - /** |
|
97 | - * Find the route matching $url. |
|
98 | - * |
|
99 | - * @param string $url The url to find |
|
100 | - * @throws \Exception |
|
101 | - * @return void |
|
102 | - * @since 7.0.0 |
|
103 | - * @deprecated 9.0.0 |
|
104 | - */ |
|
105 | - public function match($url); |
|
96 | + /** |
|
97 | + * Find the route matching $url. |
|
98 | + * |
|
99 | + * @param string $url The url to find |
|
100 | + * @throws \Exception |
|
101 | + * @return void |
|
102 | + * @since 7.0.0 |
|
103 | + * @deprecated 9.0.0 |
|
104 | + */ |
|
105 | + public function match($url); |
|
106 | 106 | |
107 | - /** |
|
108 | - * Get the url generator |
|
109 | - * |
|
110 | - * @since 7.0.0 |
|
111 | - * @deprecated 9.0.0 |
|
112 | - */ |
|
113 | - public function getGenerator(); |
|
107 | + /** |
|
108 | + * Get the url generator |
|
109 | + * |
|
110 | + * @since 7.0.0 |
|
111 | + * @deprecated 9.0.0 |
|
112 | + */ |
|
113 | + public function getGenerator(); |
|
114 | 114 | |
115 | - /** |
|
116 | - * Generate url based on $name and $parameters |
|
117 | - * |
|
118 | - * @param string $name Name of the route to use. |
|
119 | - * @param array $parameters Parameters for the route |
|
120 | - * @param bool $absolute |
|
121 | - * @return string |
|
122 | - * @since 7.0.0 |
|
123 | - * @deprecated 9.0.0 |
|
124 | - */ |
|
125 | - public function generate($name, $parameters = array(), $absolute = false); |
|
115 | + /** |
|
116 | + * Generate url based on $name and $parameters |
|
117 | + * |
|
118 | + * @param string $name Name of the route to use. |
|
119 | + * @param array $parameters Parameters for the route |
|
120 | + * @param bool $absolute |
|
121 | + * @return string |
|
122 | + * @since 7.0.0 |
|
123 | + * @deprecated 9.0.0 |
|
124 | + */ |
|
125 | + public function generate($name, $parameters = array(), $absolute = false); |
|
126 | 126 | |
127 | 127 | } |