nextcloud / server

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;
+    }
 }

lib/public/Comments/ICommentsEventHandler.php

Indentation +5 added lines, -5 removed lines

@@ -31,9 +31,9 @@
  */
 interface ICommentsEventHandler {
 
-	/**
-	 * @param CommentsEvent $event
-	 * @since 11.0.0
-	 */
-	public function handle(CommentsEvent $event);
+    /**
+     * @param CommentsEvent $event
+     * @since 11.0.0
+     */
+    public function handle(CommentsEvent $event);
 }

lib/public/Comments/IComment.php

Indentation +203 added lines, -203 removed lines

@@ -31,233 +31,233 @@
  * @since 9.0.0
  */
 interface IComment {
-	const MAX_MESSAGE_LENGTH = 1000;
+    const MAX_MESSAGE_LENGTH = 1000;
 
-	/**
-	 * returns the ID of the comment
-	 *
-	 * It may return an empty string, if the comment was not stored.
-	 * It is expected that the concrete Comment implementation gives an ID
-	 * by itself (e.g. after saving).
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getId();
+    /**
+     * returns the ID of the comment
+     *
+     * It may return an empty string, if the comment was not stored.
+     * It is expected that the concrete Comment implementation gives an ID
+     * by itself (e.g. after saving).
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getId();
 
-	/**
-	 * sets the ID of the comment and returns itself
-	 *
-	 * It is only allowed to set the ID only, if the current id is an empty
-	 * string (which means it is not stored in a database, storage or whatever
-	 * the concrete implementation does), or vice versa. Changing a given ID is
-	 * not permitted and must result in an IllegalIDChangeException.
-	 *
-	 * @param string $id
-	 * @return IComment
-	 * @throws IllegalIDChangeException
-	 * @since 9.0.0
-	 */
-	public function setId($id);
+    /**
+     * sets the ID of the comment and returns itself
+     *
+     * It is only allowed to set the ID only, if the current id is an empty
+     * string (which means it is not stored in a database, storage or whatever
+     * the concrete implementation does), or vice versa. Changing a given ID is
+     * not permitted and must result in an IllegalIDChangeException.
+     *
+     * @param string $id
+     * @return IComment
+     * @throws IllegalIDChangeException
+     * @since 9.0.0
+     */
+    public function setId($id);
 
-	/**
-	 * returns the parent ID of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getParentId();
+    /**
+     * returns the parent ID of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getParentId();
 
-	/**
-	 * sets the parent ID and returns itself
-	 * @param string $parentId
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setParentId($parentId);
+    /**
+     * sets the parent ID and returns itself
+     * @param string $parentId
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setParentId($parentId);
 
-	/**
-	 * returns the topmost parent ID of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getTopmostParentId();
+    /**
+     * returns the topmost parent ID of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getTopmostParentId();
 
 
-	/**
-	 * sets the topmost parent ID and returns itself
-	 *
-	 * @param string $id
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setTopmostParentId($id);
+    /**
+     * sets the topmost parent ID and returns itself
+     *
+     * @param string $id
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setTopmostParentId($id);
 
-	/**
-	 * returns the number of children
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getChildrenCount();
+    /**
+     * returns the number of children
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getChildrenCount();
 
-	/**
-	 * sets the number of children
-	 *
-	 * @param int $count
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setChildrenCount($count);
+    /**
+     * sets the number of children
+     *
+     * @param int $count
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setChildrenCount($count);
 
-	/**
-	 * returns the message of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getMessage();
+    /**
+     * returns the message of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getMessage();
 
-	/**
-	 * sets the message of the comment and returns itself
-	 *
-	 * When the given message length exceeds MAX_MESSAGE_LENGTH an
-	 * MessageTooLongException shall be thrown.
-	 *
-	 * @param string $message
-	 * @return IComment
-	 * @throws MessageTooLongException
-	 * @since 9.0.0
-	 */
-	public function setMessage($message);
+    /**
+     * sets the message of the comment and returns itself
+     *
+     * When the given message length exceeds MAX_MESSAGE_LENGTH an
+     * MessageTooLongException shall be thrown.
+     *
+     * @param string $message
+     * @return IComment
+     * @throws MessageTooLongException
+     * @since 9.0.0
+     */
+    public function setMessage($message);
 
-	/**
-	 * returns an array containing mentions that are included in the comment
-	 *
-	 * @return array each mention provides a 'type' and an 'id', see example below
-	 * @since 11.0.0
-	 *
-	 * The return array looks like:
-	 * [
-	 *   [
-	 *     'type' => 'user',
-	 *     'id' => 'citizen4'
-	 *   ],
-	 *   [
-	 *     'type' => 'group',
-	 *     'id' => 'media'
-	 *   ],
-	 *   …
-	 * ]
-	 *
-	 */
-	public function getMentions();
+    /**
+     * returns an array containing mentions that are included in the comment
+     *
+     * @return array each mention provides a 'type' and an 'id', see example below
+     * @since 11.0.0
+     *
+     * The return array looks like:
+     * [
+     *   [
+     *     'type' => 'user',
+     *     'id' => 'citizen4'
+     *   ],
+     *   [
+     *     'type' => 'group',
+     *     'id' => 'media'
+     *   ],
+     *   …
+     * ]
+     *
+     */
+    public function getMentions();
 
-	/**
-	 * returns the verb of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getVerb();
+    /**
+     * returns the verb of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getVerb();
 
-	/**
-	 * sets the verb of the comment, e.g. 'comment' or 'like'
-	 *
-	 * @param string $verb
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setVerb($verb);
+    /**
+     * sets the verb of the comment, e.g. 'comment' or 'like'
+     *
+     * @param string $verb
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setVerb($verb);
 
-	/**
-	 * returns the actor type
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getActorType();
+    /**
+     * returns the actor type
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getActorType();
 
-	/**
-	 * returns the actor ID
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getActorId();
+    /**
+     * returns the actor ID
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getActorId();
 
-	/**
-	 * sets (overwrites) the actor type and id
-	 *
-	 * @param string $actorType e.g. 'users'
-	 * @param string $actorId e.g. 'zombie234'
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setActor($actorType, $actorId);
+    /**
+     * sets (overwrites) the actor type and id
+     *
+     * @param string $actorType e.g. 'users'
+     * @param string $actorId e.g. 'zombie234'
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setActor($actorType, $actorId);
 
-	/**
-	 * returns the creation date of the comment.
-	 *
-	 * If not explicitly set, it shall default to the time of initialization.
-	 *
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getCreationDateTime();
+    /**
+     * returns the creation date of the comment.
+     *
+     * If not explicitly set, it shall default to the time of initialization.
+     *
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getCreationDateTime();
 
-	/**
-	 * sets the creation date of the comment and returns itself
-	 *
-	 * @param \DateTime $dateTime
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setCreationDateTime(\DateTime $dateTime);
+    /**
+     * sets the creation date of the comment and returns itself
+     *
+     * @param \DateTime $dateTime
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setCreationDateTime(\DateTime $dateTime);
 
-	/**
-	 * returns the date of the most recent child
-	 *
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getLatestChildDateTime();
+    /**
+     * returns the date of the most recent child
+     *
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getLatestChildDateTime();
 
-	/**
-	 * sets the date of the most recent child
-	 *
-	 * @param \DateTime $dateTime
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setLatestChildDateTime(\DateTime $dateTime);
+    /**
+     * sets the date of the most recent child
+     *
+     * @param \DateTime $dateTime
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setLatestChildDateTime(\DateTime $dateTime);
 
-	/**
-	 * returns the object type the comment is attached to
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectType();
+    /**
+     * returns the object type the comment is attached to
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectType();
 
-	/**
-	 * returns the object id the comment is attached to
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectId();
+    /**
+     * returns the object id the comment is attached to
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectId();
 
-	/**
-	 * sets (overwrites) the object of the comment
-	 *
-	 * @param string $objectType e.g. 'files'
-	 * @param string $objectId e.g. '16435'
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setObject($objectType, $objectId);
+    /**
+     * sets (overwrites) the object of the comment
+     *
+     * @param string $objectType e.g. 'files'
+     * @param string $objectId e.g. '16435'
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setObject($objectType, $objectId);
 
 }
 

lib/public/Comments/CommentsEntityEvent.php

Indentation +37 added lines, -37 removed lines

@@ -32,46 +32,46 @@
  */
 class CommentsEntityEvent extends Event {
 
-	const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity';
+    const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity';
 
-	/** @var string */
-	protected $event;
-	/** @var \Closure[] */
-	protected $collections;
+    /** @var string */
+    protected $event;
+    /** @var \Closure[] */
+    protected $collections;
 
-	/**
-	 * DispatcherEvent constructor.
-	 *
-	 * @param string $event
-	 * @since 9.1.0
-	 */
-	public function __construct($event) {
-		$this->event = $event;
-		$this->collections = [];
-	}
+    /**
+     * DispatcherEvent constructor.
+     *
+     * @param string $event
+     * @since 9.1.0
+     */
+    public function __construct($event) {
+        $this->event = $event;
+        $this->collections = [];
+    }
 
-	/**
-	 * @param string $name
-	 * @param \Closure $entityExistsFunction The closure should take one
-	 *                 argument, which is the id of the entity, that comments
-	 *                 should be handled for. The return should then be bool,
-	 *                 depending on whether comments are allowed (true) or not.
-	 * @throws \OutOfBoundsException when the entity name is already taken
-	 * @since 9.1.0
-	 */
-	public function addEntityCollection($name, \Closure $entityExistsFunction) {
-		if (isset($this->collections[$name])) {
-			throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"');
-		}
+    /**
+     * @param string $name
+     * @param \Closure $entityExistsFunction The closure should take one
+     *                 argument, which is the id of the entity, that comments
+     *                 should be handled for. The return should then be bool,
+     *                 depending on whether comments are allowed (true) or not.
+     * @throws \OutOfBoundsException when the entity name is already taken
+     * @since 9.1.0
+     */
+    public function addEntityCollection($name, \Closure $entityExistsFunction) {
+        if (isset($this->collections[$name])) {
+            throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"');
+        }
 
-		$this->collections[$name] = $entityExistsFunction;
-	}
+        $this->collections[$name] = $entityExistsFunction;
+    }
 
-	/**
-	 * @return \Closure[]
-	 * @since 9.1.0
-	 */
-	public function getEntityCollections() {
-		return $this->collections;
-	}
+    /**
+     * @return \Closure[]
+     * @since 9.1.0
+     */
+    public function getEntityCollections() {
+        return $this->collections;
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
 	 */
 	public function addEntityCollection($name, \Closure $entityExistsFunction) {
 		if (isset($this->collections[$name])) {
-			throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"');
+			throw new \OutOfBoundsException('Duplicate entity name "'.$name.'"');
 		}
 
 		$this->collections[$name] = $entityExistsFunction;

lib/public/Comments/ICommentsManagerFactory.php

Indentation +14 added lines, -14 removed lines

@@ -36,19 +36,19 @@
  */
 interface ICommentsManagerFactory {
 
-	/**
-	 * Constructor for the comments manager factory
-	 *
-	 * @param IServerContainer $serverContainer server container
-	 * @since 9.0.0
-	 */
-	public function __construct(IServerContainer $serverContainer);
+    /**
+     * Constructor for the comments manager factory
+     *
+     * @param IServerContainer $serverContainer server container
+     * @since 9.0.0
+     */
+    public function __construct(IServerContainer $serverContainer);
 
-	/**
-	 * creates and returns an instance of the ICommentsManager
-	 *
-	 * @return ICommentsManager
-	 * @since 9.0.0
-	 */
-	public function getManager();
+    /**
+     * creates and returns an instance of the ICommentsManager
+     *
+     * @return ICommentsManager
+     * @since 9.0.0
+     */
+    public function getManager();
 }

lib/public/IAppConfig.php

Indentation +89 added lines, -89 removed lines

@@ -31,101 +31,101 @@
  * @since 7.0.0
  */
 interface IAppConfig {
-	/**
-	 * check if a key is set in the appconfig
-	 * @param string $app
-	 * @param string $key
-	 * @return bool
-	 * @since 7.0.0
-	 */
-	public function hasKey($app, $key);
+    /**
+     * check if a key is set in the appconfig
+     * @param string $app
+     * @param string $key
+     * @return bool
+     * @since 7.0.0
+     */
+    public function hasKey($app, $key);
 
-	/**
-	 * Gets the config value
-	 * @param string $app app
-	 * @param string $key key
-	 * @param string $default = null, default value if the key does not exist
-	 * @return string the value or $default
-	 * @deprecated 8.0.0 use method getAppValue of \OCP\IConfig
-	 *
-	 * This function gets a value from the appconfig table. If the key does
-	 * not exist the default value will be returned
-	 * @since 7.0.0
-	 */
-	public function getValue($app, $key, $default = null);
+    /**
+     * Gets the config value
+     * @param string $app app
+     * @param string $key key
+     * @param string $default = null, default value if the key does not exist
+     * @return string the value or $default
+     * @deprecated 8.0.0 use method getAppValue of \OCP\IConfig
+     *
+     * This function gets a value from the appconfig table. If the key does
+     * not exist the default value will be returned
+     * @since 7.0.0
+     */
+    public function getValue($app, $key, $default = null);
 
-	/**
-	 * Deletes a key
-	 * @param string $app app
-	 * @param string $key key
-	 * @return bool
-	 * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig
-	 * @since 7.0.0
-	 */
-	public function deleteKey($app, $key);
+    /**
+     * Deletes a key
+     * @param string $app app
+     * @param string $key key
+     * @return bool
+     * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig
+     * @since 7.0.0
+     */
+    public function deleteKey($app, $key);
 
-	/**
-	 * Get the available keys for an app
-	 * @param string $app the app we are looking for
-	 * @return array an array of key names
-	 * @deprecated 8.0.0 use method getAppKeys of \OCP\IConfig
-	 *
-	 * This function gets all keys of an app. Please note that the values are
-	 * not returned.
-	 * @since 7.0.0
-	 */
-	public function getKeys($app);
+    /**
+     * Get the available keys for an app
+     * @param string $app the app we are looking for
+     * @return array an array of key names
+     * @deprecated 8.0.0 use method getAppKeys of \OCP\IConfig
+     *
+     * This function gets all keys of an app. Please note that the values are
+     * not returned.
+     * @since 7.0.0
+     */
+    public function getKeys($app);
 
-	/**
-	 * get multiply values, either the app or key can be used as wildcard by setting it to false
-	 *
-	 * @param string|false $key
-	 * @param string|false $app
-	 * @return array|false
-	 * @since 7.0.0
-	 */
-	public function getValues($app, $key);
+    /**
+     * get multiply values, either the app or key can be used as wildcard by setting it to false
+     *
+     * @param string|false $key
+     * @param string|false $app
+     * @return array|false
+     * @since 7.0.0
+     */
+    public function getValues($app, $key);
 
-	/**
-	 * get all values of the app or and filters out sensitive data
-	 *
-	 * @param string $app
-	 * @return array
-	 * @since 12.0.0
-	 */
-	public function getFilteredValues($app);
+    /**
+     * get all values of the app or and filters out sensitive data
+     *
+     * @param string $app
+     * @return array
+     * @since 12.0.0
+     */
+    public function getFilteredValues($app);
 
-	/**
-	 * sets a value in the appconfig
-	 * @param string $app app
-	 * @param string $key key
-	 * @param string|float|int $value value
-	 * @deprecated 8.0.0 use method setAppValue of \OCP\IConfig
-	 *
-	 * Sets a value. If the key did not exist before it will be created.
-	 * @return void
-	 * @since 7.0.0
-	 */
-	public function setValue($app, $key, $value);
+    /**
+     * sets a value in the appconfig
+     * @param string $app app
+     * @param string $key key
+     * @param string|float|int $value value
+     * @deprecated 8.0.0 use method setAppValue of \OCP\IConfig
+     *
+     * Sets a value. If the key did not exist before it will be created.
+     * @return void
+     * @since 7.0.0
+     */
+    public function setValue($app, $key, $value);
 
-	/**
-	 * Get all apps using the config
-	 * @return array an array of app ids
-	 *
-	 * This function returns a list of all apps that have at least one
-	 * entry in the appconfig table.
-	 * @since 7.0.0
-	 */
-	public function getApps();
+    /**
+     * Get all apps using the config
+     * @return array an array of app ids
+     *
+     * This function returns a list of all apps that have at least one
+     * entry in the appconfig table.
+     * @since 7.0.0
+     */
+    public function getApps();
 
-	/**
-	 * Remove app from appconfig
-	 * @param string $app app
-	 * @return bool
-	 * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig
-	 *
-	 * Removes all keys in appconfig belonging to the app.
-	 * @since 7.0.0
-	 */
-	public function deleteApp($app);
+    /**
+     * Remove app from appconfig
+     * @param string $app app
+     * @return bool
+     * @deprecated 8.0.0 use method deleteAppValue of \OCP\IConfig
+     *
+     * Removes all keys in appconfig belonging to the app.
+     * @since 7.0.0
+     */
+    public function deleteApp($app);
 }