nextcloud / server

lib/public/Activity/IExtension.php

Indentation +117 added lines, -117 removed lines

@@ -39,132 +39,132 @@
  * @since 8.0.0
  */
 interface IExtension {
-	const METHOD_STREAM = 'stream';
-	const METHOD_MAIL = 'email';
+    const METHOD_STREAM = 'stream';
+    const METHOD_MAIL = 'email';
 
-	const PRIORITY_VERYLOW 	= 10;
-	const PRIORITY_LOW	= 20;
-	const PRIORITY_MEDIUM	= 30;
-	const PRIORITY_HIGH	= 40;
-	const PRIORITY_VERYHIGH	= 50;
+    const PRIORITY_VERYLOW 	= 10;
+    const PRIORITY_LOW	= 20;
+    const PRIORITY_MEDIUM	= 30;
+    const PRIORITY_HIGH	= 40;
+    const PRIORITY_VERYHIGH	= 50;
 
-	/**
-	 * The extension can return an array of additional notification types.
-	 * If no additional types are to be added false is to be returned
-	 *
-	 * @param string $languageCode
-	 * @return array|false Array "stringID of the type" => "translated string description for the setting"
-	 * 				or Array "stringID of the type" => [
-	 * 					'desc' => "translated string description for the setting"
-	 * 					'methods' => [self::METHOD_*],
-	 * 				]
-	 * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
-	 */
-	public function getNotificationTypes($languageCode);
+    /**
+     * The extension can return an array of additional notification types.
+     * If no additional types are to be added false is to be returned
+     *
+     * @param string $languageCode
+     * @return array|false Array "stringID of the type" => "translated string description for the setting"
+     * 				or Array "stringID of the type" => [
+     * 					'desc' => "translated string description for the setting"
+     * 					'methods' => [self::METHOD_*],
+     * 				]
+     * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
+     */
+    public function getNotificationTypes($languageCode);
 
-	/**
-	 * For a given method additional types to be displayed in the settings can be returned.
-	 * In case no additional types are to be added false is to be returned.
-	 *
-	 * @param string $method
-	 * @return array|false
-	 * @since 8.0.0
-	 */
-	public function getDefaultTypes($method);
+    /**
+     * For a given method additional types to be displayed in the settings can be returned.
+     * In case no additional types are to be added false is to be returned.
+     *
+     * @param string $method
+     * @return array|false
+     * @since 8.0.0
+     */
+    public function getDefaultTypes($method);
 
-	/**
-	 * A string naming the css class for the icon to be used can be returned.
-	 * If no icon is known for the given type false is to be returned.
-	 *
-	 * @param string $type
-	 * @return string|false
-	 * @since 8.0.0
-	 */
-	public function getTypeIcon($type);
+    /**
+     * A string naming the css class for the icon to be used can be returned.
+     * If no icon is known for the given type false is to be returned.
+     *
+     * @param string $type
+     * @return string|false
+     * @since 8.0.0
+     */
+    public function getTypeIcon($type);
 
-	/**
-	 * The extension can translate a given message to the requested languages.
-	 * If no translation is available false is to be returned.
-	 *
-	 * @param string $app
-	 * @param string $text
-	 * @param array $params
-	 * @param boolean $stripPath
-	 * @param boolean $highlightParams
-	 * @param string $languageCode
-	 * @return string|false
-	 * @since 8.0.0
-	 */
-	public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
+    /**
+     * The extension can translate a given message to the requested languages.
+     * If no translation is available false is to be returned.
+     *
+     * @param string $app
+     * @param string $text
+     * @param array $params
+     * @param boolean $stripPath
+     * @param boolean $highlightParams
+     * @param string $languageCode
+     * @return string|false
+     * @since 8.0.0
+     */
+    public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
 
-	/**
-	 * The extension can define the type of parameters for translation
-	 *
-	 * Currently known types are:
-	 * * file		=> will strip away the path of the file and add a tooltip with it
-	 * * username	=> will add the avatar of the user
-	 * * email 	    => will add a mailto link
-	 *
-	 * @param string $app
-	 * @param string $text
-	 * @return array|false
-	 * @since 8.0.0
-	 */
-	public function getSpecialParameterList($app, $text);
+    /**
+     * The extension can define the type of parameters for translation
+     *
+     * Currently known types are:
+     * * file		=> will strip away the path of the file and add a tooltip with it
+     * * username	=> will add the avatar of the user
+     * * email 	    => will add a mailto link
+     *
+     * @param string $app
+     * @param string $text
+     * @return array|false
+     * @since 8.0.0
+     */
+    public function getSpecialParameterList($app, $text);
 
-	/**
-	 * The extension can define the parameter grouping by returning the index as integer.
-	 * In case no grouping is required false is to be returned.
-	 *
-	 * @param array $activity
-	 * @return integer|false
-	 * @since 8.0.0
-	 */
-	public function getGroupParameter($activity);
+    /**
+     * The extension can define the parameter grouping by returning the index as integer.
+     * In case no grouping is required false is to be returned.
+     *
+     * @param array $activity
+     * @return integer|false
+     * @since 8.0.0
+     */
+    public function getGroupParameter($activity);
 
-	/**
-	 * The extension can define additional navigation entries. The array returned has to contain two keys 'top'
-	 * and 'apps' which hold arrays with the relevant entries.
-	 * If no further entries are to be added false is no be returned.
-	 *
-	 * @return array|false
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Register an IFilter instead
-	 */
-	public function getNavigation();
+    /**
+     * The extension can define additional navigation entries. The array returned has to contain two keys 'top'
+     * and 'apps' which hold arrays with the relevant entries.
+     * If no further entries are to be added false is no be returned.
+     *
+     * @return array|false
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Register an IFilter instead
+     */
+    public function getNavigation();
 
-	/**
-	 * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not.
-	 *
-	 * @param string $filterValue
-	 * @return boolean
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Register an IFilter instead
-	 */
-	public function isFilterValid($filterValue);
+    /**
+     * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not.
+     *
+     * @param string $filterValue
+     * @return boolean
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Register an IFilter instead
+     */
+    public function isFilterValid($filterValue);
 
-	/**
-	 * The extension can filter the types based on the filter if required.
-	 * In case no filter is to be applied false is to be returned unchanged.
-	 *
-	 * @param array $types
-	 * @param string $filter
-	 * @return array|false
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Register an IFilter instead
-	 */
-	public function filterNotificationTypes($types, $filter);
+    /**
+     * The extension can filter the types based on the filter if required.
+     * In case no filter is to be applied false is to be returned unchanged.
+     *
+     * @param array $types
+     * @param string $filter
+     * @return array|false
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Register an IFilter instead
+     */
+    public function filterNotificationTypes($types, $filter);
 
-	/**
-	 * For a given filter the extension can specify the sql query conditions including parameters for that query.
-	 * In case the extension does not know the filter false is to be returned.
-	 * The query condition and the parameters are to be returned as array with two elements.
-	 * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%'));
-	 *
-	 * @param string $filter
-	 * @return array|false
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Register an IFilter instead
-	 */
-	public function getQueryForFilter($filter);
+    /**
+     * For a given filter the extension can specify the sql query conditions including parameters for that query.
+     * In case the extension does not know the filter false is to be returned.
+     * The query condition and the parameters are to be returned as array with two elements.
+     * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%'));
+     *
+     * @param string $filter
+     * @return array|false
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Register an IFilter instead
+     */
+    public function getQueryForFilter($filter);
 }

