nextcloud / server

lib/public/Security/IHasher.php

Indentation +18 added lines, -18 removed lines

@@ -44,23 +44,23 @@
  * @since 8.0.0
  */
 interface IHasher {
-	/**
-	 * Hashes a message using PHP's `password_hash` functionality.
-	 * Please note that the size of the returned string is not guaranteed
-	 * and can be up to 255 characters.
-	 *
-	 * @param string $message Message to generate hash from
-	 * @return string Hash of the message with appended version parameter
-	 * @since 8.0.0
-	 */
-	public function hash($message);
+    /**
+     * Hashes a message using PHP's `password_hash` functionality.
+     * Please note that the size of the returned string is not guaranteed
+     * and can be up to 255 characters.
+     *
+     * @param string $message Message to generate hash from
+     * @return string Hash of the message with appended version parameter
+     * @since 8.0.0
+     */
+    public function hash($message);
 
-	/**
-	 * @param string $message Message to verify
-	 * @param string $hash Assumed hash of the message
-	 * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one.
-	 * @return bool Whether $hash is a valid hash of $message
-	 * @since 8.0.0
-	 */
-	public function verify($message, $hash, &$newHash = null);
+    /**
+     * @param string $message Message to verify
+     * @param string $hash Assumed hash of the message
+     * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one.
+     * @return bool Whether $hash is a valid hash of $message
+     * @since 8.0.0
+     */
+    public function verify($message, $hash, &$newHash = null);
 }

lib/public/Security/IContentSecurityPolicyManager.php

Indentation +18 added lines, -18 removed lines

@@ -30,22 +30,22 @@
  * @since 9.0.0
  */
 interface IContentSecurityPolicyManager {
-	/**
-	 * Allows to inject something into the default content policy. This is for
-	 * example useful when you're injecting Javascript code into a view belonging
-	 * to another controller and cannot modify its Content-Security-Policy itself.
-	 * Note that the adjustment is only applied to applications that use AppFramework
-	 * controllers.
-	 *
-	 * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`,
-	 * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`.
-	 *
-	 * WARNING: Using this API incorrectly may make the instance more insecure.
-	 * Do think twice before adding whitelisting resources. Please do also note
-	 * that it is not possible to use the `disallowXYZ` functions.
-	 *
-	 * @param EmptyContentSecurityPolicy $policy
-	 * @since 9.0.0
-	 */
-	public function addDefaultPolicy(EmptyContentSecurityPolicy $policy);
+    /**
+     * Allows to inject something into the default content policy. This is for
+     * example useful when you're injecting Javascript code into a view belonging
+     * to another controller and cannot modify its Content-Security-Policy itself.
+     * Note that the adjustment is only applied to applications that use AppFramework
+     * controllers.
+     *
+     * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`,
+     * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`.
+     *
+     * WARNING: Using this API incorrectly may make the instance more insecure.
+     * Do think twice before adding whitelisting resources. Please do also note
+     * that it is not possible to use the `disallowXYZ` functions.
+     *
+     * @param EmptyContentSecurityPolicy $policy
+     * @since 9.0.0
+     */
+    public function addDefaultPolicy(EmptyContentSecurityPolicy $policy);
 }

lib/public/Security/ICrypto.php

Indentation +24 added lines, -24 removed lines

@@ -36,30 +36,30 @@
  */
 interface ICrypto {
 
-	/**
-	 * @param string $message The message to authenticate
-	 * @param string $password Password to use (defaults to `secret` in config.php)
-	 * @return string Calculated HMAC
-	 * @since 8.0.0
-	 */
-	public function calculateHMAC($message, $password = '');
+    /**
+     * @param string $message The message to authenticate
+     * @param string $password Password to use (defaults to `secret` in config.php)
+     * @return string Calculated HMAC
+     * @since 8.0.0
+     */
+    public function calculateHMAC($message, $password = '');
 
-	/**
-	 * Encrypts a value and adds an HMAC (Encrypt-Then-MAC)
-	 * @param string $plaintext
-	 * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
-	 * @return string Authenticated ciphertext
-	 * @since 8.0.0
-	 */
-	public function encrypt($plaintext, $password = '');
+    /**
+     * Encrypts a value and adds an HMAC (Encrypt-Then-MAC)
+     * @param string $plaintext
+     * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
+     * @return string Authenticated ciphertext
+     * @since 8.0.0
+     */
+    public function encrypt($plaintext, $password = '');
 
-	/**
-	 * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac)
-	 * @param string $authenticatedCiphertext
-	 * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
-	 * @return string plaintext
-	 * @throws \Exception If the HMAC does not match
-	 * @since 8.0.0
-	 */
-	public function decrypt($authenticatedCiphertext, $password = '');
+    /**
+     * Decrypts a value and verifies the HMAC (Encrypt-Then-Mac)
+     * @param string $authenticatedCiphertext
+     * @param string $password Password to encrypt, if not specified the secret from config.php will be taken
+     * @return string plaintext
+     * @throws \Exception If the HMAC does not match
+     * @since 8.0.0
+     */
+    public function decrypt($authenticatedCiphertext, $password = '');
 }

