@@ -38,45 +38,45 @@ |
||
38 | 38 | */ |
39 | 39 | interface ICache { |
40 | 40 | |
41 | - /** |
|
42 | - * Get a value from the user cache |
|
43 | - * @param string $key |
|
44 | - * @return mixed |
|
45 | - * @since 6.0.0 |
|
46 | - */ |
|
47 | - public function get($key); |
|
41 | + /** |
|
42 | + * Get a value from the user cache |
|
43 | + * @param string $key |
|
44 | + * @return mixed |
|
45 | + * @since 6.0.0 |
|
46 | + */ |
|
47 | + public function get($key); |
|
48 | 48 | |
49 | - /** |
|
50 | - * Set a value in the user cache |
|
51 | - * @param string $key |
|
52 | - * @param mixed $value |
|
53 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
54 | - * @return bool |
|
55 | - * @since 6.0.0 |
|
56 | - */ |
|
57 | - public function set($key, $value, $ttl = 0); |
|
49 | + /** |
|
50 | + * Set a value in the user cache |
|
51 | + * @param string $key |
|
52 | + * @param mixed $value |
|
53 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
54 | + * @return bool |
|
55 | + * @since 6.0.0 |
|
56 | + */ |
|
57 | + public function set($key, $value, $ttl = 0); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Check if a value is set in the user cache |
|
61 | - * @param string $key |
|
62 | - * @return bool |
|
63 | - * @since 6.0.0 |
|
64 | - */ |
|
65 | - public function hasKey($key); |
|
59 | + /** |
|
60 | + * Check if a value is set in the user cache |
|
61 | + * @param string $key |
|
62 | + * @return bool |
|
63 | + * @since 6.0.0 |
|
64 | + */ |
|
65 | + public function hasKey($key); |
|
66 | 66 | |
67 | - /** |
|
68 | - * Remove an item from the user cache |
|
69 | - * @param string $key |
|
70 | - * @return bool |
|
71 | - * @since 6.0.0 |
|
72 | - */ |
|
73 | - public function remove($key); |
|
67 | + /** |
|
68 | + * Remove an item from the user cache |
|
69 | + * @param string $key |
|
70 | + * @return bool |
|
71 | + * @since 6.0.0 |
|
72 | + */ |
|
73 | + public function remove($key); |
|
74 | 74 | |
75 | - /** |
|
76 | - * Clear the user cache of all entries starting with a prefix |
|
77 | - * @param string $prefix (optional) |
|
78 | - * @return bool |
|
79 | - * @since 6.0.0 |
|
80 | - */ |
|
81 | - public function clear($prefix = ''); |
|
75 | + /** |
|
76 | + * Clear the user cache of all entries starting with a prefix |
|
77 | + * @param string $prefix (optional) |
|
78 | + * @return bool |
|
79 | + * @since 6.0.0 |
|
80 | + */ |
|
81 | + public function clear($prefix = ''); |
|
82 | 82 | } |
@@ -41,59 +41,59 @@ |
||
41 | 41 | */ |
42 | 42 | interface ISession { |
43 | 43 | |
44 | - /** |
|
45 | - * Set a value in the session |
|
46 | - * |
|
47 | - * @param string $key |
|
48 | - * @param mixed $value |
|
49 | - * @since 6.0.0 |
|
50 | - */ |
|
51 | - public function set($key, $value); |
|
44 | + /** |
|
45 | + * Set a value in the session |
|
46 | + * |
|
47 | + * @param string $key |
|
48 | + * @param mixed $value |
|
49 | + * @since 6.0.0 |
|
50 | + */ |
|
51 | + public function set($key, $value); |
|
52 | 52 | |
53 | - /** |
|
54 | - * Get a value from the session |
|
55 | - * |
|
56 | - * @param string $key |
|
57 | - * @return mixed should return null if $key does not exist |
|
58 | - * @since 6.0.0 |
|
59 | - */ |
|
60 | - public function get($key); |
|
53 | + /** |
|
54 | + * Get a value from the session |
|
55 | + * |
|
56 | + * @param string $key |
|
57 | + * @return mixed should return null if $key does not exist |
|
58 | + * @since 6.0.0 |
|
59 | + */ |
|
60 | + public function get($key); |
|
61 | 61 | |
62 | - /** |
|
63 | - * Check if a named key exists in the session |
|
64 | - * |
|
65 | - * @param string $key |
|
66 | - * @return bool |
|
67 | - * @since 6.0.0 |
|
68 | - */ |
|
69 | - public function exists($key); |
|
62 | + /** |
|
63 | + * Check if a named key exists in the session |
|
64 | + * |
|
65 | + * @param string $key |
|
66 | + * @return bool |
|
67 | + * @since 6.0.0 |
|
68 | + */ |
|
69 | + public function exists($key); |
|
70 | 70 | |
71 | - /** |
|
72 | - * Remove a $key/$value pair from the session |
|
73 | - * |
|
74 | - * @param string $key |
|
75 | - * @since 6.0.0 |
|
76 | - */ |
|
77 | - public function remove($key); |
|
71 | + /** |
|
72 | + * Remove a $key/$value pair from the session |
|
73 | + * |
|
74 | + * @param string $key |
|
75 | + * @since 6.0.0 |
|
76 | + */ |
|
77 | + public function remove($key); |
|
78 | 78 | |
79 | - /** |
|
80 | - * Reset and recreate the session |
|
81 | - * @since 6.0.0 |
|
82 | - */ |
|
83 | - public function clear(); |
|
79 | + /** |
|
80 | + * Reset and recreate the session |
|
81 | + * @since 6.0.0 |
|
82 | + */ |
|
83 | + public function clear(); |
|
84 | 84 | |
85 | - /** |
|
86 | - * Close the session and release the lock |
|
87 | - * @since 7.0.0 |
|
88 | - */ |
|
89 | - public function close(); |
|
85 | + /** |
|
86 | + * Close the session and release the lock |
|
87 | + * @since 7.0.0 |
|
88 | + */ |
|
89 | + public function close(); |
|
90 | 90 | |
91 | - /** |
|
92 | - * Wrapper around session_regenerate_id |
|
93 | - * |
|
94 | - * @param bool $deleteOldSession Whether to delete the old associated session file or not. |
|
95 | - * @return void |
|
96 | - * @since 9.0.0 |
|
97 | - */ |
|
98 | - public function regenerateId($deleteOldSession = true); |
|
91 | + /** |
|
92 | + * Wrapper around session_regenerate_id |
|
93 | + * |
|
94 | + * @param bool $deleteOldSession Whether to delete the old associated session file or not. |
|
95 | + * @return void |
|
96 | + * @since 9.0.0 |
|
97 | + */ |
|
98 | + public function regenerateId($deleteOldSession = true); |
|
99 | 99 | } |
@@ -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 | } |
@@ -29,25 +29,25 @@ |
||
29 | 29 | * @since 9.0.0 |
30 | 30 | */ |
31 | 31 | interface IApp { |
32 | - /** |
|
33 | - * @param INotification $notification |
|
34 | - * @return null |
|
35 | - * @throws \InvalidArgumentException When the notification is not valid |
|
36 | - * @since 9.0.0 |
|
37 | - */ |
|
38 | - public function notify(INotification $notification); |
|
32 | + /** |
|
33 | + * @param INotification $notification |
|
34 | + * @return null |
|
35 | + * @throws \InvalidArgumentException When the notification is not valid |
|
36 | + * @since 9.0.0 |
|
37 | + */ |
|
38 | + public function notify(INotification $notification); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @param INotification $notification |
|
42 | - * @return null |
|
43 | - * @since 9.0.0 |
|
44 | - */ |
|
45 | - public function markProcessed(INotification $notification); |
|
40 | + /** |
|
41 | + * @param INotification $notification |
|
42 | + * @return null |
|
43 | + * @since 9.0.0 |
|
44 | + */ |
|
45 | + public function markProcessed(INotification $notification); |
|
46 | 46 | |
47 | - /** |
|
48 | - * @param INotification $notification |
|
49 | - * @return int |
|
50 | - * @since 9.0.0 |
|
51 | - */ |
|
52 | - public function getCount(INotification $notification); |
|
47 | + /** |
|
48 | + * @param INotification $notification |
|
49 | + * @return int |
|
50 | + * @since 9.0.0 |
|
51 | + */ |
|
52 | + public function getCount(INotification $notification); |
|
53 | 53 | } |
@@ -29,39 +29,39 @@ |
||
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 | - * @return null |
|
36 | - * @since 9.0.0 |
|
37 | - */ |
|
38 | - public function registerApp(\Closure $service); |
|
32 | + /** |
|
33 | + * @param \Closure $service The service must implement IApp, otherwise a |
|
34 | + * \InvalidArgumentException is thrown later |
|
35 | + * @return null |
|
36 | + * @since 9.0.0 |
|
37 | + */ |
|
38 | + public function registerApp(\Closure $service); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @param \Closure $service The service must implement INotifier, otherwise a |
|
42 | - * \InvalidArgumentException is thrown later |
|
43 | - * @param \Closure $info An array with the keys 'id' and 'name' containing |
|
44 | - * the app id and the app name |
|
45 | - * @return null |
|
46 | - * @since 9.0.0 |
|
47 | - */ |
|
48 | - public function registerNotifier(\Closure $service, \Closure $info); |
|
40 | + /** |
|
41 | + * @param \Closure $service The service must implement INotifier, otherwise a |
|
42 | + * \InvalidArgumentException is thrown later |
|
43 | + * @param \Closure $info An array with the keys 'id' and 'name' containing |
|
44 | + * the app id and the app name |
|
45 | + * @return null |
|
46 | + * @since 9.0.0 |
|
47 | + */ |
|
48 | + public function registerNotifier(\Closure $service, \Closure $info); |
|
49 | 49 | |
50 | - /** |
|
51 | - * @return array App ID => App Name |
|
52 | - * @since 9.0.0 |
|
53 | - */ |
|
54 | - public function listNotifiers(); |
|
50 | + /** |
|
51 | + * @return array App ID => App Name |
|
52 | + * @since 9.0.0 |
|
53 | + */ |
|
54 | + public function listNotifiers(); |
|
55 | 55 | |
56 | - /** |
|
57 | - * @return INotification |
|
58 | - * @since 9.0.0 |
|
59 | - */ |
|
60 | - public function createNotification(); |
|
56 | + /** |
|
57 | + * @return INotification |
|
58 | + * @since 9.0.0 |
|
59 | + */ |
|
60 | + public function createNotification(); |
|
61 | 61 | |
62 | - /** |
|
63 | - * @return bool |
|
64 | - * @since 9.0.0 |
|
65 | - */ |
|
66 | - public function hasNotifiers(); |
|
62 | + /** |
|
63 | + * @return bool |
|
64 | + * @since 9.0.0 |
|
65 | + */ |
|
66 | + public function hasNotifiers(); |
|
67 | 67 | } |
@@ -29,196 +29,196 @@ |
||
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 are 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 are 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 are 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 $message |
|
132 | - * @param array $parameters |
|
133 | - * @return $this |
|
134 | - * @throws \InvalidArgumentException if the message or parameters are invalid |
|
135 | - * @since 9.0.0 |
|
136 | - */ |
|
137 | - public function setMessage($message, array $parameters = []); |
|
138 | - |
|
139 | - /** |
|
140 | - * @return string |
|
141 | - * @since 9.0.0 |
|
142 | - */ |
|
143 | - public function getMessage(); |
|
144 | - |
|
145 | - /** |
|
146 | - * @return string[] |
|
147 | - * @since 9.0.0 |
|
148 | - */ |
|
149 | - public function getMessageParameters(); |
|
150 | - |
|
151 | - /** |
|
152 | - * @param string $message |
|
153 | - * @return $this |
|
154 | - * @throws \InvalidArgumentException if the message are invalid |
|
155 | - * @since 9.0.0 |
|
156 | - */ |
|
157 | - public function setParsedMessage($message); |
|
158 | - |
|
159 | - /** |
|
160 | - * @return string |
|
161 | - * @since 9.0.0 |
|
162 | - */ |
|
163 | - public function getParsedMessage(); |
|
164 | - |
|
165 | - /** |
|
166 | - * @param string $link |
|
167 | - * @return $this |
|
168 | - * @throws \InvalidArgumentException if the link are invalid |
|
169 | - * @since 9.0.0 |
|
170 | - */ |
|
171 | - public function setLink($link); |
|
172 | - |
|
173 | - /** |
|
174 | - * @return string |
|
175 | - * @since 9.0.0 |
|
176 | - */ |
|
177 | - public function getLink(); |
|
178 | - |
|
179 | - /** |
|
180 | - * @return IAction |
|
181 | - * @since 9.0.0 |
|
182 | - */ |
|
183 | - public function createAction(); |
|
184 | - |
|
185 | - /** |
|
186 | - * @param IAction $action |
|
187 | - * @return $this |
|
188 | - * @throws \InvalidArgumentException if the action are invalid |
|
189 | - * @since 9.0.0 |
|
190 | - */ |
|
191 | - public function addAction(IAction $action); |
|
192 | - |
|
193 | - /** |
|
194 | - * @return IAction[] |
|
195 | - * @since 9.0.0 |
|
196 | - */ |
|
197 | - public function getActions(); |
|
198 | - |
|
199 | - /** |
|
200 | - * @param IAction $action |
|
201 | - * @return $this |
|
202 | - * @throws \InvalidArgumentException if the action are invalid |
|
203 | - * @since 9.0.0 |
|
204 | - */ |
|
205 | - public function addParsedAction(IAction $action); |
|
206 | - |
|
207 | - /** |
|
208 | - * @return IAction[] |
|
209 | - * @since 9.0.0 |
|
210 | - */ |
|
211 | - public function getParsedActions(); |
|
212 | - |
|
213 | - /** |
|
214 | - * @return bool |
|
215 | - * @since 9.0.0 |
|
216 | - */ |
|
217 | - public function isValid(); |
|
218 | - |
|
219 | - /** |
|
220 | - * @return bool |
|
221 | - * @since 9.0.0 |
|
222 | - */ |
|
223 | - public function isValidParsed(); |
|
32 | + /** |
|
33 | + * @param string $app |
|
34 | + * @return $this |
|
35 | + * @throws \InvalidArgumentException if the app id are 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 are 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 are 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 $message |
|
132 | + * @param array $parameters |
|
133 | + * @return $this |
|
134 | + * @throws \InvalidArgumentException if the message or parameters are invalid |
|
135 | + * @since 9.0.0 |
|
136 | + */ |
|
137 | + public function setMessage($message, array $parameters = []); |
|
138 | + |
|
139 | + /** |
|
140 | + * @return string |
|
141 | + * @since 9.0.0 |
|
142 | + */ |
|
143 | + public function getMessage(); |
|
144 | + |
|
145 | + /** |
|
146 | + * @return string[] |
|
147 | + * @since 9.0.0 |
|
148 | + */ |
|
149 | + public function getMessageParameters(); |
|
150 | + |
|
151 | + /** |
|
152 | + * @param string $message |
|
153 | + * @return $this |
|
154 | + * @throws \InvalidArgumentException if the message are invalid |
|
155 | + * @since 9.0.0 |
|
156 | + */ |
|
157 | + public function setParsedMessage($message); |
|
158 | + |
|
159 | + /** |
|
160 | + * @return string |
|
161 | + * @since 9.0.0 |
|
162 | + */ |
|
163 | + public function getParsedMessage(); |
|
164 | + |
|
165 | + /** |
|
166 | + * @param string $link |
|
167 | + * @return $this |
|
168 | + * @throws \InvalidArgumentException if the link are invalid |
|
169 | + * @since 9.0.0 |
|
170 | + */ |
|
171 | + public function setLink($link); |
|
172 | + |
|
173 | + /** |
|
174 | + * @return string |
|
175 | + * @since 9.0.0 |
|
176 | + */ |
|
177 | + public function getLink(); |
|
178 | + |
|
179 | + /** |
|
180 | + * @return IAction |
|
181 | + * @since 9.0.0 |
|
182 | + */ |
|
183 | + public function createAction(); |
|
184 | + |
|
185 | + /** |
|
186 | + * @param IAction $action |
|
187 | + * @return $this |
|
188 | + * @throws \InvalidArgumentException if the action are invalid |
|
189 | + * @since 9.0.0 |
|
190 | + */ |
|
191 | + public function addAction(IAction $action); |
|
192 | + |
|
193 | + /** |
|
194 | + * @return IAction[] |
|
195 | + * @since 9.0.0 |
|
196 | + */ |
|
197 | + public function getActions(); |
|
198 | + |
|
199 | + /** |
|
200 | + * @param IAction $action |
|
201 | + * @return $this |
|
202 | + * @throws \InvalidArgumentException if the action are invalid |
|
203 | + * @since 9.0.0 |
|
204 | + */ |
|
205 | + public function addParsedAction(IAction $action); |
|
206 | + |
|
207 | + /** |
|
208 | + * @return IAction[] |
|
209 | + * @since 9.0.0 |
|
210 | + */ |
|
211 | + public function getParsedActions(); |
|
212 | + |
|
213 | + /** |
|
214 | + * @return bool |
|
215 | + * @since 9.0.0 |
|
216 | + */ |
|
217 | + public function isValid(); |
|
218 | + |
|
219 | + /** |
|
220 | + * @return bool |
|
221 | + * @since 9.0.0 |
|
222 | + */ |
|
223 | + public function isValidParsed(); |
|
224 | 224 | } |
@@ -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 | } |
@@ -35,46 +35,46 @@ |
||
35 | 35 | */ |
36 | 36 | interface IAvatar { |
37 | 37 | |
38 | - /** |
|
39 | - * get the users avatar |
|
40 | - * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image |
|
41 | - * @return boolean|\OCP\IImage containing the avatar or false if there's no image |
|
42 | - * @since 6.0.0 - size of -1 was added in 9.0.0 |
|
43 | - */ |
|
44 | - public function get($size = 64); |
|
38 | + /** |
|
39 | + * get the users avatar |
|
40 | + * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image |
|
41 | + * @return boolean|\OCP\IImage containing the avatar or false if there's no image |
|
42 | + * @since 6.0.0 - size of -1 was added in 9.0.0 |
|
43 | + */ |
|
44 | + public function get($size = 64); |
|
45 | 45 | |
46 | - /** |
|
47 | - * Check if an avatar exists for the user |
|
48 | - * |
|
49 | - * @return bool |
|
50 | - * @since 8.1.0 |
|
51 | - */ |
|
52 | - public function exists(); |
|
46 | + /** |
|
47 | + * Check if an avatar exists for the user |
|
48 | + * |
|
49 | + * @return bool |
|
50 | + * @since 8.1.0 |
|
51 | + */ |
|
52 | + public function exists(); |
|
53 | 53 | |
54 | - /** |
|
55 | - * sets the users avatar |
|
56 | - * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar |
|
57 | - * @throws \Exception if the provided file is not a jpg or png image |
|
58 | - * @throws \Exception if the provided image is not valid |
|
59 | - * @throws \OC\NotSquareException if the image is not square |
|
60 | - * @return void |
|
61 | - * @since 6.0.0 |
|
62 | - */ |
|
63 | - public function set($data); |
|
54 | + /** |
|
55 | + * sets the users avatar |
|
56 | + * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar |
|
57 | + * @throws \Exception if the provided file is not a jpg or png image |
|
58 | + * @throws \Exception if the provided image is not valid |
|
59 | + * @throws \OC\NotSquareException if the image is not square |
|
60 | + * @return void |
|
61 | + * @since 6.0.0 |
|
62 | + */ |
|
63 | + public function set($data); |
|
64 | 64 | |
65 | - /** |
|
66 | - * remove the users avatar |
|
67 | - * @return void |
|
68 | - * @since 6.0.0 |
|
69 | - */ |
|
70 | - public function remove(); |
|
65 | + /** |
|
66 | + * remove the users avatar |
|
67 | + * @return void |
|
68 | + * @since 6.0.0 |
|
69 | + */ |
|
70 | + public function remove(); |
|
71 | 71 | |
72 | - /** |
|
73 | - * Get the file of the avatar |
|
74 | - * @param int $size -1 can be used to not scale the image |
|
75 | - * @return File |
|
76 | - * @throws NotFoundException |
|
77 | - * @since 9.0.0 |
|
78 | - */ |
|
79 | - public function getFile($size); |
|
72 | + /** |
|
73 | + * Get the file of the avatar |
|
74 | + * @param int $size -1 can be used to not scale the image |
|
75 | + * @return File |
|
76 | + * @throws NotFoundException |
|
77 | + * @since 9.0.0 |
|
78 | + */ |
|
79 | + public function getFile($size); |
|
80 | 80 | } |
@@ -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 | } |