Spacing +5 added lines, -5 removed lines

@@ -42,11 +42,11 @@
 	const METHOD_STREAM = 'stream';
 	const METHOD_MAIL = 'email';
 
-	const PRIORITY_VERYLOW 	= 10;
-	const PRIORITY_LOW	= 20;
-	const PRIORITY_MEDIUM	= 30;
-	const PRIORITY_HIGH	= 40;
-	const PRIORITY_VERYHIGH	= 50;
+	const PRIORITY_VERYLOW = 10;
+	const PRIORITY_LOW = 20;
+	const PRIORITY_MEDIUM = 30;
+	const PRIORITY_HIGH = 40;
+	const PRIORITY_VERYHIGH = 50;
 
 	/**
 	 * The extension can return an array of additional notification types.

lib/public/Activity/IFilter.php

Indentation +33 added lines, -33 removed lines

@@ -29,43 +29,43 @@
  */
 interface IFilter {
 
-	/**
-	 * @return string Lowercase a-z and underscore only identifier
-	 * @since 11.0.0
-	 */
-	public function getIdentifier();
+    /**
+     * @return string Lowercase a-z and underscore only identifier
+     * @since 11.0.0
+     */
+    public function getIdentifier();
 
-	/**
-	 * @return string A translated string
-	 * @since 11.0.0
-	 */
-	public function getName();
+    /**
+     * @return string A translated string
+     * @since 11.0.0
+     */
+    public function getName();
 
-	/**
-	 * @return int whether the filter should be rather on the top or bottom of
-	 * the admin section. The filters are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 * @since 11.0.0
-	 */
-	public function getPriority();
+    /**
+     * @return int whether the filter should be rather on the top or bottom of
+     * the admin section. The filters are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     * @since 11.0.0
+     */
+    public function getPriority();
 
-	/**
-	 * @return string Full URL to an icon, empty string when none is given
-	 * @since 11.0.0
-	 */
-	public function getIcon();
+    /**
+     * @return string Full URL to an icon, empty string when none is given
+     * @since 11.0.0
+     */
+    public function getIcon();
 
-	/**
-	 * @param string[] $types
-	 * @return string[] An array of allowed apps from which activities should be displayed
-	 * @since 11.0.0
-	 */
-	public function filterTypes(array $types);
+    /**
+     * @param string[] $types
+     * @return string[] An array of allowed apps from which activities should be displayed
+     * @since 11.0.0
+     */
+    public function filterTypes(array $types);
 
-	/**
-	 * @return string[] An array of allowed apps from which activities should be displayed
-	 * @since 11.0.0
-	 */
-	public function allowedApps();
+    /**
+     * @return string[] An array of allowed apps from which activities should be displayed
+     * @since 11.0.0
+     */
+    public function allowedApps();
 }
 