lib/public/Federation/ICloudId.php

Indentation +28 added lines, -28 removed lines

@@ -26,35 +26,35 @@
  * @since 12.0.0
  */
 interface ICloudId {
-	/**
-	 * The remote cloud id
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getId();
+    /**
+     * The remote cloud id
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getId();
 
-	/**
-	 * Get a clean representation of the cloud id for display
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getDisplayId();
+    /**
+     * Get a clean representation of the cloud id for display
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getDisplayId();
 
-	/**
-	 * The username on the remote server
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getUser();
+    /**
+     * The username on the remote server
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getUser();
 
-	/**
-	 * The base address of the remote server
-	 *
-	 * @return string
-	 * @since 12.0.0
-	 */
-	public function getRemote();
+    /**
+     * The base address of the remote server
+     *
+     * @return string
+     * @since 12.0.0
+     */
+    public function getRemote();
 }

lib/public/Http/Client/IResponse.php

Indentation +21 added lines, -21 removed lines

@@ -31,28 +31,28 @@
  * @since 8.1.0
  */
 interface IResponse {
-	/**
-	 * @return string|resource
-	 * @since 8.1.0
-	 */
-	public function getBody();
+    /**
+     * @return string|resource
+     * @since 8.1.0
+     */
+    public function getBody();
 
-	/**
-	 * @return int
-	 * @since 8.1.0
-	 */
-	public function getStatusCode();
+    /**
+     * @return int
+     * @since 8.1.0
+     */
+    public function getStatusCode();
 
-	/**
-	 * @param $key
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function getHeader($key);
+    /**
+     * @param $key
+     * @return string
+     * @since 8.1.0
+     */
+    public function getHeader($key);
 
-	/**
-	 * @return array
-	 * @since 8.1.0
-	 */
-	public function getHeaders();
+    /**
+     * @return array
+     * @since 8.1.0
+     */
+    public function getHeaders();
 }

lib/public/Http/Client/IClient.php

Indentation +169 added lines, -169 removed lines

@@ -31,178 +31,178 @@
  */
 interface IClient {
 
-	/**
-	 * Sends a GET request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'query' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function get($uri, array $options = []);
+    /**
+     * Sends a GET request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'query' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function get($uri, array $options = []);
 
-	/**
-	 * Sends a HEAD request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function head($uri, $options = []);
+    /**
+     * Sends a HEAD request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function head($uri, $options = []);
 
-	/**
-	 * Sends a POST request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function post($uri, array $options = []);
+    /**
+     * Sends a POST request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function post($uri, array $options = []);
 
-	/**
-	 * Sends a PUT request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function put($uri, array $options = []);
+    /**
+     * Sends a PUT request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function put($uri, array $options = []);
 
-	/**
-	 * Sends a DELETE request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function delete($uri, array $options = []);
+    /**
+     * Sends a DELETE request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function delete($uri, array $options = []);
 
-	/**
-	 * Sends a options request
-	 * @param string $uri
-	 * @param array $options Array such as
-	 *              'body' => [
-	 *                  'field' => 'abc',
-	 *                  'other_field' => '123',
-	 *                  'file_name' => fopen('/path/to/file', 'r'),
-	 *              ],
-	 *              'headers' => [
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'cookies' => ['
-	 *                  'foo' => 'bar',
-	 *              ],
-	 *              'allow_redirects' => [
-	 *                   'max'       => 10,  // allow at most 10 redirects.
-	 *                   'strict'    => true,     // use "strict" RFC compliant redirects.
-	 *                   'referer'   => true,     // add a Referer header
-	 *                   'protocols' => ['https'] // only allow https URLs
-	 *              ],
-	 *              'save_to' => '/path/to/file', // save to a file or a stream
-	 *              'verify' => true, // bool or string to CA file
-	 *              'debug' => true,
-	 * @return IResponse
-	 * @throws \Exception If the request could not get completed
-	 * @since 8.1.0
-	 */
-	public function options($uri, array $options = []);
+    /**
+     * Sends a options request
+     * @param string $uri
+     * @param array $options Array such as
+     *              'body' => [
+     *                  'field' => 'abc',
+     *                  'other_field' => '123',
+     *                  'file_name' => fopen('/path/to/file', 'r'),
+     *              ],
+     *              'headers' => [
+     *                  'foo' => 'bar',
+     *              ],
+     *              'cookies' => ['
+     *                  'foo' => 'bar',
+     *              ],
+     *              'allow_redirects' => [
+     *                   'max'       => 10,  // allow at most 10 redirects.
+     *                   'strict'    => true,     // use "strict" RFC compliant redirects.
+     *                   'referer'   => true,     // add a Referer header
+     *                   'protocols' => ['https'] // only allow https URLs
+     *              ],
+     *              'save_to' => '/path/to/file', // save to a file or a stream
+     *              'verify' => true, // bool or string to CA file
+     *              'debug' => true,
+     * @return IResponse
+     * @throws \Exception If the request could not get completed
+     * @since 8.1.0
+     */
+    public function options($uri, array $options = []);
 }

