@@ -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,37 +29,37 @@ |
||
29 | 29 | * @since 9.0.0 |
30 | 30 | */ |
31 | 31 | interface IManager extends IApp, INotifier { |
32 | - /** |
|
33 | - * @param \Closure $service The service must implement IApp, otherwise a |
|
34 | - * \InvalidArgumentException is thrown later |
|
35 | - * @since 9.0.0 |
|
36 | - */ |
|
37 | - public function registerApp(\Closure $service); |
|
32 | + /** |
|
33 | + * @param \Closure $service The service must implement IApp, otherwise a |
|
34 | + * \InvalidArgumentException is thrown later |
|
35 | + * @since 9.0.0 |
|
36 | + */ |
|
37 | + public function registerApp(\Closure $service); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @param \Closure $service The service must implement INotifier, otherwise a |
|
41 | - * \InvalidArgumentException is thrown later |
|
42 | - * @param \Closure $info An array with the keys 'id' and 'name' containing |
|
43 | - * the app id and the app name |
|
44 | - * @since 9.0.0 |
|
45 | - */ |
|
46 | - public function registerNotifier(\Closure $service, \Closure $info); |
|
39 | + /** |
|
40 | + * @param \Closure $service The service must implement INotifier, otherwise a |
|
41 | + * \InvalidArgumentException is thrown later |
|
42 | + * @param \Closure $info An array with the keys 'id' and 'name' containing |
|
43 | + * the app id and the app name |
|
44 | + * @since 9.0.0 |
|
45 | + */ |
|
46 | + public function registerNotifier(\Closure $service, \Closure $info); |
|
47 | 47 | |
48 | - /** |
|
49 | - * @return array App ID => App Name |
|
50 | - * @since 9.0.0 |
|
51 | - */ |
|
52 | - public function listNotifiers(); |
|
48 | + /** |
|
49 | + * @return array App ID => App Name |
|
50 | + * @since 9.0.0 |
|
51 | + */ |
|
52 | + public function listNotifiers(); |
|
53 | 53 | |
54 | - /** |
|
55 | - * @return INotification |
|
56 | - * @since 9.0.0 |
|
57 | - */ |
|
58 | - public function createNotification(); |
|
54 | + /** |
|
55 | + * @return INotification |
|
56 | + * @since 9.0.0 |
|
57 | + */ |
|
58 | + public function createNotification(); |
|
59 | 59 | |
60 | - /** |
|
61 | - * @return bool |
|
62 | - * @since 9.0.0 |
|
63 | - */ |
|
64 | - public function hasNotifiers(); |
|
60 | + /** |
|
61 | + * @return bool |
|
62 | + * @since 9.0.0 |
|
63 | + */ |
|
64 | + public function hasNotifiers(); |
|
65 | 65 | } |
@@ -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 | } |
@@ -38,11 +38,11 @@ |
||
38 | 38 | */ |
39 | 39 | interface IUserBackend { |
40 | 40 | |
41 | - /** |
|
42 | - * Backend name to be shown in user management |
|
43 | - * @return string the name of the backend to be shown |
|
44 | - * @since 8.0.0 |
|
45 | - */ |
|
46 | - public function getBackendName(); |
|
41 | + /** |
|
42 | + * Backend name to be shown in user management |
|
43 | + * @return string the name of the backend to be shown |
|
44 | + * @since 8.0.0 |
|
45 | + */ |
|
46 | + public function getBackendName(); |
|
47 | 47 | |
48 | 48 | } |