@@ -46,17 +46,17 @@ |
||
46 | 46 | */ |
47 | 47 | interface ITagManager { |
48 | 48 | |
49 | - /** |
|
50 | - * Create a new \OCP\ITags instance and load tags from db for the current user. |
|
51 | - * |
|
52 | - * @see \OCP\ITags |
|
53 | - * @param string $type The type identifier e.g. 'contact' or 'event'. |
|
54 | - * @param array $defaultTags An array of default tags to be used if none are stored. |
|
55 | - * @param boolean $includeShared Whether to include tags for items shared with this user by others. |
|
56 | - * @param string $userId user for which to retrieve the tags, defaults to the currently |
|
57 | - * logged in user |
|
58 | - * @return \OCP\ITags |
|
59 | - * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0 |
|
60 | - */ |
|
61 | - public function load($type, $defaultTags = array(), $includeShared = false, $userId = null); |
|
49 | + /** |
|
50 | + * Create a new \OCP\ITags instance and load tags from db for the current user. |
|
51 | + * |
|
52 | + * @see \OCP\ITags |
|
53 | + * @param string $type The type identifier e.g. 'contact' or 'event'. |
|
54 | + * @param array $defaultTags An array of default tags to be used if none are stored. |
|
55 | + * @param boolean $includeShared Whether to include tags for items shared with this user by others. |
|
56 | + * @param string $userId user for which to retrieve the tags, defaults to the currently |
|
57 | + * logged in user |
|
58 | + * @return \OCP\ITags |
|
59 | + * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0 |
|
60 | + */ |
|
61 | + public function load($type, $defaultTags = array(), $includeShared = false, $userId = null); |
|
62 | 62 | } |
@@ -32,39 +32,39 @@ |
||
32 | 32 | */ |
33 | 33 | class ConsoleEvent extends Event { |
34 | 34 | |
35 | - const EVENT_RUN = 'OC\Console\Application::run'; |
|
35 | + const EVENT_RUN = 'OC\Console\Application::run'; |
|
36 | 36 | |
37 | - /** @var string */ |
|
38 | - protected $event; |
|
37 | + /** @var string */ |
|
38 | + protected $event; |
|
39 | 39 | |
40 | - /** @var string[] */ |
|
41 | - protected $arguments; |
|
40 | + /** @var string[] */ |
|
41 | + protected $arguments; |
|
42 | 42 | |
43 | - /** |
|
44 | - * DispatcherEvent constructor. |
|
45 | - * |
|
46 | - * @param string $event |
|
47 | - * @param string[] $arguments |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function __construct($event, array $arguments) { |
|
51 | - $this->event = $event; |
|
52 | - $this->arguments = $arguments; |
|
53 | - } |
|
43 | + /** |
|
44 | + * DispatcherEvent constructor. |
|
45 | + * |
|
46 | + * @param string $event |
|
47 | + * @param string[] $arguments |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function __construct($event, array $arguments) { |
|
51 | + $this->event = $event; |
|
52 | + $this->arguments = $arguments; |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * @return string |
|
57 | - * @since 9.0.0 |
|
58 | - */ |
|
59 | - public function getEvent() { |
|
60 | - return $this->event; |
|
61 | - } |
|
55 | + /** |
|
56 | + * @return string |
|
57 | + * @since 9.0.0 |
|
58 | + */ |
|
59 | + public function getEvent() { |
|
60 | + return $this->event; |
|
61 | + } |
|
62 | 62 | |
63 | - /** |
|
64 | - * @return string[] |
|
65 | - * @since 9.0.0 |
|
66 | - */ |
|
67 | - public function getArguments() { |
|
68 | - return $this->arguments; |
|
69 | - } |
|
63 | + /** |
|
64 | + * @return string[] |
|
65 | + * @since 9.0.0 |
|
66 | + */ |
|
67 | + public function getArguments() { |
|
68 | + return $this->arguments; |
|
69 | + } |
|
70 | 70 | } |
@@ -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 | } |
@@ -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 | } |