@@ -59,7 +59,7 @@ |
||
| 59 | 59 | * @return \Doctrine\DBAL\Driver\Statement The prepared statement. |
| 60 | 60 | * @since 6.0.0 |
| 61 | 61 | */ |
| 62 | - public function prepare($sql, $limit=null, $offset=null); |
|
| 62 | + public function prepare($sql, $limit = null, $offset = null); |
|
| 63 | 63 | |
| 64 | 64 | /** |
| 65 | 65 | * Executes an, optionally parameterized, SQL query. |
@@ -43,212 +43,212 @@ |
||
| 43 | 43 | * @since 6.0.0 |
| 44 | 44 | */ |
| 45 | 45 | interface IDBConnection { |
| 46 | - /** |
|
| 47 | - * Gets the QueryBuilder for the connection. |
|
| 48 | - * |
|
| 49 | - * @return \OCP\DB\QueryBuilder\IQueryBuilder |
|
| 50 | - * @since 8.2.0 |
|
| 51 | - */ |
|
| 52 | - public function getQueryBuilder(); |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * Used to abstract the ownCloud database access away |
|
| 56 | - * @param string $sql the sql query with ? placeholder for params |
|
| 57 | - * @param int $limit the maximum number of rows |
|
| 58 | - * @param int $offset from which row we want to start |
|
| 59 | - * @return \Doctrine\DBAL\Driver\Statement The prepared statement. |
|
| 60 | - * @since 6.0.0 |
|
| 61 | - */ |
|
| 62 | - public function prepare($sql, $limit=null, $offset=null); |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * Executes an, optionally parameterized, SQL query. |
|
| 66 | - * |
|
| 67 | - * If the query is parameterized, a prepared statement is used. |
|
| 68 | - * If an SQLLogger is configured, the execution is logged. |
|
| 69 | - * |
|
| 70 | - * @param string $query The SQL query to execute. |
|
| 71 | - * @param string[] $params The parameters to bind to the query, if any. |
|
| 72 | - * @param array $types The types the previous parameters are in. |
|
| 73 | - * @return \Doctrine\DBAL\Driver\Statement The executed statement. |
|
| 74 | - * @since 8.0.0 |
|
| 75 | - */ |
|
| 76 | - public function executeQuery($query, array $params = array(), $types = array()); |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters |
|
| 80 | - * and returns the number of affected rows. |
|
| 81 | - * |
|
| 82 | - * This method supports PDO binding types as well as DBAL mapping types. |
|
| 83 | - * |
|
| 84 | - * @param string $query The SQL query. |
|
| 85 | - * @param array $params The query parameters. |
|
| 86 | - * @param array $types The parameter types. |
|
| 87 | - * @return integer The number of affected rows. |
|
| 88 | - * @since 8.0.0 |
|
| 89 | - */ |
|
| 90 | - public function executeUpdate($query, array $params = array(), array $types = array()); |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * Used to get the id of the just inserted element |
|
| 94 | - * @param string $table the name of the table where we inserted the item |
|
| 95 | - * @return int the id of the inserted element |
|
| 96 | - * @since 6.0.0 |
|
| 97 | - */ |
|
| 98 | - public function lastInsertId($table = null); |
|
| 99 | - |
|
| 100 | - /** |
|
| 101 | - * Insert a row if the matching row does not exists. |
|
| 102 | - * |
|
| 103 | - * @param string $table The table name (will replace *PREFIX* with the actual prefix) |
|
| 104 | - * @param array $input data that should be inserted into the table (column name => value) |
|
| 105 | - * @param array|null $compare List of values that should be checked for "if not exists" |
|
| 106 | - * If this is null or an empty array, all keys of $input will be compared |
|
| 107 | - * Please note: text fields (clob) must not be used in the compare array |
|
| 108 | - * @return int number of inserted rows |
|
| 109 | - * @throws \Doctrine\DBAL\DBALException |
|
| 110 | - * @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0 |
|
| 111 | - */ |
|
| 112 | - public function insertIfNotExist($table, $input, array $compare = null); |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * Insert or update a row value |
|
| 116 | - * |
|
| 117 | - * @param string $table |
|
| 118 | - * @param array $keys (column name => value) |
|
| 119 | - * @param array $values (column name => value) |
|
| 120 | - * @param array $updatePreconditionValues ensure values match preconditions (column name => value) |
|
| 121 | - * @return int number of new rows |
|
| 122 | - * @throws \Doctrine\DBAL\DBALException |
|
| 123 | - * @throws PreconditionNotMetException |
|
| 124 | - * @since 9.0.0 |
|
| 125 | - */ |
|
| 126 | - public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []); |
|
| 127 | - |
|
| 128 | - /** |
|
| 129 | - * Create an exclusive read+write lock on a table |
|
| 130 | - * |
|
| 131 | - * Important Note: Due to the nature how locks work on different DBs, it is |
|
| 132 | - * only possible to lock one table at a time. You should also NOT start a |
|
| 133 | - * transaction while holding a lock. |
|
| 134 | - * |
|
| 135 | - * @param string $tableName |
|
| 136 | - * @since 9.1.0 |
|
| 137 | - */ |
|
| 138 | - public function lockTable($tableName); |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * Release a previous acquired lock again |
|
| 142 | - * |
|
| 143 | - * @since 9.1.0 |
|
| 144 | - */ |
|
| 145 | - public function unlockTable(); |
|
| 146 | - |
|
| 147 | - /** |
|
| 148 | - * Start a transaction |
|
| 149 | - * @since 6.0.0 |
|
| 150 | - */ |
|
| 151 | - public function beginTransaction(); |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * Check if a transaction is active |
|
| 155 | - * |
|
| 156 | - * @return bool |
|
| 157 | - * @since 8.2.0 |
|
| 158 | - */ |
|
| 159 | - public function inTransaction(); |
|
| 160 | - |
|
| 161 | - /** |
|
| 162 | - * Commit the database changes done during a transaction that is in progress |
|
| 163 | - * @since 6.0.0 |
|
| 164 | - */ |
|
| 165 | - public function commit(); |
|
| 166 | - |
|
| 167 | - /** |
|
| 168 | - * Rollback the database changes done during a transaction that is in progress |
|
| 169 | - * @since 6.0.0 |
|
| 170 | - */ |
|
| 171 | - public function rollBack(); |
|
| 172 | - |
|
| 173 | - /** |
|
| 174 | - * Gets the error code and message as a string for logging |
|
| 175 | - * @return string |
|
| 176 | - * @since 6.0.0 |
|
| 177 | - */ |
|
| 178 | - public function getError(); |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * Fetch the SQLSTATE associated with the last database operation. |
|
| 182 | - * |
|
| 183 | - * @return integer The last error code. |
|
| 184 | - * @since 8.0.0 |
|
| 185 | - */ |
|
| 186 | - public function errorCode(); |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Fetch extended error information associated with the last database operation. |
|
| 190 | - * |
|
| 191 | - * @return array The last error information. |
|
| 192 | - * @since 8.0.0 |
|
| 193 | - */ |
|
| 194 | - public function errorInfo(); |
|
| 195 | - |
|
| 196 | - /** |
|
| 197 | - * Establishes the connection with the database. |
|
| 198 | - * |
|
| 199 | - * @return bool |
|
| 200 | - * @since 8.0.0 |
|
| 201 | - */ |
|
| 202 | - public function connect(); |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * Close the database connection |
|
| 206 | - * @since 8.0.0 |
|
| 207 | - */ |
|
| 208 | - public function close(); |
|
| 209 | - |
|
| 210 | - /** |
|
| 211 | - * Quotes a given input parameter. |
|
| 212 | - * |
|
| 213 | - * @param mixed $input Parameter to be quoted. |
|
| 214 | - * @param int $type Type of the parameter. |
|
| 215 | - * @return string The quoted parameter. |
|
| 216 | - * @since 8.0.0 |
|
| 217 | - */ |
|
| 218 | - public function quote($input, $type = IQueryBuilder::PARAM_STR); |
|
| 219 | - |
|
| 220 | - /** |
|
| 221 | - * Gets the DatabasePlatform instance that provides all the metadata about |
|
| 222 | - * the platform this driver connects to. |
|
| 223 | - * |
|
| 224 | - * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform. |
|
| 225 | - * @since 8.0.0 |
|
| 226 | - */ |
|
| 227 | - public function getDatabasePlatform(); |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * Drop a table from the database if it exists |
|
| 231 | - * |
|
| 232 | - * @param string $table table name without the prefix |
|
| 233 | - * @since 8.0.0 |
|
| 234 | - */ |
|
| 235 | - public function dropTable($table); |
|
| 236 | - |
|
| 237 | - /** |
|
| 238 | - * Check if a table exists |
|
| 239 | - * |
|
| 240 | - * @param string $table table name without the prefix |
|
| 241 | - * @return bool |
|
| 242 | - * @since 8.0.0 |
|
| 243 | - */ |
|
| 244 | - public function tableExists($table); |
|
| 245 | - |
|
| 246 | - /** |
|
| 247 | - * Escape a parameter to be used in a LIKE query |
|
| 248 | - * |
|
| 249 | - * @param string $param |
|
| 250 | - * @return string |
|
| 251 | - * @since 9.0.0 |
|
| 252 | - */ |
|
| 253 | - public function escapeLikeParameter($param); |
|
| 46 | + /** |
|
| 47 | + * Gets the QueryBuilder for the connection. |
|
| 48 | + * |
|
| 49 | + * @return \OCP\DB\QueryBuilder\IQueryBuilder |
|
| 50 | + * @since 8.2.0 |
|
| 51 | + */ |
|
| 52 | + public function getQueryBuilder(); |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * Used to abstract the ownCloud database access away |
|
| 56 | + * @param string $sql the sql query with ? placeholder for params |
|
| 57 | + * @param int $limit the maximum number of rows |
|
| 58 | + * @param int $offset from which row we want to start |
|
| 59 | + * @return \Doctrine\DBAL\Driver\Statement The prepared statement. |
|
| 60 | + * @since 6.0.0 |
|
| 61 | + */ |
|
| 62 | + public function prepare($sql, $limit=null, $offset=null); |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * Executes an, optionally parameterized, SQL query. |
|
| 66 | + * |
|
| 67 | + * If the query is parameterized, a prepared statement is used. |
|
| 68 | + * If an SQLLogger is configured, the execution is logged. |
|
| 69 | + * |
|
| 70 | + * @param string $query The SQL query to execute. |
|
| 71 | + * @param string[] $params The parameters to bind to the query, if any. |
|
| 72 | + * @param array $types The types the previous parameters are in. |
|
| 73 | + * @return \Doctrine\DBAL\Driver\Statement The executed statement. |
|
| 74 | + * @since 8.0.0 |
|
| 75 | + */ |
|
| 76 | + public function executeQuery($query, array $params = array(), $types = array()); |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters |
|
| 80 | + * and returns the number of affected rows. |
|
| 81 | + * |
|
| 82 | + * This method supports PDO binding types as well as DBAL mapping types. |
|
| 83 | + * |
|
| 84 | + * @param string $query The SQL query. |
|
| 85 | + * @param array $params The query parameters. |
|
| 86 | + * @param array $types The parameter types. |
|
| 87 | + * @return integer The number of affected rows. |
|
| 88 | + * @since 8.0.0 |
|
| 89 | + */ |
|
| 90 | + public function executeUpdate($query, array $params = array(), array $types = array()); |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * Used to get the id of the just inserted element |
|
| 94 | + * @param string $table the name of the table where we inserted the item |
|
| 95 | + * @return int the id of the inserted element |
|
| 96 | + * @since 6.0.0 |
|
| 97 | + */ |
|
| 98 | + public function lastInsertId($table = null); |
|
| 99 | + |
|
| 100 | + /** |
|
| 101 | + * Insert a row if the matching row does not exists. |
|
| 102 | + * |
|
| 103 | + * @param string $table The table name (will replace *PREFIX* with the actual prefix) |
|
| 104 | + * @param array $input data that should be inserted into the table (column name => value) |
|
| 105 | + * @param array|null $compare List of values that should be checked for "if not exists" |
|
| 106 | + * If this is null or an empty array, all keys of $input will be compared |
|
| 107 | + * Please note: text fields (clob) must not be used in the compare array |
|
| 108 | + * @return int number of inserted rows |
|
| 109 | + * @throws \Doctrine\DBAL\DBALException |
|
| 110 | + * @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0 |
|
| 111 | + */ |
|
| 112 | + public function insertIfNotExist($table, $input, array $compare = null); |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * Insert or update a row value |
|
| 116 | + * |
|
| 117 | + * @param string $table |
|
| 118 | + * @param array $keys (column name => value) |
|
| 119 | + * @param array $values (column name => value) |
|
| 120 | + * @param array $updatePreconditionValues ensure values match preconditions (column name => value) |
|
| 121 | + * @return int number of new rows |
|
| 122 | + * @throws \Doctrine\DBAL\DBALException |
|
| 123 | + * @throws PreconditionNotMetException |
|
| 124 | + * @since 9.0.0 |
|
| 125 | + */ |
|
| 126 | + public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []); |
|
| 127 | + |
|
| 128 | + /** |
|
| 129 | + * Create an exclusive read+write lock on a table |
|
| 130 | + * |
|
| 131 | + * Important Note: Due to the nature how locks work on different DBs, it is |
|
| 132 | + * only possible to lock one table at a time. You should also NOT start a |
|
| 133 | + * transaction while holding a lock. |
|
| 134 | + * |
|
| 135 | + * @param string $tableName |
|
| 136 | + * @since 9.1.0 |
|
| 137 | + */ |
|
| 138 | + public function lockTable($tableName); |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * Release a previous acquired lock again |
|
| 142 | + * |
|
| 143 | + * @since 9.1.0 |
|
| 144 | + */ |
|
| 145 | + public function unlockTable(); |
|
| 146 | + |
|
| 147 | + /** |
|
| 148 | + * Start a transaction |
|
| 149 | + * @since 6.0.0 |
|
| 150 | + */ |
|
| 151 | + public function beginTransaction(); |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * Check if a transaction is active |
|
| 155 | + * |
|
| 156 | + * @return bool |
|
| 157 | + * @since 8.2.0 |
|
| 158 | + */ |
|
| 159 | + public function inTransaction(); |
|
| 160 | + |
|
| 161 | + /** |
|
| 162 | + * Commit the database changes done during a transaction that is in progress |
|
| 163 | + * @since 6.0.0 |
|
| 164 | + */ |
|
| 165 | + public function commit(); |
|
| 166 | + |
|
| 167 | + /** |
|
| 168 | + * Rollback the database changes done during a transaction that is in progress |
|
| 169 | + * @since 6.0.0 |
|
| 170 | + */ |
|
| 171 | + public function rollBack(); |
|
| 172 | + |
|
| 173 | + /** |
|
| 174 | + * Gets the error code and message as a string for logging |
|
| 175 | + * @return string |
|
| 176 | + * @since 6.0.0 |
|
| 177 | + */ |
|
| 178 | + public function getError(); |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * Fetch the SQLSTATE associated with the last database operation. |
|
| 182 | + * |
|
| 183 | + * @return integer The last error code. |
|
| 184 | + * @since 8.0.0 |
|
| 185 | + */ |
|
| 186 | + public function errorCode(); |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Fetch extended error information associated with the last database operation. |
|
| 190 | + * |
|
| 191 | + * @return array The last error information. |
|
| 192 | + * @since 8.0.0 |
|
| 193 | + */ |
|
| 194 | + public function errorInfo(); |
|
| 195 | + |
|
| 196 | + /** |
|
| 197 | + * Establishes the connection with the database. |
|
| 198 | + * |
|
| 199 | + * @return bool |
|
| 200 | + * @since 8.0.0 |
|
| 201 | + */ |
|
| 202 | + public function connect(); |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * Close the database connection |
|
| 206 | + * @since 8.0.0 |
|
| 207 | + */ |
|
| 208 | + public function close(); |
|
| 209 | + |
|
| 210 | + /** |
|
| 211 | + * Quotes a given input parameter. |
|
| 212 | + * |
|
| 213 | + * @param mixed $input Parameter to be quoted. |
|
| 214 | + * @param int $type Type of the parameter. |
|
| 215 | + * @return string The quoted parameter. |
|
| 216 | + * @since 8.0.0 |
|
| 217 | + */ |
|
| 218 | + public function quote($input, $type = IQueryBuilder::PARAM_STR); |
|
| 219 | + |
|
| 220 | + /** |
|
| 221 | + * Gets the DatabasePlatform instance that provides all the metadata about |
|
| 222 | + * the platform this driver connects to. |
|
| 223 | + * |
|
| 224 | + * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform. |
|
| 225 | + * @since 8.0.0 |
|
| 226 | + */ |
|
| 227 | + public function getDatabasePlatform(); |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * Drop a table from the database if it exists |
|
| 231 | + * |
|
| 232 | + * @param string $table table name without the prefix |
|
| 233 | + * @since 8.0.0 |
|
| 234 | + */ |
|
| 235 | + public function dropTable($table); |
|
| 236 | + |
|
| 237 | + /** |
|
| 238 | + * Check if a table exists |
|
| 239 | + * |
|
| 240 | + * @param string $table table name without the prefix |
|
| 241 | + * @return bool |
|
| 242 | + * @since 8.0.0 |
|
| 243 | + */ |
|
| 244 | + public function tableExists($table); |
|
| 245 | + |
|
| 246 | + /** |
|
| 247 | + * Escape a parameter to be used in a LIKE query |
|
| 248 | + * |
|
| 249 | + * @param string $param |
|
| 250 | + * @return string |
|
| 251 | + * @since 9.0.0 |
|
| 252 | + */ |
|
| 253 | + public function escapeLikeParameter($param); |
|
| 254 | 254 | } |
@@ -46,112 +46,112 @@ |
||
| 46 | 46 | * @since 5.0.0 |
| 47 | 47 | */ |
| 48 | 48 | class User { |
| 49 | - /** |
|
| 50 | - * Get the user id of the user currently logged in. |
|
| 51 | - * @return string uid or false |
|
| 52 | - * @deprecated 8.0.0 Use \OC::$server->getUserSession()->getUser()->getUID() |
|
| 53 | - * @since 5.0.0 |
|
| 54 | - */ |
|
| 55 | - public static function getUser() { |
|
| 56 | - return \OC_User::getUser(); |
|
| 57 | - } |
|
| 49 | + /** |
|
| 50 | + * Get the user id of the user currently logged in. |
|
| 51 | + * @return string uid or false |
|
| 52 | + * @deprecated 8.0.0 Use \OC::$server->getUserSession()->getUser()->getUID() |
|
| 53 | + * @since 5.0.0 |
|
| 54 | + */ |
|
| 55 | + public static function getUser() { |
|
| 56 | + return \OC_User::getUser(); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Get a list of all users |
|
| 61 | - * @param string $search search pattern |
|
| 62 | - * @param int|null $limit |
|
| 63 | - * @param int|null $offset |
|
| 64 | - * @return array an array of all uids |
|
| 65 | - * @deprecated 8.1.0 use method search() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
| 66 | - * @since 5.0.0 |
|
| 67 | - */ |
|
| 68 | - public static function getUsers( $search = '', $limit = null, $offset = null ) { |
|
| 69 | - return \OC_User::getUsers( $search, $limit, $offset ); |
|
| 70 | - } |
|
| 59 | + /** |
|
| 60 | + * Get a list of all users |
|
| 61 | + * @param string $search search pattern |
|
| 62 | + * @param int|null $limit |
|
| 63 | + * @param int|null $offset |
|
| 64 | + * @return array an array of all uids |
|
| 65 | + * @deprecated 8.1.0 use method search() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
| 66 | + * @since 5.0.0 |
|
| 67 | + */ |
|
| 68 | + public static function getUsers( $search = '', $limit = null, $offset = null ) { |
|
| 69 | + return \OC_User::getUsers( $search, $limit, $offset ); |
|
| 70 | + } |
|
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * Get the user display name of the user currently logged in. |
|
| 74 | - * @param string|null $user user id or null for current user |
|
| 75 | - * @return string display name |
|
| 76 | - * @deprecated 8.1.0 fetch \OCP\IUser (has getDisplayName()) by using method |
|
| 77 | - * get() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
| 78 | - * @since 5.0.0 |
|
| 79 | - */ |
|
| 80 | - public static function getDisplayName( $user = null ) { |
|
| 81 | - return \OC_User::getDisplayName( $user ); |
|
| 82 | - } |
|
| 72 | + /** |
|
| 73 | + * Get the user display name of the user currently logged in. |
|
| 74 | + * @param string|null $user user id or null for current user |
|
| 75 | + * @return string display name |
|
| 76 | + * @deprecated 8.1.0 fetch \OCP\IUser (has getDisplayName()) by using method |
|
| 77 | + * get() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
| 78 | + * @since 5.0.0 |
|
| 79 | + */ |
|
| 80 | + public static function getDisplayName( $user = null ) { |
|
| 81 | + return \OC_User::getDisplayName( $user ); |
|
| 82 | + } |
|
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Get a list of all display names and user ids. |
|
| 86 | - * @param string $search search pattern |
|
| 87 | - * @param int|null $limit |
|
| 88 | - * @param int|null $offset |
|
| 89 | - * @return array an array of all display names (value) and the correspondig uids (key) |
|
| 90 | - * @deprecated 8.1.0 use method searchDisplayName() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
| 91 | - * @since 5.0.0 |
|
| 92 | - */ |
|
| 93 | - public static function getDisplayNames( $search = '', $limit = null, $offset = null ) { |
|
| 94 | - return \OC_User::getDisplayNames( $search, $limit, $offset ); |
|
| 95 | - } |
|
| 84 | + /** |
|
| 85 | + * Get a list of all display names and user ids. |
|
| 86 | + * @param string $search search pattern |
|
| 87 | + * @param int|null $limit |
|
| 88 | + * @param int|null $offset |
|
| 89 | + * @return array an array of all display names (value) and the correspondig uids (key) |
|
| 90 | + * @deprecated 8.1.0 use method searchDisplayName() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
| 91 | + * @since 5.0.0 |
|
| 92 | + */ |
|
| 93 | + public static function getDisplayNames( $search = '', $limit = null, $offset = null ) { |
|
| 94 | + return \OC_User::getDisplayNames( $search, $limit, $offset ); |
|
| 95 | + } |
|
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * Check if the user is logged in |
|
| 99 | - * @return boolean |
|
| 100 | - * @since 5.0.0 |
|
| 101 | - */ |
|
| 102 | - public static function isLoggedIn() { |
|
| 103 | - return \OC_User::isLoggedIn(); |
|
| 104 | - } |
|
| 97 | + /** |
|
| 98 | + * Check if the user is logged in |
|
| 99 | + * @return boolean |
|
| 100 | + * @since 5.0.0 |
|
| 101 | + */ |
|
| 102 | + public static function isLoggedIn() { |
|
| 103 | + return \OC_User::isLoggedIn(); |
|
| 104 | + } |
|
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * Check if a user exists |
|
| 108 | - * @param string $uid the username |
|
| 109 | - * @param string $excludingBackend (default none) |
|
| 110 | - * @return boolean |
|
| 111 | - * @deprecated 8.1.0 use method userExists() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
| 112 | - * @since 5.0.0 |
|
| 113 | - */ |
|
| 114 | - public static function userExists( $uid, $excludingBackend = null ) { |
|
| 115 | - return \OC_User::userExists( $uid, $excludingBackend ); |
|
| 116 | - } |
|
| 117 | - /** |
|
| 118 | - * Logs the user out including all the session data |
|
| 119 | - * Logout, destroys session |
|
| 120 | - * @deprecated 8.0.0 Use \OC::$server->getUserSession()->logout(); |
|
| 121 | - * @since 5.0.0 |
|
| 122 | - */ |
|
| 123 | - public static function logout() { |
|
| 124 | - \OC::$server->getUserSession()->logout(); |
|
| 125 | - } |
|
| 106 | + /** |
|
| 107 | + * Check if a user exists |
|
| 108 | + * @param string $uid the username |
|
| 109 | + * @param string $excludingBackend (default none) |
|
| 110 | + * @return boolean |
|
| 111 | + * @deprecated 8.1.0 use method userExists() of \OCP\IUserManager - \OC::$server->getUserManager() |
|
| 112 | + * @since 5.0.0 |
|
| 113 | + */ |
|
| 114 | + public static function userExists( $uid, $excludingBackend = null ) { |
|
| 115 | + return \OC_User::userExists( $uid, $excludingBackend ); |
|
| 116 | + } |
|
| 117 | + /** |
|
| 118 | + * Logs the user out including all the session data |
|
| 119 | + * Logout, destroys session |
|
| 120 | + * @deprecated 8.0.0 Use \OC::$server->getUserSession()->logout(); |
|
| 121 | + * @since 5.0.0 |
|
| 122 | + */ |
|
| 123 | + public static function logout() { |
|
| 124 | + \OC::$server->getUserSession()->logout(); |
|
| 125 | + } |
|
| 126 | 126 | |
| 127 | - /** |
|
| 128 | - * Check if the password is correct |
|
| 129 | - * @param string $uid The username |
|
| 130 | - * @param string $password The password |
|
| 131 | - * @return string|false username on success, false otherwise |
|
| 132 | - * |
|
| 133 | - * Check if the password is correct without logging in the user |
|
| 134 | - * @deprecated 8.0.0 Use \OC::$server->getUserManager()->checkPassword(); |
|
| 135 | - * @since 5.0.0 |
|
| 136 | - */ |
|
| 137 | - public static function checkPassword( $uid, $password ) { |
|
| 138 | - return \OC_User::checkPassword( $uid, $password ); |
|
| 139 | - } |
|
| 127 | + /** |
|
| 128 | + * Check if the password is correct |
|
| 129 | + * @param string $uid The username |
|
| 130 | + * @param string $password The password |
|
| 131 | + * @return string|false username on success, false otherwise |
|
| 132 | + * |
|
| 133 | + * Check if the password is correct without logging in the user |
|
| 134 | + * @deprecated 8.0.0 Use \OC::$server->getUserManager()->checkPassword(); |
|
| 135 | + * @since 5.0.0 |
|
| 136 | + */ |
|
| 137 | + public static function checkPassword( $uid, $password ) { |
|
| 138 | + return \OC_User::checkPassword( $uid, $password ); |
|
| 139 | + } |
|
| 140 | 140 | |
| 141 | - /** |
|
| 142 | - * Check if the user is a admin, redirects to home if not |
|
| 143 | - * @since 5.0.0 |
|
| 144 | - */ |
|
| 145 | - public static function checkAdminUser() { |
|
| 146 | - \OC_Util::checkAdminUser(); |
|
| 147 | - } |
|
| 141 | + /** |
|
| 142 | + * Check if the user is a admin, redirects to home if not |
|
| 143 | + * @since 5.0.0 |
|
| 144 | + */ |
|
| 145 | + public static function checkAdminUser() { |
|
| 146 | + \OC_Util::checkAdminUser(); |
|
| 147 | + } |
|
| 148 | 148 | |
| 149 | - /** |
|
| 150 | - * Check if the user is logged in, redirects to home if not. With |
|
| 151 | - * redirect URL parameter to the request URI. |
|
| 152 | - * @since 5.0.0 |
|
| 153 | - */ |
|
| 154 | - public static function checkLoggedIn() { |
|
| 155 | - \OC_Util::checkLoggedIn(); |
|
| 156 | - } |
|
| 149 | + /** |
|
| 150 | + * Check if the user is logged in, redirects to home if not. With |
|
| 151 | + * redirect URL parameter to the request URI. |
|
| 152 | + * @since 5.0.0 |
|
| 153 | + */ |
|
| 154 | + public static function checkLoggedIn() { |
|
| 155 | + \OC_Util::checkLoggedIn(); |
|
| 156 | + } |
|
| 157 | 157 | } |
@@ -65,8 +65,8 @@ discard block |
||
| 65 | 65 | * @deprecated 8.1.0 use method search() of \OCP\IUserManager - \OC::$server->getUserManager() |
| 66 | 66 | * @since 5.0.0 |
| 67 | 67 | */ |
| 68 | - public static function getUsers( $search = '', $limit = null, $offset = null ) { |
|
| 69 | - return \OC_User::getUsers( $search, $limit, $offset ); |
|
| 68 | + public static function getUsers($search = '', $limit = null, $offset = null) { |
|
| 69 | + return \OC_User::getUsers($search, $limit, $offset); |
|
| 70 | 70 | } |
| 71 | 71 | |
| 72 | 72 | /** |
@@ -77,8 +77,8 @@ discard block |
||
| 77 | 77 | * get() of \OCP\IUserManager - \OC::$server->getUserManager() |
| 78 | 78 | * @since 5.0.0 |
| 79 | 79 | */ |
| 80 | - public static function getDisplayName( $user = null ) { |
|
| 81 | - return \OC_User::getDisplayName( $user ); |
|
| 80 | + public static function getDisplayName($user = null) { |
|
| 81 | + return \OC_User::getDisplayName($user); |
|
| 82 | 82 | } |
| 83 | 83 | |
| 84 | 84 | /** |
@@ -90,8 +90,8 @@ discard block |
||
| 90 | 90 | * @deprecated 8.1.0 use method searchDisplayName() of \OCP\IUserManager - \OC::$server->getUserManager() |
| 91 | 91 | * @since 5.0.0 |
| 92 | 92 | */ |
| 93 | - public static function getDisplayNames( $search = '', $limit = null, $offset = null ) { |
|
| 94 | - return \OC_User::getDisplayNames( $search, $limit, $offset ); |
|
| 93 | + public static function getDisplayNames($search = '', $limit = null, $offset = null) { |
|
| 94 | + return \OC_User::getDisplayNames($search, $limit, $offset); |
|
| 95 | 95 | } |
| 96 | 96 | |
| 97 | 97 | /** |
@@ -111,8 +111,8 @@ discard block |
||
| 111 | 111 | * @deprecated 8.1.0 use method userExists() of \OCP\IUserManager - \OC::$server->getUserManager() |
| 112 | 112 | * @since 5.0.0 |
| 113 | 113 | */ |
| 114 | - public static function userExists( $uid, $excludingBackend = null ) { |
|
| 115 | - return \OC_User::userExists( $uid, $excludingBackend ); |
|
| 114 | + public static function userExists($uid, $excludingBackend = null) { |
|
| 115 | + return \OC_User::userExists($uid, $excludingBackend); |
|
| 116 | 116 | } |
| 117 | 117 | /** |
| 118 | 118 | * Logs the user out including all the session data |
@@ -134,8 +134,8 @@ discard block |
||
| 134 | 134 | * @deprecated 8.0.0 Use \OC::$server->getUserManager()->checkPassword(); |
| 135 | 135 | * @since 5.0.0 |
| 136 | 136 | */ |
| 137 | - public static function checkPassword( $uid, $password ) { |
|
| 138 | - return \OC_User::checkPassword( $uid, $password ); |
|
| 137 | + public static function checkPassword($uid, $password) { |
|
| 138 | + return \OC_User::checkPassword($uid, $password); |
|
| 139 | 139 | } |
| 140 | 140 | |
| 141 | 141 | /** |
@@ -42,11 +42,11 @@ |
||
| 42 | 42 | const METHOD_STREAM = 'stream'; |
| 43 | 43 | const METHOD_MAIL = 'email'; |
| 44 | 44 | |
| 45 | - const PRIORITY_VERYLOW = 10; |
|
| 46 | - const PRIORITY_LOW = 20; |
|
| 47 | - const PRIORITY_MEDIUM = 30; |
|
| 48 | - const PRIORITY_HIGH = 40; |
|
| 49 | - const PRIORITY_VERYHIGH = 50; |
|
| 45 | + const PRIORITY_VERYLOW = 10; |
|
| 46 | + const PRIORITY_LOW = 20; |
|
| 47 | + const PRIORITY_MEDIUM = 30; |
|
| 48 | + const PRIORITY_HIGH = 40; |
|
| 49 | + const PRIORITY_VERYHIGH = 50; |
|
| 50 | 50 | |
| 51 | 51 | /** |
| 52 | 52 | * The extension can return an array of additional notification types. |
@@ -39,127 +39,127 @@ |
||
| 39 | 39 | * @since 8.0.0 |
| 40 | 40 | */ |
| 41 | 41 | interface IExtension { |
| 42 | - const METHOD_STREAM = 'stream'; |
|
| 43 | - const METHOD_MAIL = 'email'; |
|
| 42 | + const METHOD_STREAM = 'stream'; |
|
| 43 | + const METHOD_MAIL = 'email'; |
|
| 44 | 44 | |
| 45 | - const PRIORITY_VERYLOW = 10; |
|
| 46 | - const PRIORITY_LOW = 20; |
|
| 47 | - const PRIORITY_MEDIUM = 30; |
|
| 48 | - const PRIORITY_HIGH = 40; |
|
| 49 | - const PRIORITY_VERYHIGH = 50; |
|
| 45 | + const PRIORITY_VERYLOW = 10; |
|
| 46 | + const PRIORITY_LOW = 20; |
|
| 47 | + const PRIORITY_MEDIUM = 30; |
|
| 48 | + const PRIORITY_HIGH = 40; |
|
| 49 | + const PRIORITY_VERYHIGH = 50; |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * The extension can return an array of additional notification types. |
|
| 53 | - * If no additional types are to be added false is to be returned |
|
| 54 | - * |
|
| 55 | - * @param string $languageCode |
|
| 56 | - * @return array|false Array "stringID of the type" => "translated string description for the setting" |
|
| 57 | - * or Array "stringID of the type" => [ |
|
| 58 | - * 'desc' => "translated string description for the setting" |
|
| 59 | - * 'methods' => [self::METHOD_*], |
|
| 60 | - * ] |
|
| 61 | - * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods |
|
| 62 | - */ |
|
| 63 | - public function getNotificationTypes($languageCode); |
|
| 51 | + /** |
|
| 52 | + * The extension can return an array of additional notification types. |
|
| 53 | + * If no additional types are to be added false is to be returned |
|
| 54 | + * |
|
| 55 | + * @param string $languageCode |
|
| 56 | + * @return array|false Array "stringID of the type" => "translated string description for the setting" |
|
| 57 | + * or Array "stringID of the type" => [ |
|
| 58 | + * 'desc' => "translated string description for the setting" |
|
| 59 | + * 'methods' => [self::METHOD_*], |
|
| 60 | + * ] |
|
| 61 | + * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods |
|
| 62 | + */ |
|
| 63 | + public function getNotificationTypes($languageCode); |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * For a given method additional types to be displayed in the settings can be returned. |
|
| 67 | - * In case no additional types are to be added false is to be returned. |
|
| 68 | - * |
|
| 69 | - * @param string $method |
|
| 70 | - * @return array|false |
|
| 71 | - * @since 8.0.0 |
|
| 72 | - */ |
|
| 73 | - public function getDefaultTypes($method); |
|
| 65 | + /** |
|
| 66 | + * For a given method additional types to be displayed in the settings can be returned. |
|
| 67 | + * In case no additional types are to be added false is to be returned. |
|
| 68 | + * |
|
| 69 | + * @param string $method |
|
| 70 | + * @return array|false |
|
| 71 | + * @since 8.0.0 |
|
| 72 | + */ |
|
| 73 | + public function getDefaultTypes($method); |
|
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * A string naming the css class for the icon to be used can be returned. |
|
| 77 | - * If no icon is known for the given type false is to be returned. |
|
| 78 | - * |
|
| 79 | - * @param string $type |
|
| 80 | - * @return string|false |
|
| 81 | - * @since 8.0.0 |
|
| 82 | - */ |
|
| 83 | - public function getTypeIcon($type); |
|
| 75 | + /** |
|
| 76 | + * A string naming the css class for the icon to be used can be returned. |
|
| 77 | + * If no icon is known for the given type false is to be returned. |
|
| 78 | + * |
|
| 79 | + * @param string $type |
|
| 80 | + * @return string|false |
|
| 81 | + * @since 8.0.0 |
|
| 82 | + */ |
|
| 83 | + public function getTypeIcon($type); |
|
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * The extension can translate a given message to the requested languages. |
|
| 87 | - * If no translation is available false is to be returned. |
|
| 88 | - * |
|
| 89 | - * @param string $app |
|
| 90 | - * @param string $text |
|
| 91 | - * @param array $params |
|
| 92 | - * @param boolean $stripPath |
|
| 93 | - * @param boolean $highlightParams |
|
| 94 | - * @param string $languageCode |
|
| 95 | - * @return string|false |
|
| 96 | - * @since 8.0.0 |
|
| 97 | - */ |
|
| 98 | - public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); |
|
| 85 | + /** |
|
| 86 | + * The extension can translate a given message to the requested languages. |
|
| 87 | + * If no translation is available false is to be returned. |
|
| 88 | + * |
|
| 89 | + * @param string $app |
|
| 90 | + * @param string $text |
|
| 91 | + * @param array $params |
|
| 92 | + * @param boolean $stripPath |
|
| 93 | + * @param boolean $highlightParams |
|
| 94 | + * @param string $languageCode |
|
| 95 | + * @return string|false |
|
| 96 | + * @since 8.0.0 |
|
| 97 | + */ |
|
| 98 | + public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); |
|
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * The extension can define the type of parameters for translation |
|
| 102 | - * |
|
| 103 | - * Currently known types are: |
|
| 104 | - * * file => will strip away the path of the file and add a tooltip with it |
|
| 105 | - * * username => will add the avatar of the user |
|
| 106 | - * |
|
| 107 | - * @param string $app |
|
| 108 | - * @param string $text |
|
| 109 | - * @return array|false |
|
| 110 | - * @since 8.0.0 |
|
| 111 | - */ |
|
| 112 | - public function getSpecialParameterList($app, $text); |
|
| 100 | + /** |
|
| 101 | + * The extension can define the type of parameters for translation |
|
| 102 | + * |
|
| 103 | + * Currently known types are: |
|
| 104 | + * * file => will strip away the path of the file and add a tooltip with it |
|
| 105 | + * * username => will add the avatar of the user |
|
| 106 | + * |
|
| 107 | + * @param string $app |
|
| 108 | + * @param string $text |
|
| 109 | + * @return array|false |
|
| 110 | + * @since 8.0.0 |
|
| 111 | + */ |
|
| 112 | + public function getSpecialParameterList($app, $text); |
|
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * The extension can define the parameter grouping by returning the index as integer. |
|
| 116 | - * In case no grouping is required false is to be returned. |
|
| 117 | - * |
|
| 118 | - * @param array $activity |
|
| 119 | - * @return integer|false |
|
| 120 | - * @since 8.0.0 |
|
| 121 | - */ |
|
| 122 | - public function getGroupParameter($activity); |
|
| 114 | + /** |
|
| 115 | + * The extension can define the parameter grouping by returning the index as integer. |
|
| 116 | + * In case no grouping is required false is to be returned. |
|
| 117 | + * |
|
| 118 | + * @param array $activity |
|
| 119 | + * @return integer|false |
|
| 120 | + * @since 8.0.0 |
|
| 121 | + */ |
|
| 122 | + public function getGroupParameter($activity); |
|
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * The extension can define additional navigation entries. The array returned has to contain two keys 'top' |
|
| 126 | - * and 'apps' which hold arrays with the relevant entries. |
|
| 127 | - * If no further entries are to be added false is no be returned. |
|
| 128 | - * |
|
| 129 | - * @return array|false |
|
| 130 | - * @since 8.0.0 |
|
| 131 | - */ |
|
| 132 | - public function getNavigation(); |
|
| 124 | + /** |
|
| 125 | + * The extension can define additional navigation entries. The array returned has to contain two keys 'top' |
|
| 126 | + * and 'apps' which hold arrays with the relevant entries. |
|
| 127 | + * If no further entries are to be added false is no be returned. |
|
| 128 | + * |
|
| 129 | + * @return array|false |
|
| 130 | + * @since 8.0.0 |
|
| 131 | + */ |
|
| 132 | + public function getNavigation(); |
|
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not. |
|
| 136 | - * |
|
| 137 | - * @param string $filterValue |
|
| 138 | - * @return boolean |
|
| 139 | - * @since 8.0.0 |
|
| 140 | - */ |
|
| 141 | - public function isFilterValid($filterValue); |
|
| 134 | + /** |
|
| 135 | + * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not. |
|
| 136 | + * |
|
| 137 | + * @param string $filterValue |
|
| 138 | + * @return boolean |
|
| 139 | + * @since 8.0.0 |
|
| 140 | + */ |
|
| 141 | + public function isFilterValid($filterValue); |
|
| 142 | 142 | |
| 143 | - /** |
|
| 144 | - * The extension can filter the types based on the filter if required. |
|
| 145 | - * In case no filter is to be applied false is to be returned unchanged. |
|
| 146 | - * |
|
| 147 | - * @param array $types |
|
| 148 | - * @param string $filter |
|
| 149 | - * @return array|false |
|
| 150 | - * @since 8.0.0 |
|
| 151 | - */ |
|
| 152 | - public function filterNotificationTypes($types, $filter); |
|
| 143 | + /** |
|
| 144 | + * The extension can filter the types based on the filter if required. |
|
| 145 | + * In case no filter is to be applied false is to be returned unchanged. |
|
| 146 | + * |
|
| 147 | + * @param array $types |
|
| 148 | + * @param string $filter |
|
| 149 | + * @return array|false |
|
| 150 | + * @since 8.0.0 |
|
| 151 | + */ |
|
| 152 | + public function filterNotificationTypes($types, $filter); |
|
| 153 | 153 | |
| 154 | - /** |
|
| 155 | - * For a given filter the extension can specify the sql query conditions including parameters for that query. |
|
| 156 | - * In case the extension does not know the filter false is to be returned. |
|
| 157 | - * The query condition and the parameters are to be returned as array with two elements. |
|
| 158 | - * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%')); |
|
| 159 | - * |
|
| 160 | - * @param string $filter |
|
| 161 | - * @return array|false |
|
| 162 | - * @since 8.0.0 |
|
| 163 | - */ |
|
| 164 | - public function getQueryForFilter($filter); |
|
| 154 | + /** |
|
| 155 | + * For a given filter the extension can specify the sql query conditions including parameters for that query. |
|
| 156 | + * In case the extension does not know the filter false is to be returned. |
|
| 157 | + * The query condition and the parameters are to be returned as array with two elements. |
|
| 158 | + * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%')); |
|
| 159 | + * |
|
| 160 | + * @param string $filter |
|
| 161 | + * @return array|false |
|
| 162 | + * @since 8.0.0 |
|
| 163 | + */ |
|
| 164 | + public function getQueryForFilter($filter); |
|
| 165 | 165 | } |
@@ -38,12 +38,12 @@ |
||
| 38 | 38 | * @since 6.0.0 |
| 39 | 39 | */ |
| 40 | 40 | interface IConsumer { |
| 41 | - /** |
|
| 42 | - * @param IEvent $event |
|
| 43 | - * @return null |
|
| 44 | - * @since 6.0.0 |
|
| 45 | - * @since 8.2.0 Replaced the parameters with an IEvent object |
|
| 46 | - */ |
|
| 47 | - public function receive(IEvent $event); |
|
| 41 | + /** |
|
| 42 | + * @param IEvent $event |
|
| 43 | + * @return null |
|
| 44 | + * @since 6.0.0 |
|
| 45 | + * @since 8.2.0 Replaced the parameters with an IEvent object |
|
| 46 | + */ |
|
| 47 | + public function receive(IEvent $event); |
|
| 48 | 48 | } |
| 49 | 49 | |
@@ -29,12 +29,12 @@ |
||
| 29 | 29 | * @since 8.2.2 |
| 30 | 30 | */ |
| 31 | 31 | interface IMemcacheTTL extends IMemcache { |
| 32 | - /** |
|
| 33 | - * Set the ttl for an existing value |
|
| 34 | - * |
|
| 35 | - * @param string $key |
|
| 36 | - * @param int $ttl time to live in seconds |
|
| 37 | - * @since 8.2.2 |
|
| 38 | - */ |
|
| 39 | - public function setTTL($key, $ttl); |
|
| 32 | + /** |
|
| 33 | + * Set the ttl for an existing value |
|
| 34 | + * |
|
| 35 | + * @param string $key |
|
| 36 | + * @param int $ttl time to live in seconds |
|
| 37 | + * @since 8.2.2 |
|
| 38 | + */ |
|
| 39 | + public function setTTL($key, $ttl); |
|
| 40 | 40 | } |
@@ -40,44 +40,44 @@ |
||
| 40 | 40 | * @since 6.0.0 |
| 41 | 41 | */ |
| 42 | 42 | interface IUserSession { |
| 43 | - /** |
|
| 44 | - * Do a user login |
|
| 45 | - * @param string $user the username |
|
| 46 | - * @param string $password the password |
|
| 47 | - * @return bool true if successful |
|
| 48 | - * @since 6.0.0 |
|
| 49 | - */ |
|
| 50 | - public function login($user, $password); |
|
| 43 | + /** |
|
| 44 | + * Do a user login |
|
| 45 | + * @param string $user the username |
|
| 46 | + * @param string $password the password |
|
| 47 | + * @return bool true if successful |
|
| 48 | + * @since 6.0.0 |
|
| 49 | + */ |
|
| 50 | + public function login($user, $password); |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * Logs the user out including all the session data |
|
| 54 | - * Logout, destroys session |
|
| 55 | - * @return void |
|
| 56 | - * @since 6.0.0 |
|
| 57 | - */ |
|
| 58 | - public function logout(); |
|
| 52 | + /** |
|
| 53 | + * Logs the user out including all the session data |
|
| 54 | + * Logout, destroys session |
|
| 55 | + * @return void |
|
| 56 | + * @since 6.0.0 |
|
| 57 | + */ |
|
| 58 | + public function logout(); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * set the currently active user |
|
| 62 | - * |
|
| 63 | - * @param \OCP\IUser|null $user |
|
| 64 | - * @since 8.0.0 |
|
| 65 | - */ |
|
| 66 | - public function setUser($user); |
|
| 60 | + /** |
|
| 61 | + * set the currently active user |
|
| 62 | + * |
|
| 63 | + * @param \OCP\IUser|null $user |
|
| 64 | + * @since 8.0.0 |
|
| 65 | + */ |
|
| 66 | + public function setUser($user); |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * get the current active user |
|
| 70 | - * |
|
| 71 | - * @return \OCP\IUser|null Current user, otherwise null |
|
| 72 | - * @since 8.0.0 |
|
| 73 | - */ |
|
| 74 | - public function getUser(); |
|
| 68 | + /** |
|
| 69 | + * get the current active user |
|
| 70 | + * |
|
| 71 | + * @return \OCP\IUser|null Current user, otherwise null |
|
| 72 | + * @since 8.0.0 |
|
| 73 | + */ |
|
| 74 | + public function getUser(); |
|
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * Checks whether the user is logged in |
|
| 78 | - * |
|
| 79 | - * @return bool if logged in |
|
| 80 | - * @since 8.0.0 |
|
| 81 | - */ |
|
| 82 | - public function isLoggedIn(); |
|
| 76 | + /** |
|
| 77 | + * Checks whether the user is logged in |
|
| 78 | + * |
|
| 79 | + * @return bool if logged in |
|
| 80 | + * @since 8.0.0 |
|
| 81 | + */ |
|
| 82 | + public function isLoggedIn(); |
|
| 83 | 83 | } |
@@ -30,10 +30,10 @@ |
||
| 30 | 30 | * @since 8.0.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IDateTimeZone { |
| 33 | - /** |
|
| 34 | - * @param bool|int $timestamp |
|
| 35 | - * @return \DateTimeZone |
|
| 36 | - * @since 8.0.0 - parameter $timestamp was added in 8.1.0 |
|
| 37 | - */ |
|
| 38 | - public function getTimeZone($timestamp = false); |
|
| 33 | + /** |
|
| 34 | + * @param bool|int $timestamp |
|
| 35 | + * @return \DateTimeZone |
|
| 36 | + * @since 8.0.0 - parameter $timestamp was added in 8.1.0 |
|
| 37 | + */ |
|
| 38 | + public function getTimeZone($timestamp = false); |
|
| 39 | 39 | } |
@@ -31,18 +31,18 @@ |
||
| 31 | 31 | * @since 8.0.0 |
| 32 | 32 | */ |
| 33 | 33 | class StringUtils { |
| 34 | - /** |
|
| 35 | - * Compares whether two strings are equal. To prevent guessing of the string |
|
| 36 | - * length this is done by comparing two hashes against each other and afterwards |
|
| 37 | - * a comparison of the real string to prevent against the unlikely chance of |
|
| 38 | - * collisions. |
|
| 39 | - * @param string $expected The expected value |
|
| 40 | - * @param string $input The input to compare against |
|
| 41 | - * @return bool True if the two strings are equal, otherwise false. |
|
| 42 | - * @since 8.0.0 |
|
| 43 | - * @deprecated 9.0.0 Use hash_equals |
|
| 44 | - */ |
|
| 45 | - public static function equals($expected, $input) { |
|
| 46 | - return hash_equals($expected, $input); |
|
| 47 | - } |
|
| 34 | + /** |
|
| 35 | + * Compares whether two strings are equal. To prevent guessing of the string |
|
| 36 | + * length this is done by comparing two hashes against each other and afterwards |
|
| 37 | + * a comparison of the real string to prevent against the unlikely chance of |
|
| 38 | + * collisions. |
|
| 39 | + * @param string $expected The expected value |
|
| 40 | + * @param string $input The input to compare against |
|
| 41 | + * @return bool True if the two strings are equal, otherwise false. |
|
| 42 | + * @since 8.0.0 |
|
| 43 | + * @deprecated 9.0.0 Use hash_equals |
|
| 44 | + */ |
|
| 45 | + public static function equals($expected, $input) { |
|
| 46 | + return hash_equals($expected, $input); |
|
| 47 | + } |
|
| 48 | 48 | } |
@@ -30,43 +30,43 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | interface ICredentialsManager { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Store a set of credentials |
|
| 35 | - * |
|
| 36 | - * @param string|null $userId Null for system-wide credentials |
|
| 37 | - * @param string $identifier |
|
| 38 | - * @param mixed $credentials |
|
| 39 | - * @since 8.2.0 |
|
| 40 | - */ |
|
| 41 | - public function store($userId, $identifier, $credentials); |
|
| 33 | + /** |
|
| 34 | + * Store a set of credentials |
|
| 35 | + * |
|
| 36 | + * @param string|null $userId Null for system-wide credentials |
|
| 37 | + * @param string $identifier |
|
| 38 | + * @param mixed $credentials |
|
| 39 | + * @since 8.2.0 |
|
| 40 | + */ |
|
| 41 | + public function store($userId, $identifier, $credentials); |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Retrieve a set of credentials |
|
| 45 | - * |
|
| 46 | - * @param string|null $userId Null for system-wide credentials |
|
| 47 | - * @param string $identifier |
|
| 48 | - * @return mixed |
|
| 49 | - * @since 8.2.0 |
|
| 50 | - */ |
|
| 51 | - public function retrieve($userId, $identifier); |
|
| 43 | + /** |
|
| 44 | + * Retrieve a set of credentials |
|
| 45 | + * |
|
| 46 | + * @param string|null $userId Null for system-wide credentials |
|
| 47 | + * @param string $identifier |
|
| 48 | + * @return mixed |
|
| 49 | + * @since 8.2.0 |
|
| 50 | + */ |
|
| 51 | + public function retrieve($userId, $identifier); |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Delete a set of credentials |
|
| 55 | - * |
|
| 56 | - * @param string|null $userId Null for system-wide credentials |
|
| 57 | - * @param string $identifier |
|
| 58 | - * @return int rows removed |
|
| 59 | - * @since 8.2.0 |
|
| 60 | - */ |
|
| 61 | - public function delete($userId, $identifier); |
|
| 53 | + /** |
|
| 54 | + * Delete a set of credentials |
|
| 55 | + * |
|
| 56 | + * @param string|null $userId Null for system-wide credentials |
|
| 57 | + * @param string $identifier |
|
| 58 | + * @return int rows removed |
|
| 59 | + * @since 8.2.0 |
|
| 60 | + */ |
|
| 61 | + public function delete($userId, $identifier); |
|
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Erase all credentials stored for a user |
|
| 65 | - * |
|
| 66 | - * @param string $userId |
|
| 67 | - * @return int rows removed |
|
| 68 | - * @since 8.2.0 |
|
| 69 | - */ |
|
| 70 | - public function erase($userId); |
|
| 63 | + /** |
|
| 64 | + * Erase all credentials stored for a user |
|
| 65 | + * |
|
| 66 | + * @param string $userId |
|
| 67 | + * @return int rows removed |
|
| 68 | + * @since 8.2.0 |
|
| 69 | + */ |
|
| 70 | + public function erase($userId); |
|
| 71 | 71 | |
| 72 | 72 | } |