lib/public/Http/Client/IClientService.php

Indentation +5 added lines, -5 removed lines

@@ -30,9 +30,9 @@
  * @since 8.1.0
  */
 interface IClientService {
-	/**
-	 * @return IClient
-	 * @since 8.1.0
-	 */
-	public function newClient();
+    /**
+     * @return IClient
+     * @since 8.1.0
+     */
+    public function newClient();
 }

lib/public/IConfig.php

Indentation +183 added lines, -183 removed lines

@@ -41,187 +41,187 @@
  * @since 6.0.0
  */
 interface IConfig {
-	/**
-	 * @since 8.2.0
-	 */
-	const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***';
-
-	/**
-	 * Sets and deletes system wide values
-	 *
-	 * @param array $configs Associative array with `key => value` pairs
-	 *                       If value is null, the config key will be deleted
-	 * @since 8.0.0
-	 */
-	public function setSystemValues(array $configs);
-
-	/**
-	 * Sets a new system wide value
-	 *
-	 * @param string $key the key of the value, under which will be saved
-	 * @param mixed $value the value that should be stored
-	 * @since 8.0.0
-	 */
-	public function setSystemValue($key, $value);
-
-	/**
-	 * Looks up a system wide defined value
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return mixed the value or $default
-	 * @since 6.0.0 - parameter $default was added in 7.0.0
-	 */
-	public function getSystemValue($key, $default = '');
-
-	/**
-	 * Looks up a system wide defined value and filters out sensitive data
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return mixed the value or $default
-	 * @since 8.2.0
-	 */
-	public function getFilteredSystemValue($key, $default = '');
-
-	/**
-	 * Delete a system wide defined value
-	 *
-	 * @param string $key the key of the value, under which it was saved
-	 * @since 8.0.0
-	 */
-	public function deleteSystemValue($key);
-
-	/**
-	 * Get all keys stored for an app
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @return string[] the keys stored for the app
-	 * @since 8.0.0
-	 */
-	public function getAppKeys($appName);
-
-	/**
-	 * Writes a new app wide value
-	 *
-	 * @param string $appName the appName that we want to store the value under
-	 * @param string|float|int $key the key of the value, under which will be saved
-	 * @param string $value the value that should be stored
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function setAppValue($appName, $key, $value);
-
-	/**
-	 * Looks up an app wide defined value
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key of the value, under which it was saved
-	 * @param string $default the default value to be returned if the value isn't set
-	 * @return string the saved value
-	 * @since 6.0.0 - parameter $default was added in 7.0.0
-	 */
-	public function getAppValue($appName, $key, $default = '');
-
-	/**
-	 * Delete an app wide defined value
-	 *
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key of the value, under which it was saved
-	 * @since 8.0.0
-	 */
-	public function deleteAppValue($appName, $key);
-
-	/**
-	 * Removes all keys in appconfig belonging to the app
-	 *
-	 * @param string $appName the appName the configs are stored under
-	 * @since 8.0.0
-	 */
-	public function deleteAppValues($appName);
-
-
-	/**
-	 * Set a user defined value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we want to store the value under
-	 * @param string $key the key under which the value is being stored
-	 * @param string $value the value that you want to store
-	 * @param string $preCondition only update if the config value was previously the value passed as $preCondition
-	 * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
-	 * @throws \UnexpectedValueException when trying to store an unexpected value
-	 * @since 6.0.0 - parameter $precondition was added in 8.0.0
-	 */
-	public function setUserValue($userId, $appName, $key, $value, $preCondition = null);
-
-	/**
-	 * Shortcut for getting a user defined value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key under which the value is being stored
-	 * @param mixed $default the default value to be returned if the value isn't set
-	 * @return string
-	 * @since 6.0.0 - parameter $default was added in 7.0.0
-	 */
-	public function getUserValue($userId, $appName, $key, $default = '');
-
-	/**
-	 * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs.
-	 *
-	 * @param string $appName app to get the value for
-	 * @param string $key the key to get the value for
-	 * @param array $userIds the user IDs to fetch the values for
-	 * @return array Mapped values: userId => value
-	 * @since 8.0.0
-	 */
-	public function getUserValueForUsers($appName, $key, $userIds);
-
-	/**
-	 * Get the keys of all stored by an app for the user
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @return string[]
-	 * @since 8.0.0
-	 */
-	public function getUserKeys($userId, $appName);
-
-	/**
-	 * Delete a user value
-	 *
-	 * @param string $userId the userId of the user that we want to store the value under
-	 * @param string $appName the appName that we stored the value under
-	 * @param string $key the key under which the value is being stored
-	 * @since 8.0.0
-	 */
-	public function deleteUserValue($userId, $appName, $key);
-
-	/**
-	 * Delete all user values
-	 *
-	 * @param string $userId the userId of the user that we want to remove all values from
-	 * @since 8.0.0
-	 */
-	public function deleteAllUserValues($userId);
-
-	/**
-	 * Delete all user related values of one app
-	 *
-	 * @param string $appName the appName of the app that we want to remove all values from
-	 * @since 8.0.0
-	 */
-	public function deleteAppFromAllUsers($appName);
-
-	/**
-	 * Determines the users that have the given value set for a specific app-key-pair
-	 *
-	 * @param string $appName the app to get the user for
-	 * @param string $key the key to get the user for
-	 * @param string $value the value to get the user for
-	 * @return array of user IDs
-	 * @since 8.0.0
-	 */
-	public function getUsersForUserValue($appName, $key, $value);
+    /**
+     * @since 8.2.0
+     */
+    const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***';
+
+    /**
+     * Sets and deletes system wide values
+     *
+     * @param array $configs Associative array with `key => value` pairs
+     *                       If value is null, the config key will be deleted
+     * @since 8.0.0
+     */
+    public function setSystemValues(array $configs);
+
+    /**
+     * Sets a new system wide value
+     *
+     * @param string $key the key of the value, under which will be saved
+     * @param mixed $value the value that should be stored
+     * @since 8.0.0
+     */
+    public function setSystemValue($key, $value);
+
+    /**
+     * Looks up a system wide defined value
+     *
+     * @param string $key the key of the value, under which it was saved
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return mixed the value or $default
+     * @since 6.0.0 - parameter $default was added in 7.0.0
+     */
+    public function getSystemValue($key, $default = '');
+
+    /**
+     * Looks up a system wide defined value and filters out sensitive data
+     *
+     * @param string $key the key of the value, under which it was saved
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return mixed the value or $default
+     * @since 8.2.0
+     */
+    public function getFilteredSystemValue($key, $default = '');
+
+    /**
+     * Delete a system wide defined value
+     *
+     * @param string $key the key of the value, under which it was saved
+     * @since 8.0.0
+     */
+    public function deleteSystemValue($key);
+
+    /**
+     * Get all keys stored for an app
+     *
+     * @param string $appName the appName that we stored the value under
+     * @return string[] the keys stored for the app
+     * @since 8.0.0
+     */
+    public function getAppKeys($appName);
+
+    /**
+     * Writes a new app wide value
+     *
+     * @param string $appName the appName that we want to store the value under
+     * @param string|float|int $key the key of the value, under which will be saved
+     * @param string $value the value that should be stored
+     * @return void
+     * @since 6.0.0
+     */
+    public function setAppValue($appName, $key, $value);
+
+    /**
+     * Looks up an app wide defined value
+     *
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key of the value, under which it was saved
+     * @param string $default the default value to be returned if the value isn't set
+     * @return string the saved value
+     * @since 6.0.0 - parameter $default was added in 7.0.0
+     */
+    public function getAppValue($appName, $key, $default = '');
+
+    /**
+     * Delete an app wide defined value
+     *
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key of the value, under which it was saved
+     * @since 8.0.0
+     */
+    public function deleteAppValue($appName, $key);
+
+    /**
+     * Removes all keys in appconfig belonging to the app
+     *
+     * @param string $appName the appName the configs are stored under
+     * @since 8.0.0
+     */
+    public function deleteAppValues($appName);
+
+
+    /**
+     * Set a user defined value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we want to store the value under
+     * @param string $key the key under which the value is being stored
+     * @param string $value the value that you want to store
+     * @param string $preCondition only update if the config value was previously the value passed as $preCondition
+     * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
+     * @throws \UnexpectedValueException when trying to store an unexpected value
+     * @since 6.0.0 - parameter $precondition was added in 8.0.0
+     */
+    public function setUserValue($userId, $appName, $key, $value, $preCondition = null);
+
+    /**
+     * Shortcut for getting a user defined value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key under which the value is being stored
+     * @param mixed $default the default value to be returned if the value isn't set
+     * @return string
+     * @since 6.0.0 - parameter $default was added in 7.0.0
+     */
+    public function getUserValue($userId, $appName, $key, $default = '');
+
+    /**
+     * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs.
+     *
+     * @param string $appName app to get the value for
+     * @param string $key the key to get the value for
+     * @param array $userIds the user IDs to fetch the values for
+     * @return array Mapped values: userId => value
+     * @since 8.0.0
+     */
+    public function getUserValueForUsers($appName, $key, $userIds);
+
+    /**
+     * Get the keys of all stored by an app for the user
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @return string[]
+     * @since 8.0.0
+     */
+    public function getUserKeys($userId, $appName);
+
+    /**
+     * Delete a user value
+     *
+     * @param string $userId the userId of the user that we want to store the value under
+     * @param string $appName the appName that we stored the value under
+     * @param string $key the key under which the value is being stored
+     * @since 8.0.0
+     */
+    public function deleteUserValue($userId, $appName, $key);
+
+    /**
+     * Delete all user values
+     *
+     * @param string $userId the userId of the user that we want to remove all values from
+     * @since 8.0.0
+     */
+    public function deleteAllUserValues($userId);
+
+    /**
+     * Delete all user related values of one app
+     *
+     * @param string $appName the appName of the app that we want to remove all values from
+     * @since 8.0.0
+     */
+    public function deleteAppFromAllUsers($appName);
+
+    /**
+     * Determines the users that have the given value set for a specific app-key-pair
+     *
+     * @param string $appName the app to get the user for
+     * @param string $key the key to get the user for
+     * @param string $value the value to get the user for
+     * @return array of user IDs
+     * @since 8.0.0
+     */
+    public function getUsersForUserValue($appName, $key, $value);
 }