lib/public/Activity/IEventMerger.php

Indentation +30 added lines, -30 removed lines

@@ -30,35 +30,35 @@
  */
 interface IEventMerger {
 
-	/**
-	 * Combines two events when possible to have grouping:
-	 *
-	 * Example1: Two events with subject '{user} created {file}' and
-	 * $mergeParameter file with different file and same user will be merged
-	 * to '{user} created {file1} and {file2}' and the childEvent on the return
-	 * will be set, if the events have been merged.
-	 *
-	 * Example2: Two events with subject '{user} created {file}' and
-	 * $mergeParameter file with same file and same user will be merged to
-	 * '{user} created {file1}' and the childEvent on the return will be set, if
-	 * the events have been merged.
-	 *
-	 * The following requirements have to be met, in order to be merged:
-	 * - Both events need to have the same `getApp()`
-	 * - Both events must not have a message `getMessage()`
-	 * - Both events need to have the same subject `getSubject()`
-	 * - Both events need to have the same object type `getObjectType()`
-	 * - The time difference between both events must not be bigger then 3 hours
-	 * - Only up to 5 events can be merged.
-	 * - All parameters apart from such starting with $mergeParameter must be
-	 *   the same for both events.
-	 *
-	 * @param string $mergeParameter
-	 * @param IEvent $event
-	 * @param IEvent|null $previousEvent
-	 * @return IEvent
-	 * @since 11.0
-	 */
-	public function mergeEvents($mergeParameter, IEvent $event, IEvent $previousEvent = null);
+    /**
+     * Combines two events when possible to have grouping:
+     *
+     * Example1: Two events with subject '{user} created {file}' and
+     * $mergeParameter file with different file and same user will be merged
+     * to '{user} created {file1} and {file2}' and the childEvent on the return
+     * will be set, if the events have been merged.
+     *
+     * Example2: Two events with subject '{user} created {file}' and
+     * $mergeParameter file with same file and same user will be merged to
+     * '{user} created {file1}' and the childEvent on the return will be set, if
+     * the events have been merged.
+     *
+     * The following requirements have to be met, in order to be merged:
+     * - Both events need to have the same `getApp()`
+     * - Both events must not have a message `getMessage()`
+     * - Both events need to have the same subject `getSubject()`
+     * - Both events need to have the same object type `getObjectType()`
+     * - The time difference between both events must not be bigger then 3 hours
+     * - Only up to 5 events can be merged.
+     * - All parameters apart from such starting with $mergeParameter must be
+     *   the same for both events.
+     *
+     * @param string $mergeParameter
+     * @param IEvent $event
+     * @param IEvent|null $previousEvent
+     * @return IEvent
+     * @since 11.0
+     */
+    public function mergeEvents($mergeParameter, IEvent $event, IEvent $previousEvent = null);
 
 }

