@@ -40,68 +40,68 @@ |
||
40 | 40 | */ |
41 | 41 | interface UserInterface { |
42 | 42 | |
43 | - /** |
|
44 | - * Check if backend implements actions |
|
45 | - * @param int $actions bitwise-or'ed actions |
|
46 | - * @return boolean |
|
47 | - * |
|
48 | - * Returns the supported actions as int to be |
|
49 | - * compared with \OC_User_Backend::CREATE_USER etc. |
|
50 | - * @since 4.5.0 |
|
51 | - */ |
|
52 | - public function implementsActions($actions); |
|
43 | + /** |
|
44 | + * Check if backend implements actions |
|
45 | + * @param int $actions bitwise-or'ed actions |
|
46 | + * @return boolean |
|
47 | + * |
|
48 | + * Returns the supported actions as int to be |
|
49 | + * compared with \OC_User_Backend::CREATE_USER etc. |
|
50 | + * @since 4.5.0 |
|
51 | + */ |
|
52 | + public function implementsActions($actions); |
|
53 | 53 | |
54 | - /** |
|
55 | - * delete a user |
|
56 | - * @param string $uid The username of the user to delete |
|
57 | - * @return bool |
|
58 | - * @since 4.5.0 |
|
59 | - */ |
|
60 | - public function deleteUser($uid); |
|
54 | + /** |
|
55 | + * delete a user |
|
56 | + * @param string $uid The username of the user to delete |
|
57 | + * @return bool |
|
58 | + * @since 4.5.0 |
|
59 | + */ |
|
60 | + public function deleteUser($uid); |
|
61 | 61 | |
62 | - /** |
|
63 | - * Get a list of all users |
|
64 | - * |
|
65 | - * @param string $search |
|
66 | - * @param null|int $limit |
|
67 | - * @param null|int $offset |
|
68 | - * @return string[] an array of all uids |
|
69 | - * @since 4.5.0 |
|
70 | - */ |
|
71 | - public function getUsers($search = '', $limit = null, $offset = null); |
|
62 | + /** |
|
63 | + * Get a list of all users |
|
64 | + * |
|
65 | + * @param string $search |
|
66 | + * @param null|int $limit |
|
67 | + * @param null|int $offset |
|
68 | + * @return string[] an array of all uids |
|
69 | + * @since 4.5.0 |
|
70 | + */ |
|
71 | + public function getUsers($search = '', $limit = null, $offset = null); |
|
72 | 72 | |
73 | - /** |
|
74 | - * check if a user exists |
|
75 | - * @param string $uid the username |
|
76 | - * @return boolean |
|
77 | - * @since 4.5.0 |
|
78 | - */ |
|
79 | - public function userExists($uid); |
|
73 | + /** |
|
74 | + * check if a user exists |
|
75 | + * @param string $uid the username |
|
76 | + * @return boolean |
|
77 | + * @since 4.5.0 |
|
78 | + */ |
|
79 | + public function userExists($uid); |
|
80 | 80 | |
81 | - /** |
|
82 | - * get display name of the user |
|
83 | - * @param string $uid user ID of the user |
|
84 | - * @return string display name |
|
85 | - * @since 4.5.0 |
|
86 | - */ |
|
87 | - public function getDisplayName($uid); |
|
81 | + /** |
|
82 | + * get display name of the user |
|
83 | + * @param string $uid user ID of the user |
|
84 | + * @return string display name |
|
85 | + * @since 4.5.0 |
|
86 | + */ |
|
87 | + public function getDisplayName($uid); |
|
88 | 88 | |
89 | - /** |
|
90 | - * Get a list of all display names and user ids. |
|
91 | - * |
|
92 | - * @param string $search |
|
93 | - * @param string|null $limit |
|
94 | - * @param string|null $offset |
|
95 | - * @return array an array of all displayNames (value) and the corresponding uids (key) |
|
96 | - * @since 4.5.0 |
|
97 | - */ |
|
98 | - public function getDisplayNames($search = '', $limit = null, $offset = null); |
|
89 | + /** |
|
90 | + * Get a list of all display names and user ids. |
|
91 | + * |
|
92 | + * @param string $search |
|
93 | + * @param string|null $limit |
|
94 | + * @param string|null $offset |
|
95 | + * @return array an array of all displayNames (value) and the corresponding uids (key) |
|
96 | + * @since 4.5.0 |
|
97 | + */ |
|
98 | + public function getDisplayNames($search = '', $limit = null, $offset = null); |
|
99 | 99 | |
100 | - /** |
|
101 | - * Check if a user list is available or not |
|
102 | - * @return boolean if users can be listed or not |
|
103 | - * @since 4.5.0 |
|
104 | - */ |
|
105 | - public function hasUserListings(); |
|
100 | + /** |
|
101 | + * Check if a user list is available or not |
|
102 | + * @return boolean if users can be listed or not |
|
103 | + * @since 4.5.0 |
|
104 | + */ |
|
105 | + public function hasUserListings(); |
|
106 | 106 | |
107 | 107 | } |
@@ -25,56 +25,56 @@ |
||
25 | 25 | * @since 8.2.0 |
26 | 26 | */ |
27 | 27 | interface IFactory { |
28 | - /** |
|
29 | - * Get a language instance |
|
30 | - * |
|
31 | - * @param string $app |
|
32 | - * @param string|null $lang |
|
33 | - * @return \OCP\IL10N |
|
34 | - * @since 8.2.0 |
|
35 | - */ |
|
36 | - public function get($app, $lang = null); |
|
28 | + /** |
|
29 | + * Get a language instance |
|
30 | + * |
|
31 | + * @param string $app |
|
32 | + * @param string|null $lang |
|
33 | + * @return \OCP\IL10N |
|
34 | + * @since 8.2.0 |
|
35 | + */ |
|
36 | + public function get($app, $lang = null); |
|
37 | 37 | |
38 | - /** |
|
39 | - * Find the best language |
|
40 | - * |
|
41 | - * @param string|null $app App id or null for core |
|
42 | - * @return string language If nothing works it returns 'en' |
|
43 | - * @since 9.0.0 |
|
44 | - */ |
|
45 | - public function findLanguage($app = null); |
|
38 | + /** |
|
39 | + * Find the best language |
|
40 | + * |
|
41 | + * @param string|null $app App id or null for core |
|
42 | + * @return string language If nothing works it returns 'en' |
|
43 | + * @since 9.0.0 |
|
44 | + */ |
|
45 | + public function findLanguage($app = null); |
|
46 | 46 | |
47 | - /** |
|
48 | - * Find all available languages for an app |
|
49 | - * |
|
50 | - * @param string|null $app App id or null for core |
|
51 | - * @return string[] an array of available languages |
|
52 | - * @since 9.0.0 |
|
53 | - */ |
|
54 | - public function findAvailableLanguages($app = null); |
|
47 | + /** |
|
48 | + * Find all available languages for an app |
|
49 | + * |
|
50 | + * @param string|null $app App id or null for core |
|
51 | + * @return string[] an array of available languages |
|
52 | + * @since 9.0.0 |
|
53 | + */ |
|
54 | + public function findAvailableLanguages($app = null); |
|
55 | 55 | |
56 | - /** |
|
57 | - * @param string|null $app App id or null for core |
|
58 | - * @param string $lang |
|
59 | - * @return bool |
|
60 | - * @since 9.0.0 |
|
61 | - */ |
|
62 | - public function languageExists($app, $lang); |
|
56 | + /** |
|
57 | + * @param string|null $app App id or null for core |
|
58 | + * @param string $lang |
|
59 | + * @return bool |
|
60 | + * @since 9.0.0 |
|
61 | + */ |
|
62 | + public function languageExists($app, $lang); |
|
63 | 63 | |
64 | - /** |
|
65 | - * @param string|null $app App id or null for core |
|
66 | - * @return string |
|
67 | - * @since 9.0.0 |
|
68 | - */ |
|
69 | - public function setLanguageFromRequest($app = null); |
|
64 | + /** |
|
65 | + * @param string|null $app App id or null for core |
|
66 | + * @return string |
|
67 | + * @since 9.0.0 |
|
68 | + */ |
|
69 | + public function setLanguageFromRequest($app = null); |
|
70 | 70 | |
71 | 71 | |
72 | - /** |
|
73 | - * Creates a function from the plural string |
|
74 | - * |
|
75 | - * @param string $string |
|
76 | - * @return string Unique function name |
|
77 | - * @since 9.0.0 |
|
78 | - */ |
|
79 | - public function createPluralFunction($string); |
|
72 | + /** |
|
73 | + * Creates a function from the plural string |
|
74 | + * |
|
75 | + * @param string $string |
|
76 | + * @return string Unique function name |
|
77 | + * @since 9.0.0 |
|
78 | + */ |
|
79 | + public function createPluralFunction($string); |
|
80 | 80 | } |
@@ -32,31 +32,31 @@ |
||
32 | 32 | */ |
33 | 33 | class LockedException extends \Exception { |
34 | 34 | |
35 | - /** |
|
36 | - * Locked path |
|
37 | - * |
|
38 | - * @var string |
|
39 | - */ |
|
40 | - private $path; |
|
35 | + /** |
|
36 | + * Locked path |
|
37 | + * |
|
38 | + * @var string |
|
39 | + */ |
|
40 | + private $path; |
|
41 | 41 | |
42 | - /** |
|
43 | - * LockedException constructor. |
|
44 | - * |
|
45 | - * @param string $path locked path |
|
46 | - * @param \Exception $previous previous exception for cascading |
|
47 | - * |
|
48 | - * @since 8.1.0 |
|
49 | - */ |
|
50 | - public function __construct($path, \Exception $previous = null) { |
|
51 | - parent::__construct('"' . $path . '" is locked', 0, $previous); |
|
52 | - $this->path = $path; |
|
53 | - } |
|
42 | + /** |
|
43 | + * LockedException constructor. |
|
44 | + * |
|
45 | + * @param string $path locked path |
|
46 | + * @param \Exception $previous previous exception for cascading |
|
47 | + * |
|
48 | + * @since 8.1.0 |
|
49 | + */ |
|
50 | + public function __construct($path, \Exception $previous = null) { |
|
51 | + parent::__construct('"' . $path . '" is locked', 0, $previous); |
|
52 | + $this->path = $path; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * @return string |
|
57 | - * @since 8.1.0 |
|
58 | - */ |
|
59 | - public function getPath() { |
|
60 | - return $this->path; |
|
61 | - } |
|
55 | + /** |
|
56 | + * @return string |
|
57 | + * @since 8.1.0 |
|
58 | + */ |
|
59 | + public function getPath() { |
|
60 | + return $this->path; |
|
61 | + } |
|
62 | 62 | } |
@@ -30,51 +30,51 @@ |
||
30 | 30 | * @since 8.1.0 |
31 | 31 | */ |
32 | 32 | interface ILockingProvider { |
33 | - /** |
|
34 | - * @since 8.1.0 |
|
35 | - */ |
|
36 | - const LOCK_SHARED = 1; |
|
37 | - /** |
|
38 | - * @since 8.1.0 |
|
39 | - */ |
|
40 | - const LOCK_EXCLUSIVE = 2; |
|
33 | + /** |
|
34 | + * @since 8.1.0 |
|
35 | + */ |
|
36 | + const LOCK_SHARED = 1; |
|
37 | + /** |
|
38 | + * @since 8.1.0 |
|
39 | + */ |
|
40 | + const LOCK_EXCLUSIVE = 2; |
|
41 | 41 | |
42 | - /** |
|
43 | - * @param string $path |
|
44 | - * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
45 | - * @return bool |
|
46 | - * @since 8.1.0 |
|
47 | - */ |
|
48 | - public function isLocked($path, $type); |
|
42 | + /** |
|
43 | + * @param string $path |
|
44 | + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
45 | + * @return bool |
|
46 | + * @since 8.1.0 |
|
47 | + */ |
|
48 | + public function isLocked($path, $type); |
|
49 | 49 | |
50 | - /** |
|
51 | - * @param string $path |
|
52 | - * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
53 | - * @throws \OCP\Lock\LockedException |
|
54 | - * @since 8.1.0 |
|
55 | - */ |
|
56 | - public function acquireLock($path, $type); |
|
50 | + /** |
|
51 | + * @param string $path |
|
52 | + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
53 | + * @throws \OCP\Lock\LockedException |
|
54 | + * @since 8.1.0 |
|
55 | + */ |
|
56 | + public function acquireLock($path, $type); |
|
57 | 57 | |
58 | - /** |
|
59 | - * @param string $path |
|
60 | - * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
61 | - * @since 8.1.0 |
|
62 | - */ |
|
63 | - public function releaseLock($path, $type); |
|
58 | + /** |
|
59 | + * @param string $path |
|
60 | + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
61 | + * @since 8.1.0 |
|
62 | + */ |
|
63 | + public function releaseLock($path, $type); |
|
64 | 64 | |
65 | - /** |
|
66 | - * Change the type of an existing lock |
|
67 | - * |
|
68 | - * @param string $path |
|
69 | - * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
70 | - * @throws \OCP\Lock\LockedException |
|
71 | - * @since 8.1.0 |
|
72 | - */ |
|
73 | - public function changeLock($path, $targetType); |
|
65 | + /** |
|
66 | + * Change the type of an existing lock |
|
67 | + * |
|
68 | + * @param string $path |
|
69 | + * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
70 | + * @throws \OCP\Lock\LockedException |
|
71 | + * @since 8.1.0 |
|
72 | + */ |
|
73 | + public function changeLock($path, $targetType); |
|
74 | 74 | |
75 | - /** |
|
76 | - * release all lock acquired by this instance |
|
77 | - * @since 8.1.0 |
|
78 | - */ |
|
79 | - public function releaseAll(); |
|
75 | + /** |
|
76 | + * release all lock acquired by this instance |
|
77 | + * @since 8.1.0 |
|
78 | + */ |
|
79 | + public function releaseAll(); |
|
80 | 80 | } |
@@ -40,68 +40,68 @@ |
||
40 | 40 | */ |
41 | 41 | interface GroupInterface { |
42 | 42 | |
43 | - /** |
|
44 | - * Check if backend implements actions |
|
45 | - * @param int $actions bitwise-or'ed actions |
|
46 | - * @return boolean |
|
47 | - * @since 4.5.0 |
|
48 | - * |
|
49 | - * Returns the supported actions as int to be |
|
50 | - * compared with \OC_Group_Backend::CREATE_GROUP etc. |
|
51 | - */ |
|
52 | - public function implementsActions($actions); |
|
43 | + /** |
|
44 | + * Check if backend implements actions |
|
45 | + * @param int $actions bitwise-or'ed actions |
|
46 | + * @return boolean |
|
47 | + * @since 4.5.0 |
|
48 | + * |
|
49 | + * Returns the supported actions as int to be |
|
50 | + * compared with \OC_Group_Backend::CREATE_GROUP etc. |
|
51 | + */ |
|
52 | + public function implementsActions($actions); |
|
53 | 53 | |
54 | - /** |
|
55 | - * is user in group? |
|
56 | - * @param string $uid uid of the user |
|
57 | - * @param string $gid gid of the group |
|
58 | - * @return bool |
|
59 | - * @since 4.5.0 |
|
60 | - * |
|
61 | - * Checks whether the user is member of a group or not. |
|
62 | - */ |
|
63 | - public function inGroup($uid, $gid); |
|
54 | + /** |
|
55 | + * is user in group? |
|
56 | + * @param string $uid uid of the user |
|
57 | + * @param string $gid gid of the group |
|
58 | + * @return bool |
|
59 | + * @since 4.5.0 |
|
60 | + * |
|
61 | + * Checks whether the user is member of a group or not. |
|
62 | + */ |
|
63 | + public function inGroup($uid, $gid); |
|
64 | 64 | |
65 | - /** |
|
66 | - * Get all groups a user belongs to |
|
67 | - * @param string $uid Name of the user |
|
68 | - * @return array an array of group names |
|
69 | - * @since 4.5.0 |
|
70 | - * |
|
71 | - * This function fetches all groups a user belongs to. It does not check |
|
72 | - * if the user exists at all. |
|
73 | - */ |
|
74 | - public function getUserGroups($uid); |
|
65 | + /** |
|
66 | + * Get all groups a user belongs to |
|
67 | + * @param string $uid Name of the user |
|
68 | + * @return array an array of group names |
|
69 | + * @since 4.5.0 |
|
70 | + * |
|
71 | + * This function fetches all groups a user belongs to. It does not check |
|
72 | + * if the user exists at all. |
|
73 | + */ |
|
74 | + public function getUserGroups($uid); |
|
75 | 75 | |
76 | - /** |
|
77 | - * get a list of all groups |
|
78 | - * @param string $search |
|
79 | - * @param int $limit |
|
80 | - * @param int $offset |
|
81 | - * @return array an array of group names |
|
82 | - * @since 4.5.0 |
|
83 | - * |
|
84 | - * Returns a list with all groups |
|
85 | - */ |
|
86 | - public function getGroups($search = '', $limit = -1, $offset = 0); |
|
76 | + /** |
|
77 | + * get a list of all groups |
|
78 | + * @param string $search |
|
79 | + * @param int $limit |
|
80 | + * @param int $offset |
|
81 | + * @return array an array of group names |
|
82 | + * @since 4.5.0 |
|
83 | + * |
|
84 | + * Returns a list with all groups |
|
85 | + */ |
|
86 | + public function getGroups($search = '', $limit = -1, $offset = 0); |
|
87 | 87 | |
88 | - /** |
|
89 | - * check if a group exists |
|
90 | - * @param string $gid |
|
91 | - * @return bool |
|
92 | - * @since 4.5.0 |
|
93 | - */ |
|
94 | - public function groupExists($gid); |
|
88 | + /** |
|
89 | + * check if a group exists |
|
90 | + * @param string $gid |
|
91 | + * @return bool |
|
92 | + * @since 4.5.0 |
|
93 | + */ |
|
94 | + public function groupExists($gid); |
|
95 | 95 | |
96 | - /** |
|
97 | - * get a list of all users in a group |
|
98 | - * @param string $gid |
|
99 | - * @param string $search |
|
100 | - * @param int $limit |
|
101 | - * @param int $offset |
|
102 | - * @return array an array of user ids |
|
103 | - * @since 4.5.0 |
|
104 | - */ |
|
105 | - public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); |
|
96 | + /** |
|
97 | + * get a list of all users in a group |
|
98 | + * @param string $gid |
|
99 | + * @param string $search |
|
100 | + * @param int $limit |
|
101 | + * @param int $offset |
|
102 | + * @return array an array of user ids |
|
103 | + * @since 4.5.0 |
|
104 | + */ |
|
105 | + public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); |
|
106 | 106 | |
107 | 107 | } |
@@ -30,22 +30,22 @@ |
||
30 | 30 | * @since 7.0.0 |
31 | 31 | */ |
32 | 32 | interface ICacheFactory{ |
33 | - /** |
|
34 | - * Get a memory cache instance |
|
35 | - * |
|
36 | - * All entries added trough the cache instance will be namespaced by $prefix to prevent collisions between apps |
|
37 | - * |
|
38 | - * @param string $prefix |
|
39 | - * @return \OCP\ICache |
|
40 | - * @since 7.0.0 |
|
41 | - */ |
|
42 | - public function create($prefix = ''); |
|
33 | + /** |
|
34 | + * Get a memory cache instance |
|
35 | + * |
|
36 | + * All entries added trough the cache instance will be namespaced by $prefix to prevent collisions between apps |
|
37 | + * |
|
38 | + * @param string $prefix |
|
39 | + * @return \OCP\ICache |
|
40 | + * @since 7.0.0 |
|
41 | + */ |
|
42 | + public function create($prefix = ''); |
|
43 | 43 | |
44 | - /** |
|
45 | - * Check if any memory cache backend is available |
|
46 | - * |
|
47 | - * @return bool |
|
48 | - * @since 7.0.0 |
|
49 | - */ |
|
50 | - public function isAvailable(); |
|
44 | + /** |
|
45 | + * Check if any memory cache backend is available |
|
46 | + * |
|
47 | + * @return bool |
|
48 | + * @since 7.0.0 |
|
49 | + */ |
|
50 | + public function isAvailable(); |
|
51 | 51 | } |
@@ -43,93 +43,93 @@ |
||
43 | 43 | * @deprecated 8.1.0 - Use AppFramework controllers instead and modify the response object |
44 | 44 | */ |
45 | 45 | class Response { |
46 | - /** |
|
47 | - * Enable response caching by sending correct HTTP headers |
|
48 | - * @param int $cache_time time to cache the response |
|
49 | - * >0 cache time in seconds |
|
50 | - * 0 and <0 enable default browser caching |
|
51 | - * null cache indefinitly |
|
52 | - * @since 4.0.0 |
|
53 | - */ |
|
54 | - static public function enableCaching( $cache_time = null ) { |
|
55 | - \OC_Response::enableCaching( $cache_time ); |
|
56 | - } |
|
46 | + /** |
|
47 | + * Enable response caching by sending correct HTTP headers |
|
48 | + * @param int $cache_time time to cache the response |
|
49 | + * >0 cache time in seconds |
|
50 | + * 0 and <0 enable default browser caching |
|
51 | + * null cache indefinitly |
|
52 | + * @since 4.0.0 |
|
53 | + */ |
|
54 | + static public function enableCaching( $cache_time = null ) { |
|
55 | + \OC_Response::enableCaching( $cache_time ); |
|
56 | + } |
|
57 | 57 | |
58 | - /** |
|
59 | - * Checks and set Last-Modified header, when the request matches sends a |
|
60 | - * 'not modified' response |
|
61 | - * @param string $lastModified time when the reponse was last modified |
|
62 | - * @since 4.0.0 |
|
63 | - */ |
|
64 | - static public function setLastModifiedHeader( $lastModified ) { |
|
65 | - \OC_Response::setLastModifiedHeader( $lastModified ); |
|
66 | - } |
|
58 | + /** |
|
59 | + * Checks and set Last-Modified header, when the request matches sends a |
|
60 | + * 'not modified' response |
|
61 | + * @param string $lastModified time when the reponse was last modified |
|
62 | + * @since 4.0.0 |
|
63 | + */ |
|
64 | + static public function setLastModifiedHeader( $lastModified ) { |
|
65 | + \OC_Response::setLastModifiedHeader( $lastModified ); |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * Sets the content disposition header (with possible workarounds) |
|
70 | - * @param string $filename file name |
|
71 | - * @param string $type disposition type, either 'attachment' or 'inline' |
|
72 | - * @since 7.0.0 |
|
73 | - */ |
|
74 | - static public function setContentDispositionHeader( $filename, $type = 'attachment' ) { |
|
75 | - \OC_Response::setContentDispositionHeader( $filename, $type ); |
|
76 | - } |
|
68 | + /** |
|
69 | + * Sets the content disposition header (with possible workarounds) |
|
70 | + * @param string $filename file name |
|
71 | + * @param string $type disposition type, either 'attachment' or 'inline' |
|
72 | + * @since 7.0.0 |
|
73 | + */ |
|
74 | + static public function setContentDispositionHeader( $filename, $type = 'attachment' ) { |
|
75 | + \OC_Response::setContentDispositionHeader( $filename, $type ); |
|
76 | + } |
|
77 | 77 | |
78 | - /** |
|
79 | - * Sets the content length header (with possible workarounds) |
|
80 | - * @param string|int|float $length Length to be sent |
|
81 | - * @since 8.1.0 |
|
82 | - */ |
|
83 | - static public function setContentLengthHeader($length) { |
|
84 | - \OC_Response::setContentLengthHeader($length); |
|
85 | - } |
|
78 | + /** |
|
79 | + * Sets the content length header (with possible workarounds) |
|
80 | + * @param string|int|float $length Length to be sent |
|
81 | + * @since 8.1.0 |
|
82 | + */ |
|
83 | + static public function setContentLengthHeader($length) { |
|
84 | + \OC_Response::setContentLengthHeader($length); |
|
85 | + } |
|
86 | 86 | |
87 | - /** |
|
88 | - * Disable browser caching |
|
89 | - * @see enableCaching with cache_time = 0 |
|
90 | - * @since 4.0.0 |
|
91 | - */ |
|
92 | - static public function disableCaching() { |
|
93 | - \OC_Response::disableCaching(); |
|
94 | - } |
|
87 | + /** |
|
88 | + * Disable browser caching |
|
89 | + * @see enableCaching with cache_time = 0 |
|
90 | + * @since 4.0.0 |
|
91 | + */ |
|
92 | + static public function disableCaching() { |
|
93 | + \OC_Response::disableCaching(); |
|
94 | + } |
|
95 | 95 | |
96 | - /** |
|
97 | - * Checks and set ETag header, when the request matches sends a |
|
98 | - * 'not modified' response |
|
99 | - * @param string $etag token to use for modification check |
|
100 | - * @since 4.0.0 |
|
101 | - */ |
|
102 | - static public function setETagHeader( $etag ) { |
|
103 | - \OC_Response::setETagHeader( $etag ); |
|
104 | - } |
|
96 | + /** |
|
97 | + * Checks and set ETag header, when the request matches sends a |
|
98 | + * 'not modified' response |
|
99 | + * @param string $etag token to use for modification check |
|
100 | + * @since 4.0.0 |
|
101 | + */ |
|
102 | + static public function setETagHeader( $etag ) { |
|
103 | + \OC_Response::setETagHeader( $etag ); |
|
104 | + } |
|
105 | 105 | |
106 | - /** |
|
107 | - * Send file as response, checking and setting caching headers |
|
108 | - * @param string $filepath of file to send |
|
109 | - * @since 4.0.0 |
|
110 | - * @deprecated 8.1.0 - Use \OCP\AppFramework\Http\StreamResponse or another AppFramework controller instead |
|
111 | - */ |
|
112 | - static public function sendFile( $filepath ) { |
|
113 | - \OC_Response::sendFile( $filepath ); |
|
114 | - } |
|
106 | + /** |
|
107 | + * Send file as response, checking and setting caching headers |
|
108 | + * @param string $filepath of file to send |
|
109 | + * @since 4.0.0 |
|
110 | + * @deprecated 8.1.0 - Use \OCP\AppFramework\Http\StreamResponse or another AppFramework controller instead |
|
111 | + */ |
|
112 | + static public function sendFile( $filepath ) { |
|
113 | + \OC_Response::sendFile( $filepath ); |
|
114 | + } |
|
115 | 115 | |
116 | - /** |
|
117 | - * Set response expire time |
|
118 | - * @param string|\DateTime $expires date-time when the response expires |
|
119 | - * string for DateInterval from now |
|
120 | - * DateTime object when to expire response |
|
121 | - * @since 4.0.0 |
|
122 | - */ |
|
123 | - static public function setExpiresHeader( $expires ) { |
|
124 | - \OC_Response::setExpiresHeader( $expires ); |
|
125 | - } |
|
116 | + /** |
|
117 | + * Set response expire time |
|
118 | + * @param string|\DateTime $expires date-time when the response expires |
|
119 | + * string for DateInterval from now |
|
120 | + * DateTime object when to expire response |
|
121 | + * @since 4.0.0 |
|
122 | + */ |
|
123 | + static public function setExpiresHeader( $expires ) { |
|
124 | + \OC_Response::setExpiresHeader( $expires ); |
|
125 | + } |
|
126 | 126 | |
127 | - /** |
|
128 | - * Send redirect response |
|
129 | - * @param string $location to redirect to |
|
130 | - * @since 4.0.0 |
|
131 | - */ |
|
132 | - static public function redirect( $location ) { |
|
133 | - \OC_Response::redirect( $location ); |
|
134 | - } |
|
127 | + /** |
|
128 | + * Send redirect response |
|
129 | + * @param string $location to redirect to |
|
130 | + * @since 4.0.0 |
|
131 | + */ |
|
132 | + static public function redirect( $location ) { |
|
133 | + \OC_Response::redirect( $location ); |
|
134 | + } |
|
135 | 135 | } |
@@ -36,12 +36,12 @@ |
||
36 | 36 | */ |
37 | 37 | interface ICapability { |
38 | 38 | |
39 | - /** |
|
40 | - * Function an app uses to return the capabilities |
|
41 | - * |
|
42 | - * @return array Array containing the apps capabilities |
|
43 | - * @since 8.2.0 |
|
44 | - */ |
|
45 | - public function getCapabilities(); |
|
39 | + /** |
|
40 | + * Function an app uses to return the capabilities |
|
41 | + * |
|
42 | + * @return array Array containing the apps capabilities |
|
43 | + * @since 8.2.0 |
|
44 | + */ |
|
45 | + public function getCapabilities(); |
|
46 | 46 | } |
47 | 47 |
@@ -37,55 +37,55 @@ |
||
37 | 37 | * @since 8.1.0 |
38 | 38 | */ |
39 | 39 | interface IMemcache extends ICache { |
40 | - /** |
|
41 | - * Set a value in the cache if it's not already stored |
|
42 | - * |
|
43 | - * @param string $key |
|
44 | - * @param mixed $value |
|
45 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
46 | - * @return bool |
|
47 | - * @since 8.1.0 |
|
48 | - */ |
|
49 | - public function add($key, $value, $ttl = 0); |
|
40 | + /** |
|
41 | + * Set a value in the cache if it's not already stored |
|
42 | + * |
|
43 | + * @param string $key |
|
44 | + * @param mixed $value |
|
45 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
46 | + * @return bool |
|
47 | + * @since 8.1.0 |
|
48 | + */ |
|
49 | + public function add($key, $value, $ttl = 0); |
|
50 | 50 | |
51 | - /** |
|
52 | - * Increase a stored number |
|
53 | - * |
|
54 | - * @param string $key |
|
55 | - * @param int $step |
|
56 | - * @return int | bool |
|
57 | - * @since 8.1.0 |
|
58 | - */ |
|
59 | - public function inc($key, $step = 1); |
|
51 | + /** |
|
52 | + * Increase a stored number |
|
53 | + * |
|
54 | + * @param string $key |
|
55 | + * @param int $step |
|
56 | + * @return int | bool |
|
57 | + * @since 8.1.0 |
|
58 | + */ |
|
59 | + public function inc($key, $step = 1); |
|
60 | 60 | |
61 | - /** |
|
62 | - * Decrease a stored number |
|
63 | - * |
|
64 | - * @param string $key |
|
65 | - * @param int $step |
|
66 | - * @return int | bool |
|
67 | - * @since 8.1.0 |
|
68 | - */ |
|
69 | - public function dec($key, $step = 1); |
|
61 | + /** |
|
62 | + * Decrease a stored number |
|
63 | + * |
|
64 | + * @param string $key |
|
65 | + * @param int $step |
|
66 | + * @return int | bool |
|
67 | + * @since 8.1.0 |
|
68 | + */ |
|
69 | + public function dec($key, $step = 1); |
|
70 | 70 | |
71 | - /** |
|
72 | - * Compare and set |
|
73 | - * |
|
74 | - * @param string $key |
|
75 | - * @param mixed $old |
|
76 | - * @param mixed $new |
|
77 | - * @return bool |
|
78 | - * @since 8.1.0 |
|
79 | - */ |
|
80 | - public function cas($key, $old, $new); |
|
71 | + /** |
|
72 | + * Compare and set |
|
73 | + * |
|
74 | + * @param string $key |
|
75 | + * @param mixed $old |
|
76 | + * @param mixed $new |
|
77 | + * @return bool |
|
78 | + * @since 8.1.0 |
|
79 | + */ |
|
80 | + public function cas($key, $old, $new); |
|
81 | 81 | |
82 | - /** |
|
83 | - * Compare and delete |
|
84 | - * |
|
85 | - * @param string $key |
|
86 | - * @param mixed $old |
|
87 | - * @return bool |
|
88 | - * @since 8.1.0 |
|
89 | - */ |
|
90 | - public function cad($key, $old); |
|
82 | + /** |
|
83 | + * Compare and delete |
|
84 | + * |
|
85 | + * @param string $key |
|
86 | + * @param mixed $old |
|
87 | + * @return bool |
|
88 | + * @since 8.1.0 |
|
89 | + */ |
|
90 | + public function cad($key, $old); |
|
91 | 91 | } |