lib/public/Comments/CommentsEvent.php

Indentation +33 added lines, -33 removed lines

@@ -32,41 +32,41 @@
  */
 class CommentsEvent extends Event {
 
-	const EVENT_ADD        = 'OCP\Comments\ICommentsManager::addComment';
-	const EVENT_PRE_UPDATE = 'OCP\Comments\ICommentsManager::preUpdateComment';
-	const EVENT_UPDATE     = 'OCP\Comments\ICommentsManager::updateComment';
-	const EVENT_DELETE     = 'OCP\Comments\ICommentsManager::deleteComment';
+    const EVENT_ADD        = 'OCP\Comments\ICommentsManager::addComment';
+    const EVENT_PRE_UPDATE = 'OCP\Comments\ICommentsManager::preUpdateComment';
+    const EVENT_UPDATE     = 'OCP\Comments\ICommentsManager::updateComment';
+    const EVENT_DELETE     = 'OCP\Comments\ICommentsManager::deleteComment';
 
-	/** @var string */
-	protected $event;
-	/** @var IComment */
-	protected $comment;
+    /** @var string */
+    protected $event;
+    /** @var IComment */
+    protected $comment;
 
-	/**
-	 * DispatcherEvent constructor.
-	 *
-	 * @param string $event
-	 * @param IComment $comment
-	 * @since 9.0.0
-	 */
-	public function __construct($event, IComment $comment) {
-		$this->event = $event;
-		$this->comment = $comment;
-	}
+    /**
+     * DispatcherEvent constructor.
+     *
+     * @param string $event
+     * @param IComment $comment
+     * @since 9.0.0
+     */
+    public function __construct($event, IComment $comment) {
+        $this->event = $event;
+        $this->comment = $comment;
+    }
 
-	/**
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getEvent() {
-		return $this->event;
-	}
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getEvent() {
+        return $this->event;
+    }
 
-	/**
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function getComment() {
-		return $this->comment;
-	}
+    /**
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function getComment() {
+        return $this->comment;
+    }
 }