lib/public/Activity/ISetting.php

Indentation +37 added lines, -37 removed lines

@@ -29,48 +29,48 @@
  */
 interface ISetting {
 
-	/**
-	 * @return string Lowercase a-z and underscore only identifier
-	 * @since 11.0.0
-	 */
-	public function getIdentifier();
+    /**
+     * @return string Lowercase a-z and underscore only identifier
+     * @since 11.0.0
+     */
+    public function getIdentifier();
 
-	/**
-	 * @return string A translated string
-	 * @since 11.0.0
-	 */
-	public function getName();
+    /**
+     * @return string A translated string
+     * @since 11.0.0
+     */
+    public function getName();
 
-	/**
-	 * @return int whether the filter should be rather on the top or bottom of
-	 * the admin section. The filters are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 * @since 11.0.0
-	 */
-	public function getPriority();
+    /**
+     * @return int whether the filter should be rather on the top or bottom of
+     * the admin section. The filters are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     * @since 11.0.0
+     */
+    public function getPriority();
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function canChangeStream();
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function canChangeStream();
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function isDefaultEnabledStream();
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function isDefaultEnabledStream();
 
-	/**
-	 * @return bool True when the option can be changed for the mail
-	 * @since 11.0.0
-	 */
-	public function canChangeMail();
+    /**
+     * @return bool True when the option can be changed for the mail
+     * @since 11.0.0
+     */
+    public function canChangeMail();
 
-	/**
-	 * @return bool True when the option can be changed for the stream
-	 * @since 11.0.0
-	 */
-	public function isDefaultEnabledMail();
+    /**
+     * @return bool True when the option can be changed for the stream
+     * @since 11.0.0
+     */
+    public function isDefaultEnabledMail();
 }
 

lib/public/Activity/IProvider.php

Indentation +11 added lines, -11 removed lines

@@ -28,15 +28,15 @@
  * @since 11.0.0
  */
 interface IProvider {
-	/**
-	 * @param string $language The language which should be used for translating, e.g. "en"
-	 * @param IEvent $event The current event which should be parsed
-	 * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one.
-	 *                                   To do so, simply use setChildEvent($previousEvent) after setting the
-	 *                                   combined subject on the current event.
-	 * @return IEvent
-	 * @throws \InvalidArgumentException Should be thrown if your provider does not know this event
-	 * @since 11.0.0
-	 */
-	public function parse($language, IEvent $event, IEvent $previousEvent = null);
+    /**
+     * @param string $language The language which should be used for translating, e.g. "en"
+     * @param IEvent $event The current event which should be parsed
+     * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one.
+     *                                   To do so, simply use setChildEvent($previousEvent) after setting the
+     *                                   combined subject on the current event.
+     * @return IEvent
+     * @throws \InvalidArgumentException Should be thrown if your provider does not know this event
+     * @since 11.0.0
+     */
+    public function parse($language, IEvent $event, IEvent $previousEvent = null);
 }

