@@ -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 | } |
@@ -30,22 +30,22 @@ |
||
30 | 30 | * @since 9.0.0 |
31 | 31 | */ |
32 | 32 | interface IContentSecurityPolicyManager { |
33 | - /** |
|
34 | - * Allows to inject something into the default content policy. This is for |
|
35 | - * example useful when you're injecting Javascript code into a view belonging |
|
36 | - * to another controller and cannot modify its Content-Security-Policy itself. |
|
37 | - * Note that the adjustment is only applied to applications that use AppFramework |
|
38 | - * controllers. |
|
39 | - * |
|
40 | - * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`, |
|
41 | - * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`. |
|
42 | - * |
|
43 | - * WARNING: Using this API incorrectly may make the instance more insecure. |
|
44 | - * Do think twice before adding whitelisting resources. Please do also note |
|
45 | - * that it is not possible to use the `disallowXYZ` functions. |
|
46 | - * |
|
47 | - * @param EmptyContentSecurityPolicy $policy |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function addDefaultPolicy(EmptyContentSecurityPolicy $policy); |
|
33 | + /** |
|
34 | + * Allows to inject something into the default content policy. This is for |
|
35 | + * example useful when you're injecting Javascript code into a view belonging |
|
36 | + * to another controller and cannot modify its Content-Security-Policy itself. |
|
37 | + * Note that the adjustment is only applied to applications that use AppFramework |
|
38 | + * controllers. |
|
39 | + * |
|
40 | + * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`, |
|
41 | + * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`. |
|
42 | + * |
|
43 | + * WARNING: Using this API incorrectly may make the instance more insecure. |
|
44 | + * Do think twice before adding whitelisting resources. Please do also note |
|
45 | + * that it is not possible to use the `disallowXYZ` functions. |
|
46 | + * |
|
47 | + * @param EmptyContentSecurityPolicy $policy |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function addDefaultPolicy(EmptyContentSecurityPolicy $policy); |
|
51 | 51 | } |
@@ -36,30 +36,30 @@ |
||
36 | 36 | */ |
37 | 37 | interface ICrypto { |
38 | 38 | |
39 | - /** |
|
40 | - * @param string $message The message to authenticate |
|
41 | - * @param string $password Password to use (defaults to `secret` in config.php) |
|
42 | - * @return string Calculated HMAC |
|
43 | - * @since 8.0.0 |
|
44 | - */ |
|
45 | - public function calculateHMAC($message, $password = ''); |
|
39 | + /** |
|
40 | + * @param string $message The message to authenticate |
|
41 | + * @param string $password Password to use (defaults to `secret` in config.php) |
|
42 | + * @return string Calculated HMAC |
|
43 | + * @since 8.0.0 |
|
44 | + */ |
|
45 | + public function calculateHMAC($message, $password = ''); |
|
46 | 46 | |
47 | - /** |
|
48 | - * Encrypts a value and adds an HMAC (Encrypt-Then-MAC) |
|
49 | - * @param string $plaintext |
|
50 | - * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
51 | - * @return string Authenticated ciphertext |
|
52 | - * @since 8.0.0 |
|
53 | - */ |
|
54 | - public function encrypt($plaintext, $password = ''); |
|
47 | + /** |
|
48 | + * Encrypts a value and adds an HMAC (Encrypt-Then-MAC) |
|
49 | + * @param string $plaintext |
|
50 | + * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
51 | + * @return string Authenticated ciphertext |
|
52 | + * @since 8.0.0 |
|
53 | + */ |
|
54 | + public function encrypt($plaintext, $password = ''); |
|
55 | 55 | |
56 | - /** |
|
57 | - * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac) |
|
58 | - * @param string $authenticatedCiphertext |
|
59 | - * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
60 | - * @return string plaintext |
|
61 | - * @throws \Exception If the HMAC does not match |
|
62 | - * @since 8.0.0 |
|
63 | - */ |
|
64 | - public function decrypt($authenticatedCiphertext, $password = ''); |
|
56 | + /** |
|
57 | + * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac) |
|
58 | + * @param string $authenticatedCiphertext |
|
59 | + * @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
60 | + * @return string plaintext |
|
61 | + * @throws \Exception If the HMAC does not match |
|
62 | + * @since 8.0.0 |
|
63 | + */ |
|
64 | + public function decrypt($authenticatedCiphertext, $password = ''); |
|
65 | 65 | } |
@@ -47,57 +47,57 @@ |
||
47 | 47 | */ |
48 | 48 | interface IContainer { |
49 | 49 | |
50 | - /** |
|
51 | - * If a parameter is not registered in the container try to instantiate it |
|
52 | - * by using reflection to find out how to build the class |
|
53 | - * @param string $name the class name to resolve |
|
54 | - * @return \stdClass |
|
55 | - * @since 8.2.0 |
|
56 | - * @throws QueryException if the class could not be found or instantiated |
|
57 | - */ |
|
58 | - public function resolve($name); |
|
50 | + /** |
|
51 | + * If a parameter is not registered in the container try to instantiate it |
|
52 | + * by using reflection to find out how to build the class |
|
53 | + * @param string $name the class name to resolve |
|
54 | + * @return \stdClass |
|
55 | + * @since 8.2.0 |
|
56 | + * @throws QueryException if the class could not be found or instantiated |
|
57 | + */ |
|
58 | + public function resolve($name); |
|
59 | 59 | |
60 | - /** |
|
61 | - * Look up a service for a given name in the container. |
|
62 | - * |
|
63 | - * @param string $name |
|
64 | - * @return mixed |
|
65 | - * @since 6.0.0 |
|
66 | - */ |
|
67 | - public function query($name); |
|
60 | + /** |
|
61 | + * Look up a service for a given name in the container. |
|
62 | + * |
|
63 | + * @param string $name |
|
64 | + * @return mixed |
|
65 | + * @since 6.0.0 |
|
66 | + */ |
|
67 | + public function query($name); |
|
68 | 68 | |
69 | - /** |
|
70 | - * A value is stored in the container with it's corresponding name |
|
71 | - * |
|
72 | - * @param string $name |
|
73 | - * @param mixed $value |
|
74 | - * @return void |
|
75 | - * @since 6.0.0 |
|
76 | - */ |
|
77 | - public function registerParameter($name, $value); |
|
69 | + /** |
|
70 | + * A value is stored in the container with it's corresponding name |
|
71 | + * |
|
72 | + * @param string $name |
|
73 | + * @param mixed $value |
|
74 | + * @return void |
|
75 | + * @since 6.0.0 |
|
76 | + */ |
|
77 | + public function registerParameter($name, $value); |
|
78 | 78 | |
79 | - /** |
|
80 | - * A service is registered in the container where a closure is passed in which will actually |
|
81 | - * create the service on demand. |
|
82 | - * In case the parameter $shared is set to true (the default usage) the once created service will remain in |
|
83 | - * memory and be reused on subsequent calls. |
|
84 | - * In case the parameter is false the service will be recreated on every call. |
|
85 | - * |
|
86 | - * @param string $name |
|
87 | - * @param \Closure $closure |
|
88 | - * @param bool $shared |
|
89 | - * @return void |
|
90 | - * @since 6.0.0 |
|
91 | - */ |
|
92 | - public function registerService($name, Closure $closure, $shared = true); |
|
79 | + /** |
|
80 | + * A service is registered in the container where a closure is passed in which will actually |
|
81 | + * create the service on demand. |
|
82 | + * In case the parameter $shared is set to true (the default usage) the once created service will remain in |
|
83 | + * memory and be reused on subsequent calls. |
|
84 | + * In case the parameter is false the service will be recreated on every call. |
|
85 | + * |
|
86 | + * @param string $name |
|
87 | + * @param \Closure $closure |
|
88 | + * @param bool $shared |
|
89 | + * @return void |
|
90 | + * @since 6.0.0 |
|
91 | + */ |
|
92 | + public function registerService($name, Closure $closure, $shared = true); |
|
93 | 93 | |
94 | - /** |
|
95 | - * Shortcut for returning a service from a service under a different key, |
|
96 | - * e.g. to tell the container to return a class when queried for an |
|
97 | - * interface |
|
98 | - * @param string $alias the alias that should be registered |
|
99 | - * @param string $target the target that should be resolved instead |
|
100 | - * @since 8.2.0 |
|
101 | - */ |
|
102 | - public function registerAlias($alias, $target); |
|
94 | + /** |
|
95 | + * Shortcut for returning a service from a service under a different key, |
|
96 | + * e.g. to tell the container to return a class when queried for an |
|
97 | + * interface |
|
98 | + * @param string $alias the alias that should be registered |
|
99 | + * @param string $target the target that should be resolved instead |
|
100 | + * @since 8.2.0 |
|
101 | + */ |
|
102 | + public function registerAlias($alias, $target); |
|
103 | 103 | } |
@@ -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 | } |
@@ -31,28 +31,28 @@ |
||
31 | 31 | * @since 8.1.0 |
32 | 32 | */ |
33 | 33 | interface IResponse { |
34 | - /** |
|
35 | - * @return string|resource |
|
36 | - * @since 8.1.0 |
|
37 | - */ |
|
38 | - public function getBody(); |
|
34 | + /** |
|
35 | + * @return string|resource |
|
36 | + * @since 8.1.0 |
|
37 | + */ |
|
38 | + public function getBody(); |
|
39 | 39 | |
40 | - /** |
|
41 | - * @return int |
|
42 | - * @since 8.1.0 |
|
43 | - */ |
|
44 | - public function getStatusCode(); |
|
40 | + /** |
|
41 | + * @return int |
|
42 | + * @since 8.1.0 |
|
43 | + */ |
|
44 | + public function getStatusCode(); |
|
45 | 45 | |
46 | - /** |
|
47 | - * @param $key |
|
48 | - * @return string |
|
49 | - * @since 8.1.0 |
|
50 | - */ |
|
51 | - public function getHeader($key); |
|
46 | + /** |
|
47 | + * @param $key |
|
48 | + * @return string |
|
49 | + * @since 8.1.0 |
|
50 | + */ |
|
51 | + public function getHeader($key); |
|
52 | 52 | |
53 | - /** |
|
54 | - * @return array |
|
55 | - * @since 8.1.0 |
|
56 | - */ |
|
57 | - public function getHeaders(); |
|
53 | + /** |
|
54 | + * @return array |
|
55 | + * @since 8.1.0 |
|
56 | + */ |
|
57 | + public function getHeaders(); |
|
58 | 58 | } |
@@ -31,178 +31,178 @@ |
||
31 | 31 | */ |
32 | 32 | interface IClient { |
33 | 33 | |
34 | - /** |
|
35 | - * Sends a GET request |
|
36 | - * @param string $uri |
|
37 | - * @param array $options Array such as |
|
38 | - * 'query' => [ |
|
39 | - * 'field' => 'abc', |
|
40 | - * 'other_field' => '123', |
|
41 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
42 | - * ], |
|
43 | - * 'headers' => [ |
|
44 | - * 'foo' => 'bar', |
|
45 | - * ], |
|
46 | - * 'cookies' => [' |
|
47 | - * 'foo' => 'bar', |
|
48 | - * ], |
|
49 | - * 'allow_redirects' => [ |
|
50 | - * 'max' => 10, // allow at most 10 redirects. |
|
51 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
52 | - * 'referer' => true, // add a Referer header |
|
53 | - * 'protocols' => ['https'] // only allow https URLs |
|
54 | - * ], |
|
55 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
56 | - * 'verify' => true, // bool or string to CA file |
|
57 | - * 'debug' => true, |
|
58 | - * @return IResponse |
|
59 | - * @throws \Exception If the request could not get completed |
|
60 | - * @since 8.1.0 |
|
61 | - */ |
|
62 | - public function get($uri, array $options = []); |
|
34 | + /** |
|
35 | + * Sends a GET request |
|
36 | + * @param string $uri |
|
37 | + * @param array $options Array such as |
|
38 | + * 'query' => [ |
|
39 | + * 'field' => 'abc', |
|
40 | + * 'other_field' => '123', |
|
41 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
42 | + * ], |
|
43 | + * 'headers' => [ |
|
44 | + * 'foo' => 'bar', |
|
45 | + * ], |
|
46 | + * 'cookies' => [' |
|
47 | + * 'foo' => 'bar', |
|
48 | + * ], |
|
49 | + * 'allow_redirects' => [ |
|
50 | + * 'max' => 10, // allow at most 10 redirects. |
|
51 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
52 | + * 'referer' => true, // add a Referer header |
|
53 | + * 'protocols' => ['https'] // only allow https URLs |
|
54 | + * ], |
|
55 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
56 | + * 'verify' => true, // bool or string to CA file |
|
57 | + * 'debug' => true, |
|
58 | + * @return IResponse |
|
59 | + * @throws \Exception If the request could not get completed |
|
60 | + * @since 8.1.0 |
|
61 | + */ |
|
62 | + public function get($uri, array $options = []); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Sends a HEAD request |
|
66 | - * @param string $uri |
|
67 | - * @param array $options Array such as |
|
68 | - * 'headers' => [ |
|
69 | - * 'foo' => 'bar', |
|
70 | - * ], |
|
71 | - * 'cookies' => [' |
|
72 | - * 'foo' => 'bar', |
|
73 | - * ], |
|
74 | - * 'allow_redirects' => [ |
|
75 | - * 'max' => 10, // allow at most 10 redirects. |
|
76 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
77 | - * 'referer' => true, // add a Referer header |
|
78 | - * 'protocols' => ['https'] // only allow https URLs |
|
79 | - * ], |
|
80 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
81 | - * 'verify' => true, // bool or string to CA file |
|
82 | - * 'debug' => true, |
|
83 | - * @return IResponse |
|
84 | - * @throws \Exception If the request could not get completed |
|
85 | - * @since 8.1.0 |
|
86 | - */ |
|
87 | - public function head($uri, $options = []); |
|
64 | + /** |
|
65 | + * Sends a HEAD request |
|
66 | + * @param string $uri |
|
67 | + * @param array $options Array such as |
|
68 | + * 'headers' => [ |
|
69 | + * 'foo' => 'bar', |
|
70 | + * ], |
|
71 | + * 'cookies' => [' |
|
72 | + * 'foo' => 'bar', |
|
73 | + * ], |
|
74 | + * 'allow_redirects' => [ |
|
75 | + * 'max' => 10, // allow at most 10 redirects. |
|
76 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
77 | + * 'referer' => true, // add a Referer header |
|
78 | + * 'protocols' => ['https'] // only allow https URLs |
|
79 | + * ], |
|
80 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
81 | + * 'verify' => true, // bool or string to CA file |
|
82 | + * 'debug' => true, |
|
83 | + * @return IResponse |
|
84 | + * @throws \Exception If the request could not get completed |
|
85 | + * @since 8.1.0 |
|
86 | + */ |
|
87 | + public function head($uri, $options = []); |
|
88 | 88 | |
89 | - /** |
|
90 | - * Sends a POST request |
|
91 | - * @param string $uri |
|
92 | - * @param array $options Array such as |
|
93 | - * 'body' => [ |
|
94 | - * 'field' => 'abc', |
|
95 | - * 'other_field' => '123', |
|
96 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
97 | - * ], |
|
98 | - * 'headers' => [ |
|
99 | - * 'foo' => 'bar', |
|
100 | - * ], |
|
101 | - * 'cookies' => [' |
|
102 | - * 'foo' => 'bar', |
|
103 | - * ], |
|
104 | - * 'allow_redirects' => [ |
|
105 | - * 'max' => 10, // allow at most 10 redirects. |
|
106 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
107 | - * 'referer' => true, // add a Referer header |
|
108 | - * 'protocols' => ['https'] // only allow https URLs |
|
109 | - * ], |
|
110 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
111 | - * 'verify' => true, // bool or string to CA file |
|
112 | - * 'debug' => true, |
|
113 | - * @return IResponse |
|
114 | - * @throws \Exception If the request could not get completed |
|
115 | - * @since 8.1.0 |
|
116 | - */ |
|
117 | - public function post($uri, array $options = []); |
|
89 | + /** |
|
90 | + * Sends a POST request |
|
91 | + * @param string $uri |
|
92 | + * @param array $options Array such as |
|
93 | + * 'body' => [ |
|
94 | + * 'field' => 'abc', |
|
95 | + * 'other_field' => '123', |
|
96 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
97 | + * ], |
|
98 | + * 'headers' => [ |
|
99 | + * 'foo' => 'bar', |
|
100 | + * ], |
|
101 | + * 'cookies' => [' |
|
102 | + * 'foo' => 'bar', |
|
103 | + * ], |
|
104 | + * 'allow_redirects' => [ |
|
105 | + * 'max' => 10, // allow at most 10 redirects. |
|
106 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
107 | + * 'referer' => true, // add a Referer header |
|
108 | + * 'protocols' => ['https'] // only allow https URLs |
|
109 | + * ], |
|
110 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
111 | + * 'verify' => true, // bool or string to CA file |
|
112 | + * 'debug' => true, |
|
113 | + * @return IResponse |
|
114 | + * @throws \Exception If the request could not get completed |
|
115 | + * @since 8.1.0 |
|
116 | + */ |
|
117 | + public function post($uri, array $options = []); |
|
118 | 118 | |
119 | - /** |
|
120 | - * Sends a PUT request |
|
121 | - * @param string $uri |
|
122 | - * @param array $options Array such as |
|
123 | - * 'body' => [ |
|
124 | - * 'field' => 'abc', |
|
125 | - * 'other_field' => '123', |
|
126 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
127 | - * ], |
|
128 | - * 'headers' => [ |
|
129 | - * 'foo' => 'bar', |
|
130 | - * ], |
|
131 | - * 'cookies' => [' |
|
132 | - * 'foo' => 'bar', |
|
133 | - * ], |
|
134 | - * 'allow_redirects' => [ |
|
135 | - * 'max' => 10, // allow at most 10 redirects. |
|
136 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
137 | - * 'referer' => true, // add a Referer header |
|
138 | - * 'protocols' => ['https'] // only allow https URLs |
|
139 | - * ], |
|
140 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
141 | - * 'verify' => true, // bool or string to CA file |
|
142 | - * 'debug' => true, |
|
143 | - * @return IResponse |
|
144 | - * @throws \Exception If the request could not get completed |
|
145 | - * @since 8.1.0 |
|
146 | - */ |
|
147 | - public function put($uri, array $options = []); |
|
119 | + /** |
|
120 | + * Sends a PUT request |
|
121 | + * @param string $uri |
|
122 | + * @param array $options Array such as |
|
123 | + * 'body' => [ |
|
124 | + * 'field' => 'abc', |
|
125 | + * 'other_field' => '123', |
|
126 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
127 | + * ], |
|
128 | + * 'headers' => [ |
|
129 | + * 'foo' => 'bar', |
|
130 | + * ], |
|
131 | + * 'cookies' => [' |
|
132 | + * 'foo' => 'bar', |
|
133 | + * ], |
|
134 | + * 'allow_redirects' => [ |
|
135 | + * 'max' => 10, // allow at most 10 redirects. |
|
136 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
137 | + * 'referer' => true, // add a Referer header |
|
138 | + * 'protocols' => ['https'] // only allow https URLs |
|
139 | + * ], |
|
140 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
141 | + * 'verify' => true, // bool or string to CA file |
|
142 | + * 'debug' => true, |
|
143 | + * @return IResponse |
|
144 | + * @throws \Exception If the request could not get completed |
|
145 | + * @since 8.1.0 |
|
146 | + */ |
|
147 | + public function put($uri, array $options = []); |
|
148 | 148 | |
149 | - /** |
|
150 | - * Sends a DELETE request |
|
151 | - * @param string $uri |
|
152 | - * @param array $options Array such as |
|
153 | - * 'body' => [ |
|
154 | - * 'field' => 'abc', |
|
155 | - * 'other_field' => '123', |
|
156 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
157 | - * ], |
|
158 | - * 'headers' => [ |
|
159 | - * 'foo' => 'bar', |
|
160 | - * ], |
|
161 | - * 'cookies' => [' |
|
162 | - * 'foo' => 'bar', |
|
163 | - * ], |
|
164 | - * 'allow_redirects' => [ |
|
165 | - * 'max' => 10, // allow at most 10 redirects. |
|
166 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
167 | - * 'referer' => true, // add a Referer header |
|
168 | - * 'protocols' => ['https'] // only allow https URLs |
|
169 | - * ], |
|
170 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
171 | - * 'verify' => true, // bool or string to CA file |
|
172 | - * 'debug' => true, |
|
173 | - * @return IResponse |
|
174 | - * @throws \Exception If the request could not get completed |
|
175 | - * @since 8.1.0 |
|
176 | - */ |
|
177 | - public function delete($uri, array $options = []); |
|
149 | + /** |
|
150 | + * Sends a DELETE request |
|
151 | + * @param string $uri |
|
152 | + * @param array $options Array such as |
|
153 | + * 'body' => [ |
|
154 | + * 'field' => 'abc', |
|
155 | + * 'other_field' => '123', |
|
156 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
157 | + * ], |
|
158 | + * 'headers' => [ |
|
159 | + * 'foo' => 'bar', |
|
160 | + * ], |
|
161 | + * 'cookies' => [' |
|
162 | + * 'foo' => 'bar', |
|
163 | + * ], |
|
164 | + * 'allow_redirects' => [ |
|
165 | + * 'max' => 10, // allow at most 10 redirects. |
|
166 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
167 | + * 'referer' => true, // add a Referer header |
|
168 | + * 'protocols' => ['https'] // only allow https URLs |
|
169 | + * ], |
|
170 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
171 | + * 'verify' => true, // bool or string to CA file |
|
172 | + * 'debug' => true, |
|
173 | + * @return IResponse |
|
174 | + * @throws \Exception If the request could not get completed |
|
175 | + * @since 8.1.0 |
|
176 | + */ |
|
177 | + public function delete($uri, array $options = []); |
|
178 | 178 | |
179 | - /** |
|
180 | - * Sends a options request |
|
181 | - * @param string $uri |
|
182 | - * @param array $options Array such as |
|
183 | - * 'body' => [ |
|
184 | - * 'field' => 'abc', |
|
185 | - * 'other_field' => '123', |
|
186 | - * 'file_name' => fopen('/path/to/file', 'r'), |
|
187 | - * ], |
|
188 | - * 'headers' => [ |
|
189 | - * 'foo' => 'bar', |
|
190 | - * ], |
|
191 | - * 'cookies' => [' |
|
192 | - * 'foo' => 'bar', |
|
193 | - * ], |
|
194 | - * 'allow_redirects' => [ |
|
195 | - * 'max' => 10, // allow at most 10 redirects. |
|
196 | - * 'strict' => true, // use "strict" RFC compliant redirects. |
|
197 | - * 'referer' => true, // add a Referer header |
|
198 | - * 'protocols' => ['https'] // only allow https URLs |
|
199 | - * ], |
|
200 | - * 'save_to' => '/path/to/file', // save to a file or a stream |
|
201 | - * 'verify' => true, // bool or string to CA file |
|
202 | - * 'debug' => true, |
|
203 | - * @return IResponse |
|
204 | - * @throws \Exception If the request could not get completed |
|
205 | - * @since 8.1.0 |
|
206 | - */ |
|
207 | - public function options($uri, array $options = []); |
|
179 | + /** |
|
180 | + * Sends a options request |
|
181 | + * @param string $uri |
|
182 | + * @param array $options Array such as |
|
183 | + * 'body' => [ |
|
184 | + * 'field' => 'abc', |
|
185 | + * 'other_field' => '123', |
|
186 | + * 'file_name' => fopen('/path/to/file', 'r'), |
|
187 | + * ], |
|
188 | + * 'headers' => [ |
|
189 | + * 'foo' => 'bar', |
|
190 | + * ], |
|
191 | + * 'cookies' => [' |
|
192 | + * 'foo' => 'bar', |
|
193 | + * ], |
|
194 | + * 'allow_redirects' => [ |
|
195 | + * 'max' => 10, // allow at most 10 redirects. |
|
196 | + * 'strict' => true, // use "strict" RFC compliant redirects. |
|
197 | + * 'referer' => true, // add a Referer header |
|
198 | + * 'protocols' => ['https'] // only allow https URLs |
|
199 | + * ], |
|
200 | + * 'save_to' => '/path/to/file', // save to a file or a stream |
|
201 | + * 'verify' => true, // bool or string to CA file |
|
202 | + * 'debug' => true, |
|
203 | + * @return IResponse |
|
204 | + * @throws \Exception If the request could not get completed |
|
205 | + * @since 8.1.0 |
|
206 | + */ |
|
207 | + public function options($uri, array $options = []); |
|
208 | 208 | } |
@@ -30,9 +30,9 @@ |
||
30 | 30 | * @since 8.1.0 |
31 | 31 | */ |
32 | 32 | interface IClientService { |
33 | - /** |
|
34 | - * @return IClient |
|
35 | - * @since 8.1.0 |
|
36 | - */ |
|
37 | - public function newClient(); |
|
33 | + /** |
|
34 | + * @return IClient |
|
35 | + * @since 8.1.0 |
|
36 | + */ |
|
37 | + public function newClient(); |
|
38 | 38 | } |
@@ -41,187 +41,187 @@ |
||
41 | 41 | * @since 6.0.0 |
42 | 42 | */ |
43 | 43 | interface IConfig { |
44 | - /** |
|
45 | - * @since 8.2.0 |
|
46 | - */ |
|
47 | - const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***'; |
|
48 | - |
|
49 | - /** |
|
50 | - * Sets and deletes system wide values |
|
51 | - * |
|
52 | - * @param array $configs Associative array with `key => value` pairs |
|
53 | - * If value is null, the config key will be deleted |
|
54 | - * @since 8.0.0 |
|
55 | - */ |
|
56 | - public function setSystemValues(array $configs); |
|
57 | - |
|
58 | - /** |
|
59 | - * Sets a new system wide value |
|
60 | - * |
|
61 | - * @param string $key the key of the value, under which will be saved |
|
62 | - * @param mixed $value the value that should be stored |
|
63 | - * @since 8.0.0 |
|
64 | - */ |
|
65 | - public function setSystemValue($key, $value); |
|
66 | - |
|
67 | - /** |
|
68 | - * Looks up a system wide defined value |
|
69 | - * |
|
70 | - * @param string $key the key of the value, under which it was saved |
|
71 | - * @param mixed $default the default value to be returned if the value isn't set |
|
72 | - * @return mixed the value or $default |
|
73 | - * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
74 | - */ |
|
75 | - public function getSystemValue($key, $default = ''); |
|
76 | - |
|
77 | - /** |
|
78 | - * Looks up a system wide defined value and filters out sensitive data |
|
79 | - * |
|
80 | - * @param string $key the key of the value, under which it was saved |
|
81 | - * @param mixed $default the default value to be returned if the value isn't set |
|
82 | - * @return mixed the value or $default |
|
83 | - * @since 8.2.0 |
|
84 | - */ |
|
85 | - public function getFilteredSystemValue($key, $default = ''); |
|
86 | - |
|
87 | - /** |
|
88 | - * Delete a system wide defined value |
|
89 | - * |
|
90 | - * @param string $key the key of the value, under which it was saved |
|
91 | - * @since 8.0.0 |
|
92 | - */ |
|
93 | - public function deleteSystemValue($key); |
|
94 | - |
|
95 | - /** |
|
96 | - * Get all keys stored for an app |
|
97 | - * |
|
98 | - * @param string $appName the appName that we stored the value under |
|
99 | - * @return string[] the keys stored for the app |
|
100 | - * @since 8.0.0 |
|
101 | - */ |
|
102 | - public function getAppKeys($appName); |
|
103 | - |
|
104 | - /** |
|
105 | - * Writes a new app wide value |
|
106 | - * |
|
107 | - * @param string $appName the appName that we want to store the value under |
|
108 | - * @param string|float|int $key the key of the value, under which will be saved |
|
109 | - * @param string $value the value that should be stored |
|
110 | - * @return void |
|
111 | - * @since 6.0.0 |
|
112 | - */ |
|
113 | - public function setAppValue($appName, $key, $value); |
|
114 | - |
|
115 | - /** |
|
116 | - * Looks up an app wide defined value |
|
117 | - * |
|
118 | - * @param string $appName the appName that we stored the value under |
|
119 | - * @param string $key the key of the value, under which it was saved |
|
120 | - * @param string $default the default value to be returned if the value isn't set |
|
121 | - * @return string the saved value |
|
122 | - * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
123 | - */ |
|
124 | - public function getAppValue($appName, $key, $default = ''); |
|
125 | - |
|
126 | - /** |
|
127 | - * Delete an app wide defined value |
|
128 | - * |
|
129 | - * @param string $appName the appName that we stored the value under |
|
130 | - * @param string $key the key of the value, under which it was saved |
|
131 | - * @since 8.0.0 |
|
132 | - */ |
|
133 | - public function deleteAppValue($appName, $key); |
|
134 | - |
|
135 | - /** |
|
136 | - * Removes all keys in appconfig belonging to the app |
|
137 | - * |
|
138 | - * @param string $appName the appName the configs are stored under |
|
139 | - * @since 8.0.0 |
|
140 | - */ |
|
141 | - public function deleteAppValues($appName); |
|
142 | - |
|
143 | - |
|
144 | - /** |
|
145 | - * Set a user defined value |
|
146 | - * |
|
147 | - * @param string $userId the userId of the user that we want to store the value under |
|
148 | - * @param string $appName the appName that we want to store the value under |
|
149 | - * @param string $key the key under which the value is being stored |
|
150 | - * @param string $value the value that you want to store |
|
151 | - * @param string $preCondition only update if the config value was previously the value passed as $preCondition |
|
152 | - * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met |
|
153 | - * @throws \UnexpectedValueException when trying to store an unexpected value |
|
154 | - * @since 6.0.0 - parameter $precondition was added in 8.0.0 |
|
155 | - */ |
|
156 | - public function setUserValue($userId, $appName, $key, $value, $preCondition = null); |
|
157 | - |
|
158 | - /** |
|
159 | - * Shortcut for getting a user defined value |
|
160 | - * |
|
161 | - * @param string $userId the userId of the user that we want to store the value under |
|
162 | - * @param string $appName the appName that we stored the value under |
|
163 | - * @param string $key the key under which the value is being stored |
|
164 | - * @param mixed $default the default value to be returned if the value isn't set |
|
165 | - * @return string |
|
166 | - * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
167 | - */ |
|
168 | - public function getUserValue($userId, $appName, $key, $default = ''); |
|
169 | - |
|
170 | - /** |
|
171 | - * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. |
|
172 | - * |
|
173 | - * @param string $appName app to get the value for |
|
174 | - * @param string $key the key to get the value for |
|
175 | - * @param array $userIds the user IDs to fetch the values for |
|
176 | - * @return array Mapped values: userId => value |
|
177 | - * @since 8.0.0 |
|
178 | - */ |
|
179 | - public function getUserValueForUsers($appName, $key, $userIds); |
|
180 | - |
|
181 | - /** |
|
182 | - * Get the keys of all stored by an app for the user |
|
183 | - * |
|
184 | - * @param string $userId the userId of the user that we want to store the value under |
|
185 | - * @param string $appName the appName that we stored the value under |
|
186 | - * @return string[] |
|
187 | - * @since 8.0.0 |
|
188 | - */ |
|
189 | - public function getUserKeys($userId, $appName); |
|
190 | - |
|
191 | - /** |
|
192 | - * Delete a user value |
|
193 | - * |
|
194 | - * @param string $userId the userId of the user that we want to store the value under |
|
195 | - * @param string $appName the appName that we stored the value under |
|
196 | - * @param string $key the key under which the value is being stored |
|
197 | - * @since 8.0.0 |
|
198 | - */ |
|
199 | - public function deleteUserValue($userId, $appName, $key); |
|
200 | - |
|
201 | - /** |
|
202 | - * Delete all user values |
|
203 | - * |
|
204 | - * @param string $userId the userId of the user that we want to remove all values from |
|
205 | - * @since 8.0.0 |
|
206 | - */ |
|
207 | - public function deleteAllUserValues($userId); |
|
208 | - |
|
209 | - /** |
|
210 | - * Delete all user related values of one app |
|
211 | - * |
|
212 | - * @param string $appName the appName of the app that we want to remove all values from |
|
213 | - * @since 8.0.0 |
|
214 | - */ |
|
215 | - public function deleteAppFromAllUsers($appName); |
|
216 | - |
|
217 | - /** |
|
218 | - * Determines the users that have the given value set for a specific app-key-pair |
|
219 | - * |
|
220 | - * @param string $appName the app to get the user for |
|
221 | - * @param string $key the key to get the user for |
|
222 | - * @param string $value the value to get the user for |
|
223 | - * @return array of user IDs |
|
224 | - * @since 8.0.0 |
|
225 | - */ |
|
226 | - public function getUsersForUserValue($appName, $key, $value); |
|
44 | + /** |
|
45 | + * @since 8.2.0 |
|
46 | + */ |
|
47 | + const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***'; |
|
48 | + |
|
49 | + /** |
|
50 | + * Sets and deletes system wide values |
|
51 | + * |
|
52 | + * @param array $configs Associative array with `key => value` pairs |
|
53 | + * If value is null, the config key will be deleted |
|
54 | + * @since 8.0.0 |
|
55 | + */ |
|
56 | + public function setSystemValues(array $configs); |
|
57 | + |
|
58 | + /** |
|
59 | + * Sets a new system wide value |
|
60 | + * |
|
61 | + * @param string $key the key of the value, under which will be saved |
|
62 | + * @param mixed $value the value that should be stored |
|
63 | + * @since 8.0.0 |
|
64 | + */ |
|
65 | + public function setSystemValue($key, $value); |
|
66 | + |
|
67 | + /** |
|
68 | + * Looks up a system wide defined value |
|
69 | + * |
|
70 | + * @param string $key the key of the value, under which it was saved |
|
71 | + * @param mixed $default the default value to be returned if the value isn't set |
|
72 | + * @return mixed the value or $default |
|
73 | + * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
74 | + */ |
|
75 | + public function getSystemValue($key, $default = ''); |
|
76 | + |
|
77 | + /** |
|
78 | + * Looks up a system wide defined value and filters out sensitive data |
|
79 | + * |
|
80 | + * @param string $key the key of the value, under which it was saved |
|
81 | + * @param mixed $default the default value to be returned if the value isn't set |
|
82 | + * @return mixed the value or $default |
|
83 | + * @since 8.2.0 |
|
84 | + */ |
|
85 | + public function getFilteredSystemValue($key, $default = ''); |
|
86 | + |
|
87 | + /** |
|
88 | + * Delete a system wide defined value |
|
89 | + * |
|
90 | + * @param string $key the key of the value, under which it was saved |
|
91 | + * @since 8.0.0 |
|
92 | + */ |
|
93 | + public function deleteSystemValue($key); |
|
94 | + |
|
95 | + /** |
|
96 | + * Get all keys stored for an app |
|
97 | + * |
|
98 | + * @param string $appName the appName that we stored the value under |
|
99 | + * @return string[] the keys stored for the app |
|
100 | + * @since 8.0.0 |
|
101 | + */ |
|
102 | + public function getAppKeys($appName); |
|
103 | + |
|
104 | + /** |
|
105 | + * Writes a new app wide value |
|
106 | + * |
|
107 | + * @param string $appName the appName that we want to store the value under |
|
108 | + * @param string|float|int $key the key of the value, under which will be saved |
|
109 | + * @param string $value the value that should be stored |
|
110 | + * @return void |
|
111 | + * @since 6.0.0 |
|
112 | + */ |
|
113 | + public function setAppValue($appName, $key, $value); |
|
114 | + |
|
115 | + /** |
|
116 | + * Looks up an app wide defined value |
|
117 | + * |
|
118 | + * @param string $appName the appName that we stored the value under |
|
119 | + * @param string $key the key of the value, under which it was saved |
|
120 | + * @param string $default the default value to be returned if the value isn't set |
|
121 | + * @return string the saved value |
|
122 | + * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
123 | + */ |
|
124 | + public function getAppValue($appName, $key, $default = ''); |
|
125 | + |
|
126 | + /** |
|
127 | + * Delete an app wide defined value |
|
128 | + * |
|
129 | + * @param string $appName the appName that we stored the value under |
|
130 | + * @param string $key the key of the value, under which it was saved |
|
131 | + * @since 8.0.0 |
|
132 | + */ |
|
133 | + public function deleteAppValue($appName, $key); |
|
134 | + |
|
135 | + /** |
|
136 | + * Removes all keys in appconfig belonging to the app |
|
137 | + * |
|
138 | + * @param string $appName the appName the configs are stored under |
|
139 | + * @since 8.0.0 |
|
140 | + */ |
|
141 | + public function deleteAppValues($appName); |
|
142 | + |
|
143 | + |
|
144 | + /** |
|
145 | + * Set a user defined value |
|
146 | + * |
|
147 | + * @param string $userId the userId of the user that we want to store the value under |
|
148 | + * @param string $appName the appName that we want to store the value under |
|
149 | + * @param string $key the key under which the value is being stored |
|
150 | + * @param string $value the value that you want to store |
|
151 | + * @param string $preCondition only update if the config value was previously the value passed as $preCondition |
|
152 | + * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met |
|
153 | + * @throws \UnexpectedValueException when trying to store an unexpected value |
|
154 | + * @since 6.0.0 - parameter $precondition was added in 8.0.0 |
|
155 | + */ |
|
156 | + public function setUserValue($userId, $appName, $key, $value, $preCondition = null); |
|
157 | + |
|
158 | + /** |
|
159 | + * Shortcut for getting a user defined value |
|
160 | + * |
|
161 | + * @param string $userId the userId of the user that we want to store the value under |
|
162 | + * @param string $appName the appName that we stored the value under |
|
163 | + * @param string $key the key under which the value is being stored |
|
164 | + * @param mixed $default the default value to be returned if the value isn't set |
|
165 | + * @return string |
|
166 | + * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
167 | + */ |
|
168 | + public function getUserValue($userId, $appName, $key, $default = ''); |
|
169 | + |
|
170 | + /** |
|
171 | + * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. |
|
172 | + * |
|
173 | + * @param string $appName app to get the value for |
|
174 | + * @param string $key the key to get the value for |
|
175 | + * @param array $userIds the user IDs to fetch the values for |
|
176 | + * @return array Mapped values: userId => value |
|
177 | + * @since 8.0.0 |
|
178 | + */ |
|
179 | + public function getUserValueForUsers($appName, $key, $userIds); |
|
180 | + |
|
181 | + /** |
|
182 | + * Get the keys of all stored by an app for the user |
|
183 | + * |
|
184 | + * @param string $userId the userId of the user that we want to store the value under |
|
185 | + * @param string $appName the appName that we stored the value under |
|
186 | + * @return string[] |
|
187 | + * @since 8.0.0 |
|
188 | + */ |
|
189 | + public function getUserKeys($userId, $appName); |
|
190 | + |
|
191 | + /** |
|
192 | + * Delete a user value |
|
193 | + * |
|
194 | + * @param string $userId the userId of the user that we want to store the value under |
|
195 | + * @param string $appName the appName that we stored the value under |
|
196 | + * @param string $key the key under which the value is being stored |
|
197 | + * @since 8.0.0 |
|
198 | + */ |
|
199 | + public function deleteUserValue($userId, $appName, $key); |
|
200 | + |
|
201 | + /** |
|
202 | + * Delete all user values |
|
203 | + * |
|
204 | + * @param string $userId the userId of the user that we want to remove all values from |
|
205 | + * @since 8.0.0 |
|
206 | + */ |
|
207 | + public function deleteAllUserValues($userId); |
|
208 | + |
|
209 | + /** |
|
210 | + * Delete all user related values of one app |
|
211 | + * |
|
212 | + * @param string $appName the appName of the app that we want to remove all values from |
|
213 | + * @since 8.0.0 |
|
214 | + */ |
|
215 | + public function deleteAppFromAllUsers($appName); |
|
216 | + |
|
217 | + /** |
|
218 | + * Determines the users that have the given value set for a specific app-key-pair |
|
219 | + * |
|
220 | + * @param string $appName the app to get the user for |
|
221 | + * @param string $key the key to get the user for |
|
222 | + * @param string $value the value to get the user for |
|
223 | + * @return array of user IDs |
|
224 | + * @since 8.0.0 |
|
225 | + */ |
|
226 | + public function getUsersForUserValue($appName, $key, $value); |
|
227 | 227 | } |