@@ -28,15 +28,15 @@ |
||
28 | 28 | * @since 11.0.0 |
29 | 29 | */ |
30 | 30 | interface IProvider { |
31 | - /** |
|
32 | - * @param string $language The language which should be used for translating, e.g. "en" |
|
33 | - * @param IEvent $event The current event which should be parsed |
|
34 | - * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one. |
|
35 | - * To do so, simply use setChildEvent($previousEvent) after setting the |
|
36 | - * combined subject on the current event. |
|
37 | - * @return IEvent |
|
38 | - * @throws \InvalidArgumentException Should be thrown if your provider does not know this event |
|
39 | - * @since 11.0.0 |
|
40 | - */ |
|
41 | - public function parse($language, IEvent $event, IEvent $previousEvent = null); |
|
31 | + /** |
|
32 | + * @param string $language The language which should be used for translating, e.g. "en" |
|
33 | + * @param IEvent $event The current event which should be parsed |
|
34 | + * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one. |
|
35 | + * To do so, simply use setChildEvent($previousEvent) after setting the |
|
36 | + * combined subject on the current event. |
|
37 | + * @return IEvent |
|
38 | + * @throws \InvalidArgumentException Should be thrown if your provider does not know this event |
|
39 | + * @since 11.0.0 |
|
40 | + */ |
|
41 | + public function parse($language, IEvent $event, IEvent $previousEvent = null); |
|
42 | 42 | } |
@@ -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 | } |
@@ -44,23 +44,23 @@ |
||
44 | 44 | * @since 8.0.0 |
45 | 45 | */ |
46 | 46 | interface IHasher { |
47 | - /** |
|
48 | - * Hashes a message using PHP's `password_hash` functionality. |
|
49 | - * Please note that the size of the returned string is not guaranteed |
|
50 | - * and can be up to 255 characters. |
|
51 | - * |
|
52 | - * @param string $message Message to generate hash from |
|
53 | - * @return string Hash of the message with appended version parameter |
|
54 | - * @since 8.0.0 |
|
55 | - */ |
|
56 | - public function hash($message); |
|
47 | + /** |
|
48 | + * Hashes a message using PHP's `password_hash` functionality. |
|
49 | + * Please note that the size of the returned string is not guaranteed |
|
50 | + * and can be up to 255 characters. |
|
51 | + * |
|
52 | + * @param string $message Message to generate hash from |
|
53 | + * @return string Hash of the message with appended version parameter |
|
54 | + * @since 8.0.0 |
|
55 | + */ |
|
56 | + public function hash($message); |
|
57 | 57 | |
58 | - /** |
|
59 | - * @param string $message Message to verify |
|
60 | - * @param string $hash Assumed hash of the message |
|
61 | - * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. |
|
62 | - * @return bool Whether $hash is a valid hash of $message |
|
63 | - * @since 8.0.0 |
|
64 | - */ |
|
65 | - public function verify($message, $hash, &$newHash = null); |
|
58 | + /** |
|
59 | + * @param string $message Message to verify |
|
60 | + * @param string $hash Assumed hash of the message |
|
61 | + * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. |
|
62 | + * @return bool Whether $hash is a valid hash of $message |
|
63 | + * @since 8.0.0 |
|
64 | + */ |
|
65 | + public function verify($message, $hash, &$newHash = null); |
|
66 | 66 | } |
@@ -36,49 +36,49 @@ |
||
36 | 36 | */ |
37 | 37 | interface ISecureRandom { |
38 | 38 | |
39 | - /** |
|
40 | - * Flags for characters that can be used for <code>generate($length, $characters)</code> |
|
41 | - */ |
|
42 | - const CHAR_UPPER = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'; |
|
43 | - const CHAR_LOWER = 'abcdefghijklmnopqrstuvwxyz'; |
|
44 | - const CHAR_DIGITS = '0123456789'; |
|
45 | - const CHAR_SYMBOLS = '!\"#$%&\\\'()* +,-./:;<=>?@[\]^_`{|}~'; |
|
39 | + /** |
|
40 | + * Flags for characters that can be used for <code>generate($length, $characters)</code> |
|
41 | + */ |
|
42 | + const CHAR_UPPER = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'; |
|
43 | + const CHAR_LOWER = 'abcdefghijklmnopqrstuvwxyz'; |
|
44 | + const CHAR_DIGITS = '0123456789'; |
|
45 | + const CHAR_SYMBOLS = '!\"#$%&\\\'()* +,-./:;<=>?@[\]^_`{|}~'; |
|
46 | 46 | |
47 | - /** |
|
48 | - * Convenience method to get a low strength random number generator. |
|
49 | - * |
|
50 | - * Low Strength should be used anywhere that random strings are needed |
|
51 | - * in a non-cryptographical setting. They are not strong enough to be |
|
52 | - * used as keys or salts. They are however useful for one-time use tokens. |
|
53 | - * |
|
54 | - * @return $this |
|
55 | - * @since 8.0.0 |
|
56 | - * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int() |
|
57 | - */ |
|
58 | - public function getLowStrengthGenerator(); |
|
47 | + /** |
|
48 | + * Convenience method to get a low strength random number generator. |
|
49 | + * |
|
50 | + * Low Strength should be used anywhere that random strings are needed |
|
51 | + * in a non-cryptographical setting. They are not strong enough to be |
|
52 | + * used as keys or salts. They are however useful for one-time use tokens. |
|
53 | + * |
|
54 | + * @return $this |
|
55 | + * @since 8.0.0 |
|
56 | + * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int() |
|
57 | + */ |
|
58 | + public function getLowStrengthGenerator(); |
|
59 | 59 | |
60 | - /** |
|
61 | - * Convenience method to get a medium strength random number generator. |
|
62 | - * |
|
63 | - * Medium Strength should be used for most needs of a cryptographic nature. |
|
64 | - * They are strong enough to be used as keys and salts. However, they do |
|
65 | - * take some time and resources to generate, so they should not be over-used |
|
66 | - * |
|
67 | - * @return $this |
|
68 | - * @since 8.0.0 |
|
69 | - * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int() |
|
70 | - */ |
|
71 | - public function getMediumStrengthGenerator(); |
|
60 | + /** |
|
61 | + * Convenience method to get a medium strength random number generator. |
|
62 | + * |
|
63 | + * Medium Strength should be used for most needs of a cryptographic nature. |
|
64 | + * They are strong enough to be used as keys and salts. However, they do |
|
65 | + * take some time and resources to generate, so they should not be over-used |
|
66 | + * |
|
67 | + * @return $this |
|
68 | + * @since 8.0.0 |
|
69 | + * @deprecated 9.0.0 Use \OC\Security\SecureRandom::generate directly or random_bytes() / random_int() |
|
70 | + */ |
|
71 | + public function getMediumStrengthGenerator(); |
|
72 | 72 | |
73 | - /** |
|
74 | - * Generate a random string of specified length. |
|
75 | - * @param int $length The length of the generated string |
|
76 | - * @param string $characters An optional list of characters to use if no character list is |
|
77 | - * specified all valid base64 characters are used. |
|
78 | - * @return string |
|
79 | - * @since 8.0.0 |
|
80 | - */ |
|
81 | - public function generate($length, |
|
82 | - $characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'); |
|
73 | + /** |
|
74 | + * Generate a random string of specified length. |
|
75 | + * @param int $length The length of the generated string |
|
76 | + * @param string $characters An optional list of characters to use if no character list is |
|
77 | + * specified all valid base64 characters are used. |
|
78 | + * @return string |
|
79 | + * @since 8.0.0 |
|
80 | + */ |
|
81 | + public function generate($length, |
|
82 | + $characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'); |
|
83 | 83 | |
84 | 84 | } |