lib/public/Activity/IConsumer.php

Indentation +7 added lines, -7 removed lines

@@ -38,12 +38,12 @@
  * @since 6.0.0
  */
 interface IConsumer {
-	/**
-	 * @param IEvent $event
-	 * @return null
-	 * @since 6.0.0
-	 * @since 8.2.0 Replaced the parameters with an IEvent object
-	 */
-	public function receive(IEvent $event);
+    /**
+     * @param IEvent $event
+     * @return null
+     * @since 6.0.0
+     * @since 8.2.0 Replaced the parameters with an IEvent object
+     */
+    public function receive(IEvent $event);
 }
 

lib/public/IMemcacheTTL.php

Indentation +8 added lines, -8 removed lines

@@ -29,12 +29,12 @@
  * @since 8.2.2
  */
 interface IMemcacheTTL extends IMemcache {
-	/**
-	 * Set the ttl for an existing value
-	 *
-	 * @param string $key
-	 * @param int $ttl time to live in seconds
-	 * @since 8.2.2
-	 */
-	public function setTTL($key, $ttl);
+    /**
+     * Set the ttl for an existing value
+     *
+     * @param string $key
+     * @param int $ttl time to live in seconds
+     * @since 8.2.2
+     */
+    public function setTTL($key, $ttl);
 }

lib/public/IUserSession.php

Indentation +36 added lines, -36 removed lines

@@ -40,44 +40,44 @@
  * @since 6.0.0
  */
 interface IUserSession {
-	/**
-	 * Do a user login
-	 * @param string $user the username
-	 * @param string $password the password
-	 * @return bool true if successful
-	 * @since 6.0.0
-	 */
-	public function login($user, $password);
+    /**
+     * Do a user login
+     * @param string $user the username
+     * @param string $password the password
+     * @return bool true if successful
+     * @since 6.0.0
+     */
+    public function login($user, $password);
 
-	/**
-	 * Logs the user out including all the session data
-	 * Logout, destroys session
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function logout();
+    /**
+     * Logs the user out including all the session data
+     * Logout, destroys session
+     * @return void
+     * @since 6.0.0
+     */
+    public function logout();
 
-	/**
-	 * set the currently active user
-	 *
-	 * @param \OCP\IUser|null $user
-	 * @since 8.0.0
-	 */
-	public function setUser($user);
+    /**
+     * set the currently active user
+     *
+     * @param \OCP\IUser|null $user
+     * @since 8.0.0
+     */
+    public function setUser($user);
 
-	/**
-	 * get the current active user
-	 *
-	 * @return \OCP\IUser|null Current user, otherwise null
-	 * @since 8.0.0
-	 */
-	public function getUser();
+    /**
+     * get the current active user
+     *
+     * @return \OCP\IUser|null Current user, otherwise null
+     * @since 8.0.0
+     */
+    public function getUser();
 
-	/**
-	 * Checks whether the user is logged in
-	 *
-	 * @return bool if logged in
-	 * @since 8.0.0
-	 */
-	public function isLoggedIn();
+    /**
+     * Checks whether the user is logged in
+     *
+     * @return bool if logged in
+     * @since 8.0.0
+     */
+    public function isLoggedIn();
 }

lib/public/IDateTimeZone.php

Indentation +6 added lines, -6 removed lines

@@ -30,10 +30,10 @@
  * @since 8.0.0
  */
 interface IDateTimeZone {
-	/**
-	 * @param bool|int $timestamp
-	 * @return \DateTimeZone
-	 * @since 8.0.0 - parameter $timestamp was added in 8.1.0
-	 */
-	public function getTimeZone($timestamp = false);
+    /**
+     * @param bool|int $timestamp
+     * @return \DateTimeZone
+     * @since 8.0.0 - parameter $timestamp was added in 8.1.0
+     */
+    public function getTimeZone($timestamp = false);
 }