@@ -30,21 +30,21 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IQuery { |
33 | - /** |
|
34 | - * @return string |
|
35 | - * @since 8.0.0 |
|
36 | - */ |
|
37 | - public function getSql(); |
|
33 | + /** |
|
34 | + * @return string |
|
35 | + * @since 8.0.0 |
|
36 | + */ |
|
37 | + public function getSql(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return array |
|
41 | - * @since 8.0.0 |
|
42 | - */ |
|
43 | - public function getParams(); |
|
39 | + /** |
|
40 | + * @return array |
|
41 | + * @since 8.0.0 |
|
42 | + */ |
|
43 | + public function getParams(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return float |
|
47 | - * @since 8.0.0 |
|
48 | - */ |
|
49 | - public function getDuration(); |
|
45 | + /** |
|
46 | + * @return float |
|
47 | + * @since 8.0.0 |
|
48 | + */ |
|
49 | + public function getDuration(); |
|
50 | 50 | } |
@@ -30,33 +30,33 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IEvent { |
33 | - /** |
|
34 | - * @return string |
|
35 | - * @since 8.0.0 |
|
36 | - */ |
|
37 | - public function getId(); |
|
33 | + /** |
|
34 | + * @return string |
|
35 | + * @since 8.0.0 |
|
36 | + */ |
|
37 | + public function getId(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * @return string |
|
41 | - * @since 8.0.0 |
|
42 | - */ |
|
43 | - public function getDescription(); |
|
39 | + /** |
|
40 | + * @return string |
|
41 | + * @since 8.0.0 |
|
42 | + */ |
|
43 | + public function getDescription(); |
|
44 | 44 | |
45 | - /** |
|
46 | - * @return float |
|
47 | - * @since 8.0.0 |
|
48 | - */ |
|
49 | - public function getStart(); |
|
45 | + /** |
|
46 | + * @return float |
|
47 | + * @since 8.0.0 |
|
48 | + */ |
|
49 | + public function getStart(); |
|
50 | 50 | |
51 | - /** |
|
52 | - * @return float |
|
53 | - * @since 8.0.0 |
|
54 | - */ |
|
55 | - public function getEnd(); |
|
51 | + /** |
|
52 | + * @return float |
|
53 | + * @since 8.0.0 |
|
54 | + */ |
|
55 | + public function getEnd(); |
|
56 | 56 | |
57 | - /** |
|
58 | - * @return float |
|
59 | - * @since 8.0.0 |
|
60 | - */ |
|
61 | - public function getDuration(); |
|
57 | + /** |
|
58 | + * @return float |
|
59 | + * @since 8.0.0 |
|
60 | + */ |
|
61 | + public function getDuration(); |
|
62 | 62 | } |
@@ -45,112 +45,112 @@ |
||
45 | 45 | * @since 5.0.0 |
46 | 46 | */ |
47 | 47 | class User { |
48 | - /** |
|
49 | - * Get the user id of the user currently logged in. |
|
50 | - * @return string uid or false |
|
51 | - * @deprecated 8.0.0 Use \OC::$server->getUserSession()->getUser()->getUID() |
|
52 | - * @since 5.0.0 |
|
53 | - */ |
|
54 | - public static function getUser() { |
|
55 | - return \OC_User::getUser(); |
|
56 | - } |
|
48 | + /** |
|
49 | + * Get the user id of the user currently logged in. |
|
50 | + * @return string uid or false |
|
51 | + * @deprecated 8.0.0 Use \OC::$server->getUserSession()->getUser()->getUID() |
|
52 | + * @since 5.0.0 |
|
53 | + */ |
|
54 | + public static function getUser() { |
|
55 | + return \OC_User::getUser(); |
|
56 | + } |
|
57 | 57 | |
58 | - /** |
|
59 | - * Get a list of all users |
|
60 | - * @param string $search search pattern |
|
61 | - * @param int|null $limit |
|
62 | - * @param int|null $offset |
|
63 | - * @return array an array of all uids |
|
64 | - * @deprecated 8.1.0 use method search() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
65 | - * @since 5.0.0 |
|
66 | - */ |
|
67 | - public static function getUsers( $search = '', $limit = null, $offset = null ) { |
|
68 | - return \OC_User::getUsers( $search, $limit, $offset ); |
|
69 | - } |
|
58 | + /** |
|
59 | + * Get a list of all users |
|
60 | + * @param string $search search pattern |
|
61 | + * @param int|null $limit |
|
62 | + * @param int|null $offset |
|
63 | + * @return array an array of all uids |
|
64 | + * @deprecated 8.1.0 use method search() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
65 | + * @since 5.0.0 |
|
66 | + */ |
|
67 | + public static function getUsers( $search = '', $limit = null, $offset = null ) { |
|
68 | + return \OC_User::getUsers( $search, $limit, $offset ); |
|
69 | + } |
|
70 | 70 | |
71 | - /** |
|
72 | - * Get the user display name of the user currently logged in. |
|
73 | - * @param string|null $user user id or null for current user |
|
74 | - * @return string display name |
|
75 | - * @deprecated 8.1.0 fetch \OCP\IUser (has getDisplayName()) by using method |
|
76 | - * get() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
77 | - * @since 5.0.0 |
|
78 | - */ |
|
79 | - public static function getDisplayName( $user = null ) { |
|
80 | - return \OC_User::getDisplayName( $user ); |
|
81 | - } |
|
71 | + /** |
|
72 | + * Get the user display name of the user currently logged in. |
|
73 | + * @param string|null $user user id or null for current user |
|
74 | + * @return string display name |
|
75 | + * @deprecated 8.1.0 fetch \OCP\IUser (has getDisplayName()) by using method |
|
76 | + * get() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
77 | + * @since 5.0.0 |
|
78 | + */ |
|
79 | + public static function getDisplayName( $user = null ) { |
|
80 | + return \OC_User::getDisplayName( $user ); |
|
81 | + } |
|
82 | 82 | |
83 | - /** |
|
84 | - * Get a list of all display names and user ids. |
|
85 | - * @param string $search search pattern |
|
86 | - * @param int|null $limit |
|
87 | - * @param int|null $offset |
|
88 | - * @return array an array of all display names (value) and the correspondig uids (key) |
|
89 | - * @deprecated 8.1.0 use method searchDisplayName() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
90 | - * @since 5.0.0 |
|
91 | - */ |
|
92 | - public static function getDisplayNames( $search = '', $limit = null, $offset = null ) { |
|
93 | - return \OC_User::getDisplayNames( $search, $limit, $offset ); |
|
94 | - } |
|
83 | + /** |
|
84 | + * Get a list of all display names and user ids. |
|
85 | + * @param string $search search pattern |
|
86 | + * @param int|null $limit |
|
87 | + * @param int|null $offset |
|
88 | + * @return array an array of all display names (value) and the correspondig uids (key) |
|
89 | + * @deprecated 8.1.0 use method searchDisplayName() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
90 | + * @since 5.0.0 |
|
91 | + */ |
|
92 | + public static function getDisplayNames( $search = '', $limit = null, $offset = null ) { |
|
93 | + return \OC_User::getDisplayNames( $search, $limit, $offset ); |
|
94 | + } |
|
95 | 95 | |
96 | - /** |
|
97 | - * Check if the user is logged in |
|
98 | - * @return boolean |
|
99 | - * @since 5.0.0 |
|
100 | - */ |
|
101 | - public static function isLoggedIn() { |
|
102 | - return \OC_User::isLoggedIn(); |
|
103 | - } |
|
96 | + /** |
|
97 | + * Check if the user is logged in |
|
98 | + * @return boolean |
|
99 | + * @since 5.0.0 |
|
100 | + */ |
|
101 | + public static function isLoggedIn() { |
|
102 | + return \OC_User::isLoggedIn(); |
|
103 | + } |
|
104 | 104 | |
105 | - /** |
|
106 | - * Check if a user exists |
|
107 | - * @param string $uid the username |
|
108 | - * @param string $excludingBackend (default none) |
|
109 | - * @return boolean |
|
110 | - * @deprecated 8.1.0 use method userExists() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
111 | - * @since 5.0.0 |
|
112 | - */ |
|
113 | - public static function userExists( $uid, $excludingBackend = null ) { |
|
114 | - return \OC_User::userExists( $uid, $excludingBackend ); |
|
115 | - } |
|
116 | - /** |
|
117 | - * Logs the user out including all the session data |
|
118 | - * Logout, destroys session |
|
119 | - * @deprecated 8.0.0 Use \OC::$server->getUserSession()->logout(); |
|
120 | - * @since 5.0.0 |
|
121 | - */ |
|
122 | - public static function logout() { |
|
123 | - \OC_User::logout(); |
|
124 | - } |
|
105 | + /** |
|
106 | + * Check if a user exists |
|
107 | + * @param string $uid the username |
|
108 | + * @param string $excludingBackend (default none) |
|
109 | + * @return boolean |
|
110 | + * @deprecated 8.1.0 use method userExists() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
111 | + * @since 5.0.0 |
|
112 | + */ |
|
113 | + public static function userExists( $uid, $excludingBackend = null ) { |
|
114 | + return \OC_User::userExists( $uid, $excludingBackend ); |
|
115 | + } |
|
116 | + /** |
|
117 | + * Logs the user out including all the session data |
|
118 | + * Logout, destroys session |
|
119 | + * @deprecated 8.0.0 Use \OC::$server->getUserSession()->logout(); |
|
120 | + * @since 5.0.0 |
|
121 | + */ |
|
122 | + public static function logout() { |
|
123 | + \OC_User::logout(); |
|
124 | + } |
|
125 | 125 | |
126 | - /** |
|
127 | - * Check if the password is correct |
|
128 | - * @param string $uid The username |
|
129 | - * @param string $password The password |
|
130 | - * @return string|false username on success, false otherwise |
|
131 | - * |
|
132 | - * Check if the password is correct without logging in the user |
|
133 | - * @deprecated 8.0.0 Use \OC::$server->getUserManager()->checkPassword(); |
|
134 | - * @since 5.0.0 |
|
135 | - */ |
|
136 | - public static function checkPassword( $uid, $password ) { |
|
137 | - return \OC_User::checkPassword( $uid, $password ); |
|
138 | - } |
|
126 | + /** |
|
127 | + * Check if the password is correct |
|
128 | + * @param string $uid The username |
|
129 | + * @param string $password The password |
|
130 | + * @return string|false username on success, false otherwise |
|
131 | + * |
|
132 | + * Check if the password is correct without logging in the user |
|
133 | + * @deprecated 8.0.0 Use \OC::$server->getUserManager()->checkPassword(); |
|
134 | + * @since 5.0.0 |
|
135 | + */ |
|
136 | + public static function checkPassword( $uid, $password ) { |
|
137 | + return \OC_User::checkPassword( $uid, $password ); |
|
138 | + } |
|
139 | 139 | |
140 | - /** |
|
141 | - * Check if the user is a admin, redirects to home if not |
|
142 | - * @since 5.0.0 |
|
143 | - */ |
|
144 | - public static function checkAdminUser() { |
|
145 | - \OC_Util::checkAdminUser(); |
|
146 | - } |
|
140 | + /** |
|
141 | + * Check if the user is a admin, redirects to home if not |
|
142 | + * @since 5.0.0 |
|
143 | + */ |
|
144 | + public static function checkAdminUser() { |
|
145 | + \OC_Util::checkAdminUser(); |
|
146 | + } |
|
147 | 147 | |
148 | - /** |
|
149 | - * Check if the user is logged in, redirects to home if not. With |
|
150 | - * redirect URL parameter to the request URI. |
|
151 | - * @since 5.0.0 |
|
152 | - */ |
|
153 | - public static function checkLoggedIn() { |
|
154 | - \OC_Util::checkLoggedIn(); |
|
155 | - } |
|
148 | + /** |
|
149 | + * Check if the user is logged in, redirects to home if not. With |
|
150 | + * redirect URL parameter to the request URI. |
|
151 | + * @since 5.0.0 |
|
152 | + */ |
|
153 | + public static function checkLoggedIn() { |
|
154 | + \OC_Util::checkLoggedIn(); |
|
155 | + } |
|
156 | 156 | } |
@@ -63,202 +63,202 @@ |
||
63 | 63 | */ |
64 | 64 | interface IRequest { |
65 | 65 | |
66 | - /** |
|
67 | - * @param string $name |
|
68 | - * |
|
69 | - * @return string |
|
70 | - * @since 6.0.0 |
|
71 | - */ |
|
72 | - public function getHeader($name); |
|
66 | + /** |
|
67 | + * @param string $name |
|
68 | + * |
|
69 | + * @return string |
|
70 | + * @since 6.0.0 |
|
71 | + */ |
|
72 | + public function getHeader($name); |
|
73 | 73 | |
74 | - /** |
|
75 | - * Lets you access post and get parameters by the index |
|
76 | - * In case of json requests the encoded json body is accessed |
|
77 | - * |
|
78 | - * @param string $key the key which you want to access in the URL Parameter |
|
79 | - * placeholder, $_POST or $_GET array. |
|
80 | - * The priority how they're returned is the following: |
|
81 | - * 1. URL parameters |
|
82 | - * 2. POST parameters |
|
83 | - * 3. GET parameters |
|
84 | - * @param mixed $default If the key is not found, this value will be returned |
|
85 | - * @return mixed the content of the array |
|
86 | - * @since 6.0.0 |
|
87 | - */ |
|
88 | - public function getParam($key, $default = null); |
|
74 | + /** |
|
75 | + * Lets you access post and get parameters by the index |
|
76 | + * In case of json requests the encoded json body is accessed |
|
77 | + * |
|
78 | + * @param string $key the key which you want to access in the URL Parameter |
|
79 | + * placeholder, $_POST or $_GET array. |
|
80 | + * The priority how they're returned is the following: |
|
81 | + * 1. URL parameters |
|
82 | + * 2. POST parameters |
|
83 | + * 3. GET parameters |
|
84 | + * @param mixed $default If the key is not found, this value will be returned |
|
85 | + * @return mixed the content of the array |
|
86 | + * @since 6.0.0 |
|
87 | + */ |
|
88 | + public function getParam($key, $default = null); |
|
89 | 89 | |
90 | 90 | |
91 | - /** |
|
92 | - * Returns all params that were received, be it from the request |
|
93 | - * |
|
94 | - * (as GET or POST) or through the URL by the route |
|
95 | - * |
|
96 | - * @return array the array with all parameters |
|
97 | - * @since 6.0.0 |
|
98 | - */ |
|
99 | - public function getParams(); |
|
91 | + /** |
|
92 | + * Returns all params that were received, be it from the request |
|
93 | + * |
|
94 | + * (as GET or POST) or through the URL by the route |
|
95 | + * |
|
96 | + * @return array the array with all parameters |
|
97 | + * @since 6.0.0 |
|
98 | + */ |
|
99 | + public function getParams(); |
|
100 | 100 | |
101 | - /** |
|
102 | - * Returns the method of the request |
|
103 | - * |
|
104 | - * @return string the method of the request (POST, GET, etc) |
|
105 | - * @since 6.0.0 |
|
106 | - */ |
|
107 | - public function getMethod(); |
|
101 | + /** |
|
102 | + * Returns the method of the request |
|
103 | + * |
|
104 | + * @return string the method of the request (POST, GET, etc) |
|
105 | + * @since 6.0.0 |
|
106 | + */ |
|
107 | + public function getMethod(); |
|
108 | 108 | |
109 | - /** |
|
110 | - * Shortcut for accessing an uploaded file through the $_FILES array |
|
111 | - * |
|
112 | - * @param string $key the key that will be taken from the $_FILES array |
|
113 | - * @return array the file in the $_FILES element |
|
114 | - * @since 6.0.0 |
|
115 | - */ |
|
116 | - public function getUploadedFile($key); |
|
109 | + /** |
|
110 | + * Shortcut for accessing an uploaded file through the $_FILES array |
|
111 | + * |
|
112 | + * @param string $key the key that will be taken from the $_FILES array |
|
113 | + * @return array the file in the $_FILES element |
|
114 | + * @since 6.0.0 |
|
115 | + */ |
|
116 | + public function getUploadedFile($key); |
|
117 | 117 | |
118 | 118 | |
119 | - /** |
|
120 | - * Shortcut for getting env variables |
|
121 | - * |
|
122 | - * @param string $key the key that will be taken from the $_ENV array |
|
123 | - * @return array the value in the $_ENV element |
|
124 | - * @since 6.0.0 |
|
125 | - */ |
|
126 | - public function getEnv($key); |
|
119 | + /** |
|
120 | + * Shortcut for getting env variables |
|
121 | + * |
|
122 | + * @param string $key the key that will be taken from the $_ENV array |
|
123 | + * @return array the value in the $_ENV element |
|
124 | + * @since 6.0.0 |
|
125 | + */ |
|
126 | + public function getEnv($key); |
|
127 | 127 | |
128 | 128 | |
129 | - /** |
|
130 | - * Shortcut for getting cookie variables |
|
131 | - * |
|
132 | - * @param string $key the key that will be taken from the $_COOKIE array |
|
133 | - * @return array the value in the $_COOKIE element |
|
134 | - * @since 6.0.0 |
|
135 | - */ |
|
136 | - public function getCookie($key); |
|
129 | + /** |
|
130 | + * Shortcut for getting cookie variables |
|
131 | + * |
|
132 | + * @param string $key the key that will be taken from the $_COOKIE array |
|
133 | + * @return array the value in the $_COOKIE element |
|
134 | + * @since 6.0.0 |
|
135 | + */ |
|
136 | + public function getCookie($key); |
|
137 | 137 | |
138 | 138 | |
139 | - /** |
|
140 | - * Checks if the CSRF check was correct |
|
141 | - * |
|
142 | - * @return bool true if CSRF check passed |
|
143 | - * @since 6.0.0 |
|
144 | - */ |
|
145 | - public function passesCSRFCheck(); |
|
139 | + /** |
|
140 | + * Checks if the CSRF check was correct |
|
141 | + * |
|
142 | + * @return bool true if CSRF check passed |
|
143 | + * @since 6.0.0 |
|
144 | + */ |
|
145 | + public function passesCSRFCheck(); |
|
146 | 146 | |
147 | - /** |
|
148 | - * Checks if the strict cookie has been sent with the request if the request |
|
149 | - * is including any cookies. |
|
150 | - * |
|
151 | - * @return bool |
|
152 | - * @since 9.0.0 |
|
153 | - */ |
|
154 | - public function passesStrictCookieCheck(); |
|
147 | + /** |
|
148 | + * Checks if the strict cookie has been sent with the request if the request |
|
149 | + * is including any cookies. |
|
150 | + * |
|
151 | + * @return bool |
|
152 | + * @since 9.0.0 |
|
153 | + */ |
|
154 | + public function passesStrictCookieCheck(); |
|
155 | 155 | |
156 | - /** |
|
157 | - * Checks if the lax cookie has been sent with the request if the request |
|
158 | - * is including any cookies. |
|
159 | - * |
|
160 | - * @return bool |
|
161 | - * @since 9.0.0 |
|
162 | - */ |
|
163 | - public function passesLaxCookieCheck(); |
|
156 | + /** |
|
157 | + * Checks if the lax cookie has been sent with the request if the request |
|
158 | + * is including any cookies. |
|
159 | + * |
|
160 | + * @return bool |
|
161 | + * @since 9.0.0 |
|
162 | + */ |
|
163 | + public function passesLaxCookieCheck(); |
|
164 | 164 | |
165 | - /** |
|
166 | - * Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging |
|
167 | - * If `mod_unique_id` is installed this value will be taken. |
|
168 | - * |
|
169 | - * @return string |
|
170 | - * @since 8.1.0 |
|
171 | - */ |
|
172 | - public function getId(); |
|
165 | + /** |
|
166 | + * Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging |
|
167 | + * If `mod_unique_id` is installed this value will be taken. |
|
168 | + * |
|
169 | + * @return string |
|
170 | + * @since 8.1.0 |
|
171 | + */ |
|
172 | + public function getId(); |
|
173 | 173 | |
174 | - /** |
|
175 | - * Returns the remote address, if the connection came from a trusted proxy |
|
176 | - * and `forwarded_for_headers` has been configured then the IP address |
|
177 | - * specified in this header will be returned instead. |
|
178 | - * Do always use this instead of $_SERVER['REMOTE_ADDR'] |
|
179 | - * |
|
180 | - * @return string IP address |
|
181 | - * @since 8.1.0 |
|
182 | - */ |
|
183 | - public function getRemoteAddress(); |
|
174 | + /** |
|
175 | + * Returns the remote address, if the connection came from a trusted proxy |
|
176 | + * and `forwarded_for_headers` has been configured then the IP address |
|
177 | + * specified in this header will be returned instead. |
|
178 | + * Do always use this instead of $_SERVER['REMOTE_ADDR'] |
|
179 | + * |
|
180 | + * @return string IP address |
|
181 | + * @since 8.1.0 |
|
182 | + */ |
|
183 | + public function getRemoteAddress(); |
|
184 | 184 | |
185 | - /** |
|
186 | - * Returns the server protocol. It respects reverse proxy servers and load |
|
187 | - * balancers. |
|
188 | - * |
|
189 | - * @return string Server protocol (http or https) |
|
190 | - * @since 8.1.0 |
|
191 | - */ |
|
192 | - public function getServerProtocol(); |
|
185 | + /** |
|
186 | + * Returns the server protocol. It respects reverse proxy servers and load |
|
187 | + * balancers. |
|
188 | + * |
|
189 | + * @return string Server protocol (http or https) |
|
190 | + * @since 8.1.0 |
|
191 | + */ |
|
192 | + public function getServerProtocol(); |
|
193 | 193 | |
194 | - /** |
|
195 | - * Returns the used HTTP protocol. |
|
196 | - * |
|
197 | - * @return string HTTP protocol. HTTP/2, HTTP/1.1 or HTTP/1.0. |
|
198 | - * @since 8.2.0 |
|
199 | - */ |
|
200 | - public function getHttpProtocol(); |
|
194 | + /** |
|
195 | + * Returns the used HTTP protocol. |
|
196 | + * |
|
197 | + * @return string HTTP protocol. HTTP/2, HTTP/1.1 or HTTP/1.0. |
|
198 | + * @since 8.2.0 |
|
199 | + */ |
|
200 | + public function getHttpProtocol(); |
|
201 | 201 | |
202 | - /** |
|
203 | - * Returns the request uri, even if the website uses one or more |
|
204 | - * reverse proxies |
|
205 | - * |
|
206 | - * @return string |
|
207 | - * @since 8.1.0 |
|
208 | - */ |
|
209 | - public function getRequestUri(); |
|
202 | + /** |
|
203 | + * Returns the request uri, even if the website uses one or more |
|
204 | + * reverse proxies |
|
205 | + * |
|
206 | + * @return string |
|
207 | + * @since 8.1.0 |
|
208 | + */ |
|
209 | + public function getRequestUri(); |
|
210 | 210 | |
211 | - /** |
|
212 | - * Get raw PathInfo from request (not urldecoded) |
|
213 | - * |
|
214 | - * @throws \Exception |
|
215 | - * @return string Path info |
|
216 | - * @since 8.1.0 |
|
217 | - */ |
|
218 | - public function getRawPathInfo(); |
|
211 | + /** |
|
212 | + * Get raw PathInfo from request (not urldecoded) |
|
213 | + * |
|
214 | + * @throws \Exception |
|
215 | + * @return string Path info |
|
216 | + * @since 8.1.0 |
|
217 | + */ |
|
218 | + public function getRawPathInfo(); |
|
219 | 219 | |
220 | - /** |
|
221 | - * Get PathInfo from request |
|
222 | - * |
|
223 | - * @throws \Exception |
|
224 | - * @return string|false Path info or false when not found |
|
225 | - * @since 8.1.0 |
|
226 | - */ |
|
227 | - public function getPathInfo(); |
|
220 | + /** |
|
221 | + * Get PathInfo from request |
|
222 | + * |
|
223 | + * @throws \Exception |
|
224 | + * @return string|false Path info or false when not found |
|
225 | + * @since 8.1.0 |
|
226 | + */ |
|
227 | + public function getPathInfo(); |
|
228 | 228 | |
229 | - /** |
|
230 | - * Returns the script name, even if the website uses one or more |
|
231 | - * reverse proxies |
|
232 | - * |
|
233 | - * @return string the script name |
|
234 | - * @since 8.1.0 |
|
235 | - */ |
|
236 | - public function getScriptName(); |
|
229 | + /** |
|
230 | + * Returns the script name, even if the website uses one or more |
|
231 | + * reverse proxies |
|
232 | + * |
|
233 | + * @return string the script name |
|
234 | + * @since 8.1.0 |
|
235 | + */ |
|
236 | + public function getScriptName(); |
|
237 | 237 | |
238 | - /** |
|
239 | - * Checks whether the user agent matches a given regex |
|
240 | - * |
|
241 | - * @param array $agent array of agent names |
|
242 | - * @return bool true if at least one of the given agent matches, false otherwise |
|
243 | - * @since 8.1.0 |
|
244 | - */ |
|
245 | - public function isUserAgent(array $agent); |
|
238 | + /** |
|
239 | + * Checks whether the user agent matches a given regex |
|
240 | + * |
|
241 | + * @param array $agent array of agent names |
|
242 | + * @return bool true if at least one of the given agent matches, false otherwise |
|
243 | + * @since 8.1.0 |
|
244 | + */ |
|
245 | + public function isUserAgent(array $agent); |
|
246 | 246 | |
247 | - /** |
|
248 | - * Returns the unverified server host from the headers without checking |
|
249 | - * whether it is a trusted domain |
|
250 | - * |
|
251 | - * @return string Server host |
|
252 | - * @since 8.1.0 |
|
253 | - */ |
|
254 | - public function getInsecureServerHost(); |
|
247 | + /** |
|
248 | + * Returns the unverified server host from the headers without checking |
|
249 | + * whether it is a trusted domain |
|
250 | + * |
|
251 | + * @return string Server host |
|
252 | + * @since 8.1.0 |
|
253 | + */ |
|
254 | + public function getInsecureServerHost(); |
|
255 | 255 | |
256 | - /** |
|
257 | - * Returns the server host from the headers, or the first configured |
|
258 | - * trusted domain if the host isn't in the trusted list |
|
259 | - * |
|
260 | - * @return string Server host |
|
261 | - * @since 8.1.0 |
|
262 | - */ |
|
263 | - public function getServerHost(); |
|
256 | + /** |
|
257 | + * Returns the server host from the headers, or the first configured |
|
258 | + * trusted domain if the host isn't in the trusted list |
|
259 | + * |
|
260 | + * @return string Server host |
|
261 | + * @since 8.1.0 |
|
262 | + */ |
|
263 | + public function getServerHost(); |
|
264 | 264 | } |
@@ -39,22 +39,22 @@ |
||
39 | 39 | * @since 6.0.0 |
40 | 40 | */ |
41 | 41 | interface INavigationManager { |
42 | - /** |
|
43 | - * Creates a new navigation entry |
|
44 | - * |
|
45 | - * @param array|\Closure $entry Array containing: id, name, order, icon and href key |
|
46 | - * The use of a closure is preferred, because it will avoid |
|
47 | - * loading the routing of your app, unless required. |
|
48 | - * @return void |
|
49 | - * @since 6.0.0 |
|
50 | - */ |
|
51 | - public function add($entry); |
|
42 | + /** |
|
43 | + * Creates a new navigation entry |
|
44 | + * |
|
45 | + * @param array|\Closure $entry Array containing: id, name, order, icon and href key |
|
46 | + * The use of a closure is preferred, because it will avoid |
|
47 | + * loading the routing of your app, unless required. |
|
48 | + * @return void |
|
49 | + * @since 6.0.0 |
|
50 | + */ |
|
51 | + public function add($entry); |
|
52 | 52 | |
53 | - /** |
|
54 | - * Sets the current navigation entry of the currently running app |
|
55 | - * @param string $appId id of the app entry to activate (from added $entry) |
|
56 | - * @return void |
|
57 | - * @since 6.0.0 |
|
58 | - */ |
|
59 | - public function setActiveEntry($appId); |
|
53 | + /** |
|
54 | + * Sets the current navigation entry of the currently running app |
|
55 | + * @param string $appId id of the app entry to activate (from added $entry) |
|
56 | + * @return void |
|
57 | + * @since 6.0.0 |
|
58 | + */ |
|
59 | + public function setActiveEntry($appId); |
|
60 | 60 | } |
@@ -38,57 +38,57 @@ |
||
38 | 38 | * @since 6.0.0 |
39 | 39 | */ |
40 | 40 | interface IURLGenerator { |
41 | - /** |
|
42 | - * Returns the URL for a route |
|
43 | - * @param string $routeName the name of the route |
|
44 | - * @param array $arguments an array with arguments which will be filled into the url |
|
45 | - * @return string the url |
|
46 | - * @since 6.0.0 |
|
47 | - */ |
|
48 | - public function linkToRoute($routeName, $arguments = array()); |
|
41 | + /** |
|
42 | + * Returns the URL for a route |
|
43 | + * @param string $routeName the name of the route |
|
44 | + * @param array $arguments an array with arguments which will be filled into the url |
|
45 | + * @return string the url |
|
46 | + * @since 6.0.0 |
|
47 | + */ |
|
48 | + public function linkToRoute($routeName, $arguments = array()); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Returns the absolute URL for a route |
|
52 | - * @param string $routeName the name of the route |
|
53 | - * @param array $arguments an array with arguments which will be filled into the url |
|
54 | - * @return string the absolute url |
|
55 | - * @since 8.0.0 |
|
56 | - */ |
|
57 | - public function linkToRouteAbsolute($routeName, $arguments = array()); |
|
50 | + /** |
|
51 | + * Returns the absolute URL for a route |
|
52 | + * @param string $routeName the name of the route |
|
53 | + * @param array $arguments an array with arguments which will be filled into the url |
|
54 | + * @return string the absolute url |
|
55 | + * @since 8.0.0 |
|
56 | + */ |
|
57 | + public function linkToRouteAbsolute($routeName, $arguments = array()); |
|
58 | 58 | |
59 | - /** |
|
60 | - * Returns an URL for an image or file |
|
61 | - * @param string $appName the name of the app |
|
62 | - * @param string $file the name of the file |
|
63 | - * @param array $args array with param=>value, will be appended to the returned url |
|
64 | - * The value of $args will be urlencoded |
|
65 | - * @return string the url |
|
66 | - * @since 6.0.0 |
|
67 | - */ |
|
68 | - public function linkTo($appName, $file, $args = array()); |
|
59 | + /** |
|
60 | + * Returns an URL for an image or file |
|
61 | + * @param string $appName the name of the app |
|
62 | + * @param string $file the name of the file |
|
63 | + * @param array $args array with param=>value, will be appended to the returned url |
|
64 | + * The value of $args will be urlencoded |
|
65 | + * @return string the url |
|
66 | + * @since 6.0.0 |
|
67 | + */ |
|
68 | + public function linkTo($appName, $file, $args = array()); |
|
69 | 69 | |
70 | - /** |
|
71 | - * Returns the link to an image, like linkTo but only with prepending img/ |
|
72 | - * @param string $appName the name of the app |
|
73 | - * @param string $file the name of the file |
|
74 | - * @return string the url |
|
75 | - * @since 6.0.0 |
|
76 | - */ |
|
77 | - public function imagePath($appName, $file); |
|
70 | + /** |
|
71 | + * Returns the link to an image, like linkTo but only with prepending img/ |
|
72 | + * @param string $appName the name of the app |
|
73 | + * @param string $file the name of the file |
|
74 | + * @return string the url |
|
75 | + * @since 6.0.0 |
|
76 | + */ |
|
77 | + public function imagePath($appName, $file); |
|
78 | 78 | |
79 | 79 | |
80 | - /** |
|
81 | - * Makes an URL absolute |
|
82 | - * @param string $url the url in the ownCloud host |
|
83 | - * @return string the absolute version of the url |
|
84 | - * @since 6.0.0 |
|
85 | - */ |
|
86 | - public function getAbsoluteURL($url); |
|
80 | + /** |
|
81 | + * Makes an URL absolute |
|
82 | + * @param string $url the url in the ownCloud host |
|
83 | + * @return string the absolute version of the url |
|
84 | + * @since 6.0.0 |
|
85 | + */ |
|
86 | + public function getAbsoluteURL($url); |
|
87 | 87 | |
88 | - /** |
|
89 | - * @param string $key |
|
90 | - * @return string url to the online documentation |
|
91 | - * @since 8.0.0 |
|
92 | - */ |
|
93 | - public function linkToDocs($key); |
|
88 | + /** |
|
89 | + * @param string $key |
|
90 | + * @return string url to the online documentation |
|
91 | + * @since 8.0.0 |
|
92 | + */ |
|
93 | + public function linkToDocs($key); |
|
94 | 94 | } |
@@ -47,118 +47,118 @@ |
||
47 | 47 | * @deprecated 8.0.0 use methods of \OCP\IConfig |
48 | 48 | */ |
49 | 49 | class Config { |
50 | - /** |
|
51 | - * Gets a value from config.php |
|
52 | - * @param string $key key |
|
53 | - * @param mixed $default = null default value |
|
54 | - * @return mixed the value or $default |
|
55 | - * @deprecated 8.0.0 use method getSystemValue of \OCP\IConfig |
|
56 | - * |
|
57 | - * This function gets the value from config.php. If it does not exist, |
|
58 | - * $default will be returned. |
|
59 | - */ |
|
60 | - public static function getSystemValue( $key, $default = null ) { |
|
61 | - return \OC::$server->getConfig()->getSystemValue( $key, $default ); |
|
62 | - } |
|
50 | + /** |
|
51 | + * Gets a value from config.php |
|
52 | + * @param string $key key |
|
53 | + * @param mixed $default = null default value |
|
54 | + * @return mixed the value or $default |
|
55 | + * @deprecated 8.0.0 use method getSystemValue of \OCP\IConfig |
|
56 | + * |
|
57 | + * This function gets the value from config.php. If it does not exist, |
|
58 | + * $default will be returned. |
|
59 | + */ |
|
60 | + public static function getSystemValue( $key, $default = null ) { |
|
61 | + return \OC::$server->getConfig()->getSystemValue( $key, $default ); |
|
62 | + } |
|
63 | 63 | |
64 | - /** |
|
65 | - * Sets a value |
|
66 | - * @param string $key key |
|
67 | - * @param mixed $value value |
|
68 | - * @return bool |
|
69 | - * @deprecated 8.0.0 use method setSystemValue of \OCP\IConfig |
|
70 | - * |
|
71 | - * This function sets the value and writes the config.php. If the file can |
|
72 | - * not be written, false will be returned. |
|
73 | - */ |
|
74 | - public static function setSystemValue( $key, $value ) { |
|
75 | - try { |
|
76 | - \OC::$server->getConfig()->setSystemValue( $key, $value ); |
|
77 | - } catch (\Exception $e) { |
|
78 | - return false; |
|
79 | - } |
|
80 | - return true; |
|
81 | - } |
|
64 | + /** |
|
65 | + * Sets a value |
|
66 | + * @param string $key key |
|
67 | + * @param mixed $value value |
|
68 | + * @return bool |
|
69 | + * @deprecated 8.0.0 use method setSystemValue of \OCP\IConfig |
|
70 | + * |
|
71 | + * This function sets the value and writes the config.php. If the file can |
|
72 | + * not be written, false will be returned. |
|
73 | + */ |
|
74 | + public static function setSystemValue( $key, $value ) { |
|
75 | + try { |
|
76 | + \OC::$server->getConfig()->setSystemValue( $key, $value ); |
|
77 | + } catch (\Exception $e) { |
|
78 | + return false; |
|
79 | + } |
|
80 | + return true; |
|
81 | + } |
|
82 | 82 | |
83 | - /** |
|
84 | - * Deletes a value from config.php |
|
85 | - * @param string $key key |
|
86 | - * @deprecated 8.0.0 use method deleteSystemValue of \OCP\IConfig |
|
87 | - * |
|
88 | - * This function deletes the value from config.php. |
|
89 | - */ |
|
90 | - public static function deleteSystemValue( $key ) { |
|
91 | - \OC::$server->getConfig()->deleteSystemValue( $key ); |
|
92 | - } |
|
83 | + /** |
|
84 | + * Deletes a value from config.php |
|
85 | + * @param string $key key |
|
86 | + * @deprecated 8.0.0 use method deleteSystemValue of \OCP\IConfig |
|
87 | + * |
|
88 | + * This function deletes the value from config.php. |
|
89 | + */ |
|
90 | + public static function deleteSystemValue( $key ) { |
|
91 | + \OC::$server->getConfig()->deleteSystemValue( $key ); |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * Gets the config value |
|
96 | - * @param string $app app |
|
97 | - * @param string $key key |
|
98 | - * @param string $default = null, default value if the key does not exist |
|
99 | - * @return string the value or $default |
|
100 | - * @deprecated 8.0.0 use method getAppValue of \OCP\IConfig |
|
101 | - * |
|
102 | - * This function gets a value from the appconfig table. If the key does |
|
103 | - * not exist the default value will be returned |
|
104 | - */ |
|
105 | - public static function getAppValue( $app, $key, $default = null ) { |
|
106 | - return \OC::$server->getConfig()->getAppValue( $app, $key, $default ); |
|
107 | - } |
|
94 | + /** |
|
95 | + * Gets the config value |
|
96 | + * @param string $app app |
|
97 | + * @param string $key key |
|
98 | + * @param string $default = null, default value if the key does not exist |
|
99 | + * @return string the value or $default |
|
100 | + * @deprecated 8.0.0 use method getAppValue of \OCP\IConfig |
|
101 | + * |
|
102 | + * This function gets a value from the appconfig table. If the key does |
|
103 | + * not exist the default value will be returned |
|
104 | + */ |
|
105 | + public static function getAppValue( $app, $key, $default = null ) { |
|
106 | + return \OC::$server->getConfig()->getAppValue( $app, $key, $default ); |
|
107 | + } |
|
108 | 108 | |
109 | - /** |
|
110 | - * Sets a value in the appconfig |
|
111 | - * @param string $app app |
|
112 | - * @param string $key key |
|
113 | - * @param string $value value |
|
114 | - * @return boolean true/false |
|
115 | - * @deprecated 8.0.0 use method setAppValue of \OCP\IConfig |
|
116 | - * |
|
117 | - * Sets a value. If the key did not exist before it will be created. |
|
118 | - */ |
|
119 | - public static function setAppValue( $app, $key, $value ) { |
|
120 | - try { |
|
121 | - \OC::$server->getConfig()->setAppValue( $app, $key, $value ); |
|
122 | - } catch (\Exception $e) { |
|
123 | - return false; |
|
124 | - } |
|
125 | - return true; |
|
126 | - } |
|
109 | + /** |
|
110 | + * Sets a value in the appconfig |
|
111 | + * @param string $app app |
|
112 | + * @param string $key key |
|
113 | + * @param string $value value |
|
114 | + * @return boolean true/false |
|
115 | + * @deprecated 8.0.0 use method setAppValue of \OCP\IConfig |
|
116 | + * |
|
117 | + * Sets a value. If the key did not exist before it will be created. |
|
118 | + */ |
|
119 | + public static function setAppValue( $app, $key, $value ) { |
|
120 | + try { |
|
121 | + \OC::$server->getConfig()->setAppValue( $app, $key, $value ); |
|
122 | + } catch (\Exception $e) { |
|
123 | + return false; |
|
124 | + } |
|
125 | + return true; |
|
126 | + } |
|
127 | 127 | |
128 | - /** |
|
129 | - * Gets the preference |
|
130 | - * @param string $user user |
|
131 | - * @param string $app app |
|
132 | - * @param string $key key |
|
133 | - * @param string $default = null, default value if the key does not exist |
|
134 | - * @return string the value or $default |
|
135 | - * @deprecated 8.0.0 use method getUserValue of \OCP\IConfig |
|
136 | - * |
|
137 | - * This function gets a value from the preferences table. If the key does |
|
138 | - * not exist the default value will be returned |
|
139 | - */ |
|
140 | - public static function getUserValue( $user, $app, $key, $default = null ) { |
|
141 | - return \OC::$server->getConfig()->getUserValue( $user, $app, $key, $default ); |
|
142 | - } |
|
128 | + /** |
|
129 | + * Gets the preference |
|
130 | + * @param string $user user |
|
131 | + * @param string $app app |
|
132 | + * @param string $key key |
|
133 | + * @param string $default = null, default value if the key does not exist |
|
134 | + * @return string the value or $default |
|
135 | + * @deprecated 8.0.0 use method getUserValue of \OCP\IConfig |
|
136 | + * |
|
137 | + * This function gets a value from the preferences table. If the key does |
|
138 | + * not exist the default value will be returned |
|
139 | + */ |
|
140 | + public static function getUserValue( $user, $app, $key, $default = null ) { |
|
141 | + return \OC::$server->getConfig()->getUserValue( $user, $app, $key, $default ); |
|
142 | + } |
|
143 | 143 | |
144 | - /** |
|
145 | - * Sets a value in the preferences |
|
146 | - * @param string $user user |
|
147 | - * @param string $app app |
|
148 | - * @param string $key key |
|
149 | - * @param string $value value |
|
150 | - * @return bool |
|
151 | - * @deprecated 8.0.0 use method setUserValue of \OCP\IConfig |
|
152 | - * |
|
153 | - * Adds a value to the preferences. If the key did not exist before, it |
|
154 | - * will be added automagically. |
|
155 | - */ |
|
156 | - public static function setUserValue( $user, $app, $key, $value ) { |
|
157 | - try { |
|
158 | - \OC::$server->getConfig()->setUserValue( $user, $app, $key, $value ); |
|
159 | - } catch (\Exception $e) { |
|
160 | - return false; |
|
161 | - } |
|
162 | - return true; |
|
163 | - } |
|
144 | + /** |
|
145 | + * Sets a value in the preferences |
|
146 | + * @param string $user user |
|
147 | + * @param string $app app |
|
148 | + * @param string $key key |
|
149 | + * @param string $value value |
|
150 | + * @return bool |
|
151 | + * @deprecated 8.0.0 use method setUserValue of \OCP\IConfig |
|
152 | + * |
|
153 | + * Adds a value to the preferences. If the key did not exist before, it |
|
154 | + * will be added automagically. |
|
155 | + */ |
|
156 | + public static function setUserValue( $user, $app, $key, $value ) { |
|
157 | + try { |
|
158 | + \OC::$server->getConfig()->setUserValue( $user, $app, $key, $value ); |
|
159 | + } catch (\Exception $e) { |
|
160 | + return false; |
|
161 | + } |
|
162 | + return true; |
|
163 | + } |
|
164 | 164 | } |
@@ -30,81 +30,81 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IGroup { |
33 | - /** |
|
34 | - * @return string |
|
35 | - * @since 8.0.0 |
|
36 | - */ |
|
37 | - public function getGID(); |
|
33 | + /** |
|
34 | + * @return string |
|
35 | + * @since 8.0.0 |
|
36 | + */ |
|
37 | + public function getGID(); |
|
38 | 38 | |
39 | - /** |
|
40 | - * get all users in the group |
|
41 | - * |
|
42 | - * @return \OCP\IUser[] |
|
43 | - * @since 8.0.0 |
|
44 | - */ |
|
45 | - public function getUsers(); |
|
39 | + /** |
|
40 | + * get all users in the group |
|
41 | + * |
|
42 | + * @return \OCP\IUser[] |
|
43 | + * @since 8.0.0 |
|
44 | + */ |
|
45 | + public function getUsers(); |
|
46 | 46 | |
47 | - /** |
|
48 | - * check if a user is in the group |
|
49 | - * |
|
50 | - * @param \OCP\IUser $user |
|
51 | - * @return bool |
|
52 | - * @since 8.0.0 |
|
53 | - */ |
|
54 | - public function inGroup($user); |
|
47 | + /** |
|
48 | + * check if a user is in the group |
|
49 | + * |
|
50 | + * @param \OCP\IUser $user |
|
51 | + * @return bool |
|
52 | + * @since 8.0.0 |
|
53 | + */ |
|
54 | + public function inGroup($user); |
|
55 | 55 | |
56 | - /** |
|
57 | - * add a user to the group |
|
58 | - * |
|
59 | - * @param \OCP\IUser $user |
|
60 | - * @since 8.0.0 |
|
61 | - */ |
|
62 | - public function addUser($user); |
|
56 | + /** |
|
57 | + * add a user to the group |
|
58 | + * |
|
59 | + * @param \OCP\IUser $user |
|
60 | + * @since 8.0.0 |
|
61 | + */ |
|
62 | + public function addUser($user); |
|
63 | 63 | |
64 | - /** |
|
65 | - * remove a user from the group |
|
66 | - * |
|
67 | - * @param \OCP\IUser $user |
|
68 | - * @since 8.0.0 |
|
69 | - */ |
|
70 | - public function removeUser($user); |
|
64 | + /** |
|
65 | + * remove a user from the group |
|
66 | + * |
|
67 | + * @param \OCP\IUser $user |
|
68 | + * @since 8.0.0 |
|
69 | + */ |
|
70 | + public function removeUser($user); |
|
71 | 71 | |
72 | - /** |
|
73 | - * search for users in the group by userid |
|
74 | - * |
|
75 | - * @param string $search |
|
76 | - * @param int $limit |
|
77 | - * @param int $offset |
|
78 | - * @return \OCP\IUser[] |
|
79 | - * @since 8.0.0 |
|
80 | - */ |
|
81 | - public function searchUsers($search, $limit = null, $offset = null); |
|
72 | + /** |
|
73 | + * search for users in the group by userid |
|
74 | + * |
|
75 | + * @param string $search |
|
76 | + * @param int $limit |
|
77 | + * @param int $offset |
|
78 | + * @return \OCP\IUser[] |
|
79 | + * @since 8.0.0 |
|
80 | + */ |
|
81 | + public function searchUsers($search, $limit = null, $offset = null); |
|
82 | 82 | |
83 | - /** |
|
84 | - * returns the number of users matching the search string |
|
85 | - * |
|
86 | - * @param string $search |
|
87 | - * @return int|bool |
|
88 | - * @since 8.0.0 |
|
89 | - */ |
|
90 | - public function count($search = ''); |
|
83 | + /** |
|
84 | + * returns the number of users matching the search string |
|
85 | + * |
|
86 | + * @param string $search |
|
87 | + * @return int|bool |
|
88 | + * @since 8.0.0 |
|
89 | + */ |
|
90 | + public function count($search = ''); |
|
91 | 91 | |
92 | - /** |
|
93 | - * search for users in the group by displayname |
|
94 | - * |
|
95 | - * @param string $search |
|
96 | - * @param int $limit |
|
97 | - * @param int $offset |
|
98 | - * @return \OCP\IUser[] |
|
99 | - * @since 8.0.0 |
|
100 | - */ |
|
101 | - public function searchDisplayName($search, $limit = null, $offset = null); |
|
92 | + /** |
|
93 | + * search for users in the group by displayname |
|
94 | + * |
|
95 | + * @param string $search |
|
96 | + * @param int $limit |
|
97 | + * @param int $offset |
|
98 | + * @return \OCP\IUser[] |
|
99 | + * @since 8.0.0 |
|
100 | + */ |
|
101 | + public function searchDisplayName($search, $limit = null, $offset = null); |
|
102 | 102 | |
103 | - /** |
|
104 | - * delete the group |
|
105 | - * |
|
106 | - * @return bool |
|
107 | - * @since 8.0.0 |
|
108 | - */ |
|
109 | - public function delete(); |
|
103 | + /** |
|
104 | + * delete the group |
|
105 | + * |
|
106 | + * @return bool |
|
107 | + * @since 8.0.0 |
|
108 | + */ |
|
109 | + public function delete(); |
|
110 | 110 | } |
@@ -29,44 +29,44 @@ |
||
29 | 29 | * @since 8.0.0 |
30 | 30 | */ |
31 | 31 | interface ICertificateManager { |
32 | - /** |
|
33 | - * Returns all certificates trusted by the user |
|
34 | - * |
|
35 | - * @return \OCP\ICertificate[] |
|
36 | - * @since 8.0.0 |
|
37 | - */ |
|
38 | - public function listCertificates(); |
|
32 | + /** |
|
33 | + * Returns all certificates trusted by the user |
|
34 | + * |
|
35 | + * @return \OCP\ICertificate[] |
|
36 | + * @since 8.0.0 |
|
37 | + */ |
|
38 | + public function listCertificates(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @param string $certificate the certificate data |
|
42 | - * @param string $name the filename for the certificate |
|
43 | - * @return \OCP\ICertificate |
|
44 | - * @throws \Exception If the certificate could not get added |
|
45 | - * @since 8.0.0 - since 8.1.0 throws exception instead of returning false |
|
46 | - */ |
|
47 | - public function addCertificate($certificate, $name); |
|
40 | + /** |
|
41 | + * @param string $certificate the certificate data |
|
42 | + * @param string $name the filename for the certificate |
|
43 | + * @return \OCP\ICertificate |
|
44 | + * @throws \Exception If the certificate could not get added |
|
45 | + * @since 8.0.0 - since 8.1.0 throws exception instead of returning false |
|
46 | + */ |
|
47 | + public function addCertificate($certificate, $name); |
|
48 | 48 | |
49 | - /** |
|
50 | - * @param string $name |
|
51 | - * @since 8.0.0 |
|
52 | - */ |
|
53 | - public function removeCertificate($name); |
|
49 | + /** |
|
50 | + * @param string $name |
|
51 | + * @since 8.0.0 |
|
52 | + */ |
|
53 | + public function removeCertificate($name); |
|
54 | 54 | |
55 | - /** |
|
56 | - * Get the path to the certificate bundle for this user |
|
57 | - * |
|
58 | - * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle (since 9.0.0) |
|
59 | - * @return string |
|
60 | - * @since 8.0.0 |
|
61 | - */ |
|
62 | - public function getCertificateBundle($uid = ''); |
|
55 | + /** |
|
56 | + * Get the path to the certificate bundle for this user |
|
57 | + * |
|
58 | + * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle (since 9.0.0) |
|
59 | + * @return string |
|
60 | + * @since 8.0.0 |
|
61 | + */ |
|
62 | + public function getCertificateBundle($uid = ''); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Get the full local path to the certificate bundle for this user |
|
66 | - * |
|
67 | - * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle |
|
68 | - * @return string |
|
69 | - * @since 9.0.0 |
|
70 | - */ |
|
71 | - public function getAbsoluteBundlePath($uid = ''); |
|
64 | + /** |
|
65 | + * Get the full local path to the certificate bundle for this user |
|
66 | + * |
|
67 | + * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle |
|
68 | + * @return string |
|
69 | + * @since 9.0.0 |
|
70 | + */ |
|
71 | + public function getAbsoluteBundlePath($uid = ''); |
|
72 | 72 | } |