@@ -34,170 +34,170 @@ |
||
34 | 34 | */ |
35 | 35 | interface IUser { |
36 | 36 | |
37 | - /** |
|
38 | - * get the user id |
|
39 | - * |
|
40 | - * @return string |
|
41 | - * @since 8.0.0 |
|
42 | - */ |
|
43 | - public function getUID(); |
|
44 | - |
|
45 | - /** |
|
46 | - * get the display name for the user, if no specific display name is set it will fallback to the user id |
|
47 | - * |
|
48 | - * @return string |
|
49 | - * @since 8.0.0 |
|
50 | - */ |
|
51 | - public function getDisplayName(); |
|
52 | - |
|
53 | - /** |
|
54 | - * set the display name for the user |
|
55 | - * |
|
56 | - * @param string $displayName |
|
57 | - * @return bool |
|
58 | - * @since 8.0.0 |
|
59 | - */ |
|
60 | - public function setDisplayName($displayName); |
|
61 | - |
|
62 | - /** |
|
63 | - * returns the timestamp of the user's last login or 0 if the user did never |
|
64 | - * login |
|
65 | - * |
|
66 | - * @return int |
|
67 | - * @since 8.0.0 |
|
68 | - */ |
|
69 | - public function getLastLogin(); |
|
70 | - |
|
71 | - /** |
|
72 | - * updates the timestamp of the most recent login of this user |
|
73 | - * @since 8.0.0 |
|
74 | - */ |
|
75 | - public function updateLastLoginTimestamp(); |
|
76 | - |
|
77 | - /** |
|
78 | - * Delete the user |
|
79 | - * |
|
80 | - * @return bool |
|
81 | - * @since 8.0.0 |
|
82 | - */ |
|
83 | - public function delete(); |
|
84 | - |
|
85 | - /** |
|
86 | - * Set the password of the user |
|
87 | - * |
|
88 | - * @param string $password |
|
89 | - * @param string $recoveryPassword for the encryption app to reset encryption keys |
|
90 | - * @return bool |
|
91 | - * @since 8.0.0 |
|
92 | - */ |
|
93 | - public function setPassword($password, $recoveryPassword = null); |
|
94 | - |
|
95 | - /** |
|
96 | - * get the users home folder to mount |
|
97 | - * |
|
98 | - * @return string |
|
99 | - * @since 8.0.0 |
|
100 | - */ |
|
101 | - public function getHome(); |
|
102 | - |
|
103 | - /** |
|
104 | - * Get the name of the backend class the user is connected with |
|
105 | - * |
|
106 | - * @return string |
|
107 | - * @since 8.0.0 |
|
108 | - */ |
|
109 | - public function getBackendClassName(); |
|
110 | - |
|
111 | - /** |
|
112 | - * check if the backend allows the user to change his avatar on Personal page |
|
113 | - * |
|
114 | - * @return bool |
|
115 | - * @since 8.0.0 |
|
116 | - */ |
|
117 | - public function canChangeAvatar(); |
|
118 | - |
|
119 | - /** |
|
120 | - * check if the backend supports changing passwords |
|
121 | - * |
|
122 | - * @return bool |
|
123 | - * @since 8.0.0 |
|
124 | - */ |
|
125 | - public function canChangePassword(); |
|
126 | - |
|
127 | - /** |
|
128 | - * check if the backend supports changing display names |
|
129 | - * |
|
130 | - * @return bool |
|
131 | - * @since 8.0.0 |
|
132 | - */ |
|
133 | - public function canChangeDisplayName(); |
|
134 | - |
|
135 | - /** |
|
136 | - * check if the user is enabled |
|
137 | - * |
|
138 | - * @return bool |
|
139 | - * @since 8.0.0 |
|
140 | - */ |
|
141 | - public function isEnabled(); |
|
142 | - |
|
143 | - /** |
|
144 | - * set the enabled status for the user |
|
145 | - * |
|
146 | - * @param bool $enabled |
|
147 | - * @since 8.0.0 |
|
148 | - */ |
|
149 | - public function setEnabled($enabled); |
|
150 | - |
|
151 | - /** |
|
152 | - * get the users email address |
|
153 | - * |
|
154 | - * @return string|null |
|
155 | - * @since 9.0.0 |
|
156 | - */ |
|
157 | - public function getEMailAddress(); |
|
158 | - |
|
159 | - /** |
|
160 | - * get the avatar image if it exists |
|
161 | - * |
|
162 | - * @param int $size |
|
163 | - * @return IImage|null |
|
164 | - * @since 9.0.0 |
|
165 | - */ |
|
166 | - public function getAvatarImage($size); |
|
167 | - |
|
168 | - /** |
|
169 | - * get the federation cloud id |
|
170 | - * |
|
171 | - * @return string |
|
172 | - * @since 9.0.0 |
|
173 | - */ |
|
174 | - public function getCloudId(); |
|
175 | - |
|
176 | - /** |
|
177 | - * set the email address of the user |
|
178 | - * |
|
179 | - * @param string|null $mailAddress |
|
180 | - * @return void |
|
181 | - * @since 9.0.0 |
|
182 | - */ |
|
183 | - public function setEMailAddress($mailAddress); |
|
184 | - |
|
185 | - /** |
|
186 | - * get the users' quota in human readable form. If a specific quota is not |
|
187 | - * set for the user, the default value is returned. If a default setting |
|
188 | - * was not set otherwise, it is return as 'none', i.e. quota is not limited. |
|
189 | - * |
|
190 | - * @return string |
|
191 | - * @since 9.0.0 |
|
192 | - */ |
|
193 | - public function getQuota(); |
|
194 | - |
|
195 | - /** |
|
196 | - * set the users' quota |
|
197 | - * |
|
198 | - * @param string $quota |
|
199 | - * @return void |
|
200 | - * @since 9.0.0 |
|
201 | - */ |
|
202 | - public function setQuota($quota); |
|
37 | + /** |
|
38 | + * get the user id |
|
39 | + * |
|
40 | + * @return string |
|
41 | + * @since 8.0.0 |
|
42 | + */ |
|
43 | + public function getUID(); |
|
44 | + |
|
45 | + /** |
|
46 | + * get the display name for the user, if no specific display name is set it will fallback to the user id |
|
47 | + * |
|
48 | + * @return string |
|
49 | + * @since 8.0.0 |
|
50 | + */ |
|
51 | + public function getDisplayName(); |
|
52 | + |
|
53 | + /** |
|
54 | + * set the display name for the user |
|
55 | + * |
|
56 | + * @param string $displayName |
|
57 | + * @return bool |
|
58 | + * @since 8.0.0 |
|
59 | + */ |
|
60 | + public function setDisplayName($displayName); |
|
61 | + |
|
62 | + /** |
|
63 | + * returns the timestamp of the user's last login or 0 if the user did never |
|
64 | + * login |
|
65 | + * |
|
66 | + * @return int |
|
67 | + * @since 8.0.0 |
|
68 | + */ |
|
69 | + public function getLastLogin(); |
|
70 | + |
|
71 | + /** |
|
72 | + * updates the timestamp of the most recent login of this user |
|
73 | + * @since 8.0.0 |
|
74 | + */ |
|
75 | + public function updateLastLoginTimestamp(); |
|
76 | + |
|
77 | + /** |
|
78 | + * Delete the user |
|
79 | + * |
|
80 | + * @return bool |
|
81 | + * @since 8.0.0 |
|
82 | + */ |
|
83 | + public function delete(); |
|
84 | + |
|
85 | + /** |
|
86 | + * Set the password of the user |
|
87 | + * |
|
88 | + * @param string $password |
|
89 | + * @param string $recoveryPassword for the encryption app to reset encryption keys |
|
90 | + * @return bool |
|
91 | + * @since 8.0.0 |
|
92 | + */ |
|
93 | + public function setPassword($password, $recoveryPassword = null); |
|
94 | + |
|
95 | + /** |
|
96 | + * get the users home folder to mount |
|
97 | + * |
|
98 | + * @return string |
|
99 | + * @since 8.0.0 |
|
100 | + */ |
|
101 | + public function getHome(); |
|
102 | + |
|
103 | + /** |
|
104 | + * Get the name of the backend class the user is connected with |
|
105 | + * |
|
106 | + * @return string |
|
107 | + * @since 8.0.0 |
|
108 | + */ |
|
109 | + public function getBackendClassName(); |
|
110 | + |
|
111 | + /** |
|
112 | + * check if the backend allows the user to change his avatar on Personal page |
|
113 | + * |
|
114 | + * @return bool |
|
115 | + * @since 8.0.0 |
|
116 | + */ |
|
117 | + public function canChangeAvatar(); |
|
118 | + |
|
119 | + /** |
|
120 | + * check if the backend supports changing passwords |
|
121 | + * |
|
122 | + * @return bool |
|
123 | + * @since 8.0.0 |
|
124 | + */ |
|
125 | + public function canChangePassword(); |
|
126 | + |
|
127 | + /** |
|
128 | + * check if the backend supports changing display names |
|
129 | + * |
|
130 | + * @return bool |
|
131 | + * @since 8.0.0 |
|
132 | + */ |
|
133 | + public function canChangeDisplayName(); |
|
134 | + |
|
135 | + /** |
|
136 | + * check if the user is enabled |
|
137 | + * |
|
138 | + * @return bool |
|
139 | + * @since 8.0.0 |
|
140 | + */ |
|
141 | + public function isEnabled(); |
|
142 | + |
|
143 | + /** |
|
144 | + * set the enabled status for the user |
|
145 | + * |
|
146 | + * @param bool $enabled |
|
147 | + * @since 8.0.0 |
|
148 | + */ |
|
149 | + public function setEnabled($enabled); |
|
150 | + |
|
151 | + /** |
|
152 | + * get the users email address |
|
153 | + * |
|
154 | + * @return string|null |
|
155 | + * @since 9.0.0 |
|
156 | + */ |
|
157 | + public function getEMailAddress(); |
|
158 | + |
|
159 | + /** |
|
160 | + * get the avatar image if it exists |
|
161 | + * |
|
162 | + * @param int $size |
|
163 | + * @return IImage|null |
|
164 | + * @since 9.0.0 |
|
165 | + */ |
|
166 | + public function getAvatarImage($size); |
|
167 | + |
|
168 | + /** |
|
169 | + * get the federation cloud id |
|
170 | + * |
|
171 | + * @return string |
|
172 | + * @since 9.0.0 |
|
173 | + */ |
|
174 | + public function getCloudId(); |
|
175 | + |
|
176 | + /** |
|
177 | + * set the email address of the user |
|
178 | + * |
|
179 | + * @param string|null $mailAddress |
|
180 | + * @return void |
|
181 | + * @since 9.0.0 |
|
182 | + */ |
|
183 | + public function setEMailAddress($mailAddress); |
|
184 | + |
|
185 | + /** |
|
186 | + * get the users' quota in human readable form. If a specific quota is not |
|
187 | + * set for the user, the default value is returned. If a default setting |
|
188 | + * was not set otherwise, it is return as 'none', i.e. quota is not limited. |
|
189 | + * |
|
190 | + * @return string |
|
191 | + * @since 9.0.0 |
|
192 | + */ |
|
193 | + public function getQuota(); |
|
194 | + |
|
195 | + /** |
|
196 | + * set the users' quota |
|
197 | + * |
|
198 | + * @param string $quota |
|
199 | + * @return void |
|
200 | + * @since 9.0.0 |
|
201 | + */ |
|
202 | + public function setQuota($quota); |
|
203 | 203 | } |
@@ -36,12 +36,12 @@ |
||
36 | 36 | */ |
37 | 37 | interface ICapability { |
38 | 38 | |
39 | - /** |
|
40 | - * Function an app uses to return the capabilities |
|
41 | - * |
|
42 | - * @return array Array containing the apps capabilities |
|
43 | - * @since 8.2.0 |
|
44 | - */ |
|
45 | - public function getCapabilities(); |
|
39 | + /** |
|
40 | + * Function an app uses to return the capabilities |
|
41 | + * |
|
42 | + * @return array Array containing the apps capabilities |
|
43 | + * @since 8.2.0 |
|
44 | + */ |
|
45 | + public function getCapabilities(); |
|
46 | 46 | } |
47 | 47 |
@@ -28,22 +28,22 @@ |
||
28 | 28 | */ |
29 | 29 | interface IRepairStep { |
30 | 30 | |
31 | - /** |
|
32 | - * Returns the step's name |
|
33 | - * |
|
34 | - * @return string |
|
35 | - * @since 9.1.0 |
|
36 | - */ |
|
37 | - public function getName(); |
|
31 | + /** |
|
32 | + * Returns the step's name |
|
33 | + * |
|
34 | + * @return string |
|
35 | + * @since 9.1.0 |
|
36 | + */ |
|
37 | + public function getName(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * Run repair step. |
|
41 | - * Must throw exception on error. |
|
42 | - * |
|
43 | - * @param IOutput $output |
|
44 | - * @throws \Exception in case of failure |
|
45 | - * @since 9.1.0 |
|
46 | - */ |
|
47 | - public function run(IOutput $output); |
|
39 | + /** |
|
40 | + * Run repair step. |
|
41 | + * Must throw exception on error. |
|
42 | + * |
|
43 | + * @param IOutput $output |
|
44 | + * @throws \Exception in case of failure |
|
45 | + * @since 9.1.0 |
|
46 | + */ |
|
47 | + public function run(IOutput $output); |
|
48 | 48 | |
49 | 49 | } |
@@ -30,9 +30,9 @@ |
||
30 | 30 | * @since 8.1.0 |
31 | 31 | */ |
32 | 32 | interface ICommand { |
33 | - /** |
|
34 | - * Run the command |
|
35 | - * @since 8.1.0 |
|
36 | - */ |
|
37 | - public function handle(); |
|
33 | + /** |
|
34 | + * Run the command |
|
35 | + * @since 8.1.0 |
|
36 | + */ |
|
37 | + public function handle(); |
|
38 | 38 | } |
@@ -30,19 +30,19 @@ |
||
30 | 30 | * @since 8.1.0 |
31 | 31 | */ |
32 | 32 | interface IBus { |
33 | - /** |
|
34 | - * Schedule a command to be fired |
|
35 | - * |
|
36 | - * @param \OCP\Command\ICommand | callable $command |
|
37 | - * @since 8.1.0 |
|
38 | - */ |
|
39 | - public function push($command); |
|
33 | + /** |
|
34 | + * Schedule a command to be fired |
|
35 | + * |
|
36 | + * @param \OCP\Command\ICommand | callable $command |
|
37 | + * @since 8.1.0 |
|
38 | + */ |
|
39 | + public function push($command); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Require all commands using a trait to be run synchronous |
|
43 | - * |
|
44 | - * @param string $trait |
|
45 | - * @since 8.1.0 |
|
46 | - */ |
|
47 | - public function requireSync($trait); |
|
41 | + /** |
|
42 | + * Require all commands using a trait to be run synchronous |
|
43 | + * |
|
44 | + * @param string $trait |
|
45 | + * @since 8.1.0 |
|
46 | + */ |
|
47 | + public function requireSync($trait); |
|
48 | 48 | } |
@@ -31,13 +31,13 @@ |
||
31 | 31 | * @since 5.0.0 |
32 | 32 | */ |
33 | 33 | interface Share_Backend_File_Dependent extends Share_Backend { |
34 | - /** |
|
35 | - * Get the file path of the item |
|
36 | - * @param string $itemSource |
|
37 | - * @param string $uidOwner User that is the owner of shared item |
|
38 | - * @return string|false |
|
39 | - * @since 5.0.0 |
|
40 | - */ |
|
41 | - public function getFilePath($itemSource, $uidOwner); |
|
34 | + /** |
|
35 | + * Get the file path of the item |
|
36 | + * @param string $itemSource |
|
37 | + * @param string $uidOwner User that is the owner of shared item |
|
38 | + * @return string|false |
|
39 | + * @since 5.0.0 |
|
40 | + */ |
|
41 | + public function getFilePath($itemSource, $uidOwner); |
|
42 | 42 | |
43 | 43 | } |
@@ -30,13 +30,13 @@ |
||
30 | 30 | */ |
31 | 31 | class SabrePluginException extends Exception { |
32 | 32 | |
33 | - /** |
|
34 | - * Returns the HTTP statuscode for this exception |
|
35 | - * |
|
36 | - * @return int |
|
37 | - * @since 8.2.0 |
|
38 | - */ |
|
39 | - public function getHTTPCode() { |
|
40 | - return $this->code; |
|
41 | - } |
|
33 | + /** |
|
34 | + * Returns the HTTP statuscode for this exception |
|
35 | + * |
|
36 | + * @return int |
|
37 | + * @since 8.2.0 |
|
38 | + */ |
|
39 | + public function getHTTPCode() { |
|
40 | + return $this->code; |
|
41 | + } |
|
42 | 42 | } |
@@ -30,25 +30,25 @@ |
||
30 | 30 | */ |
31 | 31 | interface ISettings { |
32 | 32 | |
33 | - /** |
|
34 | - * @return TemplateResponse returns the instance with all parameters set, ready to be rendered |
|
35 | - * @since 9.1 |
|
36 | - */ |
|
37 | - public function getForm(); |
|
33 | + /** |
|
34 | + * @return TemplateResponse returns the instance with all parameters set, ready to be rendered |
|
35 | + * @since 9.1 |
|
36 | + */ |
|
37 | + public function getForm(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return string the section ID, e.g. 'sharing' |
|
41 | - * @since 9.1 |
|
42 | - */ |
|
43 | - public function getSection(); |
|
39 | + /** |
|
40 | + * @return string the section ID, e.g. 'sharing' |
|
41 | + * @since 9.1 |
|
42 | + */ |
|
43 | + public function getSection(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return int whether the form should be rather on the top or bottom of |
|
47 | - * the admin section. The forms are arranged in ascending order of the |
|
48 | - * priority values. It is required to return a value between 0 and 100. |
|
49 | - * |
|
50 | - * E.g.: 70 |
|
51 | - * @since 9.1 |
|
52 | - */ |
|
53 | - public function getPriority(); |
|
45 | + /** |
|
46 | + * @return int whether the form should be rather on the top or bottom of |
|
47 | + * the admin section. The forms are arranged in ascending order of the |
|
48 | + * priority values. It is required to return a value between 0 and 100. |
|
49 | + * |
|
50 | + * E.g.: 70 |
|
51 | + * @since 9.1 |
|
52 | + */ |
|
53 | + public function getPriority(); |
|
54 | 54 | } |
@@ -28,31 +28,31 @@ |
||
28 | 28 | * @since 9.1 |
29 | 29 | */ |
30 | 30 | interface ISection { |
31 | - /** |
|
32 | - * returns the ID of the section. It is supposed to be a lower case string, |
|
33 | - * e.g. 'ldap' |
|
34 | - * |
|
35 | - * @returns string |
|
36 | - * @since 9.1 |
|
37 | - */ |
|
38 | - public function getID(); |
|
31 | + /** |
|
32 | + * returns the ID of the section. It is supposed to be a lower case string, |
|
33 | + * e.g. 'ldap' |
|
34 | + * |
|
35 | + * @returns string |
|
36 | + * @since 9.1 |
|
37 | + */ |
|
38 | + public function getID(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * returns the translated name as it should be displayed, e.g. 'LDAP / AD |
|
42 | - * integration'. Use the L10N service to translate it. |
|
43 | - * |
|
44 | - * @return string |
|
45 | - * @since 9.1 |
|
46 | - */ |
|
47 | - public function getName(); |
|
40 | + /** |
|
41 | + * returns the translated name as it should be displayed, e.g. 'LDAP / AD |
|
42 | + * integration'. Use the L10N service to translate it. |
|
43 | + * |
|
44 | + * @return string |
|
45 | + * @since 9.1 |
|
46 | + */ |
|
47 | + public function getName(); |
|
48 | 48 | |
49 | - /** |
|
50 | - * @return int whether the form should be rather on the top or bottom of |
|
51 | - * the settings navigation. The sections are arranged in ascending order of |
|
52 | - * the priority values. It is required to return a value between 0 and 99. |
|
53 | - * |
|
54 | - * E.g.: 70 |
|
55 | - * @since 9.1 |
|
56 | - */ |
|
57 | - public function getPriority(); |
|
49 | + /** |
|
50 | + * @return int whether the form should be rather on the top or bottom of |
|
51 | + * the settings navigation. The sections are arranged in ascending order of |
|
52 | + * the priority values. It is required to return a value between 0 and 99. |
|
53 | + * |
|
54 | + * E.g.: 70 |
|
55 | + * @since 9.1 |
|
56 | + */ |
|
57 | + public function getPriority(); |
|
58 | 58 | } |