nextcloud / server

lib/public/Activity/IManager.php

Indentation +219 added lines, -219 removed lines

@@ -39,250 +39,250 @@
  * @since 6.0.0
  */
 interface IManager {
-	/**
-	 * Generates a new IEvent object
-	 *
-	 * Make sure to call at least the following methods before sending it to the
-	 * app with via the publish() method:
-	 *  - setApp()
-	 *  - setType()
-	 *  - setAffectedUser()
-	 *  - setSubject()
-	 *
-	 * @return IEvent
-	 * @since 8.2.0
-	 */
-	public function generateEvent();
+    /**
+     * Generates a new IEvent object
+     *
+     * Make sure to call at least the following methods before sending it to the
+     * app with via the publish() method:
+     *  - setApp()
+     *  - setType()
+     *  - setAffectedUser()
+     *  - setSubject()
+     *
+     * @return IEvent
+     * @since 8.2.0
+     */
+    public function generateEvent();
 
-	/**
-	 * Publish an event to the activity consumers
-	 *
-	 * Make sure to call at least the following methods before sending an Event:
-	 *  - setApp()
-	 *  - setType()
-	 *  - setAffectedUser()
-	 *  - setSubject()
-	 *
-	 * @param IEvent $event
-	 * @throws \BadMethodCallException if required values have not been set
-	 * @since 8.2.0
-	 */
-	public function publish(IEvent $event);
+    /**
+     * Publish an event to the activity consumers
+     *
+     * Make sure to call at least the following methods before sending an Event:
+     *  - setApp()
+     *  - setType()
+     *  - setAffectedUser()
+     *  - setSubject()
+     *
+     * @param IEvent $event
+     * @throws \BadMethodCallException if required values have not been set
+     * @since 8.2.0
+     */
+    public function publish(IEvent $event);
 
-	/**
-	 * @param string $app           The app where this event is associated with
-	 * @param string $subject       A short description of the event
-	 * @param array  $subjectParams Array with parameters that are filled in the subject
-	 * @param string $message       A longer description of the event
-	 * @param array  $messageParams Array with parameters that are filled in the message
-	 * @param string $file          The file including path where this event is associated with
-	 * @param string $link          A link where this event is associated with
-	 * @param string $affectedUser  Recipient of the activity
-	 * @param string $type          Type of the notification
-	 * @param int    $priority      Priority of the notification
-	 * @since 6.0.0
-	 * @deprecated 8.2.0 Grab an IEvent from generateEvent() instead and use the publish() method
-	 */
-	public function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority);
+    /**
+     * @param string $app           The app where this event is associated with
+     * @param string $subject       A short description of the event
+     * @param array  $subjectParams Array with parameters that are filled in the subject
+     * @param string $message       A longer description of the event
+     * @param array  $messageParams Array with parameters that are filled in the message
+     * @param string $file          The file including path where this event is associated with
+     * @param string $link          A link where this event is associated with
+     * @param string $affectedUser  Recipient of the activity
+     * @param string $type          Type of the notification
+     * @param int    $priority      Priority of the notification
+     * @since 6.0.0
+     * @deprecated 8.2.0 Grab an IEvent from generateEvent() instead and use the publish() method
+     */
+    public function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority);
 
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be called in case
-	 * activity consumers are actually requested
-	 *
-	 * $callable has to return an instance of \OCP\Activity\IConsumer
-	 *
-	 * @param \Closure $callable
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function registerConsumer(\Closure $callable);
+    /**
+     * In order to improve lazy loading a closure can be registered which will be called in case
+     * activity consumers are actually requested
+     *
+     * $callable has to return an instance of \OCP\Activity\IConsumer
+     *
+     * @param \Closure $callable
+     * @return void
+     * @since 6.0.0
+     */
+    public function registerConsumer(\Closure $callable);
 
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be called in case
-	 * activity consumers are actually requested
-	 *
-	 * $callable has to return an instance of \OCP\Activity\IExtension
-	 *
-	 * @param \Closure $callable
-	 * @return void
-	 * @since 8.0.0
-	 */
-	public function registerExtension(\Closure $callable);
+    /**
+     * In order to improve lazy loading a closure can be registered which will be called in case
+     * activity consumers are actually requested
+     *
+     * $callable has to return an instance of \OCP\Activity\IExtension
+     *
+     * @param \Closure $callable
+     * @return void
+     * @since 8.0.0
+     */
+    public function registerExtension(\Closure $callable);
 
-	/**
-	 * @param string $filter Class must implement OCA\Activity\IFilter
-	 * @return void
-	 * @since 11.0.0
-	 */
-	public function registerFilter($filter);
+    /**
+     * @param string $filter Class must implement OCA\Activity\IFilter
+     * @return void
+     * @since 11.0.0
+     */
+    public function registerFilter($filter);
 
-	/**
-	 * @return IFilter[]
-	 * @since 11.0.0
-	 */
-	public function getFilters();
+    /**
+     * @return IFilter[]
+     * @since 11.0.0
+     */
+    public function getFilters();
 
-	/**
-	 * @param string $id
-	 * @return IFilter
-	 * @throws \InvalidArgumentException when the filter was not found
-	 * @since 11.0.0
-	 */
-	public function getFilterById($id);
+    /**
+     * @param string $id
+     * @return IFilter
+     * @throws \InvalidArgumentException when the filter was not found
+     * @since 11.0.0
+     */
+    public function getFilterById($id);
 
-	/**
-	 * @param string $setting Class must implement OCA\Activity\ISetting
-	 * @return void
-	 * @since 11.0.0
-	 */
-	public function registerSetting($setting);
+    /**
+     * @param string $setting Class must implement OCA\Activity\ISetting
+     * @return void
+     * @since 11.0.0
+     */
+    public function registerSetting($setting);
 
-	/**
-	 * @return ISetting[]
-	 * @since 11.0.0
-	 */
-	public function getSettings();
+    /**
+     * @return ISetting[]
+     * @since 11.0.0
+     */
+    public function getSettings();
 
-	/**
-	 * @param string $provider Class must implement OCA\Activity\IProvider
-	 * @return void
-	 * @since 11.0.0
-	 */
-	public function registerProvider($provider);
+    /**
+     * @param string $provider Class must implement OCA\Activity\IProvider
+     * @return void
+     * @since 11.0.0
+     */
+    public function registerProvider($provider);
 
-	/**
-	 * @return IProvider[]
-	 * @since 11.0.0
-	 */
-	public function getProviders();
+    /**
+     * @return IProvider[]
+     * @since 11.0.0
+     */
+    public function getProviders();
 
-	/**
-	 * @param string $id
-	 * @return ISetting
-	 * @throws \InvalidArgumentException when the setting was not found
-	 * @since 11.0.0
-	 */
-	public function getSettingById($id);
+    /**
+     * @param string $id
+     * @return ISetting
+     * @throws \InvalidArgumentException when the setting was not found
+     * @since 11.0.0
+     */
+    public function getSettingById($id);
 
-	/**
-	 * Will return additional notification types as specified by other apps
-	 *
-	 * @param string $languageCode
-	 * @return array 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' => [\OCP\Activity\IExtension::METHOD_*],
-	 * 				]
-	 * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
-	 * @deprecated 11.0.0 - Use getSettings() instead
-	 */
-	public function getNotificationTypes($languageCode);
+    /**
+     * Will return additional notification types as specified by other apps
+     *
+     * @param string $languageCode
+     * @return array 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' => [\OCP\Activity\IExtension::METHOD_*],
+     * 				]
+     * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
+     * @deprecated 11.0.0 - Use getSettings() instead
+     */
+    public function getNotificationTypes($languageCode);
 
-	/**
-	 * @param string $method
-	 * @return array
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead
-	 */
-	public function getDefaultTypes($method);
+    /**
+     * @param string $method
+     * @return array
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead
+     */
+    public function getDefaultTypes($method);
 
-	/**
-	 * @param string $type
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getTypeIcon($type);
+    /**
+     * @param string $type
+     * @return string
+     * @since 8.0.0
+     */
+    public function getTypeIcon($type);
 
-	/**
-	 * @param string $type
-	 * @param int $id
-	 * @since 8.2.0
-	 */
-	public function setFormattingObject($type, $id);
+    /**
+     * @param string $type
+     * @param int $id
+     * @since 8.2.0
+     */
+    public function setFormattingObject($type, $id);
 
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function isFormattingFilteredObject();
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function isFormattingFilteredObject();
 
-	/**
-	 * @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);
+    /**
+     * @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);
 
-	/**
-	 * @param string $app
-	 * @param string $text
-	 * @return array|false
-	 * @since 8.0.0
-	 */
-	public function getSpecialParameterList($app, $text);
+    /**
+     * @param string $app
+     * @param string $text
+     * @return array|false
+     * @since 8.0.0
+     */
+    public function getSpecialParameterList($app, $text);
 
-	/**
-	 * @param array $activity
-	 * @return integer|false
-	 * @since 8.0.0
-	 */
-	public function getGroupParameter($activity);
+    /**
+     * @param array $activity
+     * @return integer|false
+     * @since 8.0.0
+     */
+    public function getGroupParameter($activity);
 
 
-	/**
-	 * Set the user we need to use
-	 *
-	 * @param string|null $currentUserId
-	 * @throws \UnexpectedValueException If the user is invalid
-	 * @since 9.0.1
-	 */
-	public function setCurrentUserId($currentUserId);
+    /**
+     * Set the user we need to use
+     *
+     * @param string|null $currentUserId
+     * @throws \UnexpectedValueException If the user is invalid
+     * @since 9.0.1
+     */
+    public function setCurrentUserId($currentUserId);
 
-	/**
-	 * Get the user we need to use
-	 *
-	 * Either the user is logged in, or we try to get it from the token
-	 *
-	 * @return string
-	 * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
-	 * @since 8.1.0
-	 */
-	public function getCurrentUserId();
+    /**
+     * Get the user we need to use
+     *
+     * Either the user is logged in, or we try to get it from the token
+     *
+     * @return string
+     * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
+     * @since 8.1.0
+     */
+    public function getCurrentUserId();
 
-	/**
-	 * @return array
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Use getFilters() instead
-	 */
-	public function getNavigation();
+    /**
+     * @return array
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Use getFilters() instead
+     */
+    public function getNavigation();
 
-	/**
-	 * @param string $filterValue
-	 * @return boolean
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Use getFilterById() instead
-	 */
-	public function isFilterValid($filterValue);
+    /**
+     * @param string $filterValue
+     * @return boolean
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Use getFilterById() instead
+     */
+    public function isFilterValid($filterValue);
 
-	/**
-	 * @param array $types
-	 * @param string $filter
-	 * @return array
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead
-	 */
-	public function filterNotificationTypes($types, $filter);
+    /**
+     * @param array $types
+     * @param string $filter
+     * @return array
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead
+     */
+    public function filterNotificationTypes($types, $filter);
 
-	/**
-	 * @param string $filter
-	 * @return array
-	 * @since 8.0.0
-	 * @deprecated 11.0.0 - Use getFilterById() instead
-	 */
-	public function getQueryForFilter($filter);
+    /**
+     * @param string $filter
+     * @return array
+     * @since 8.0.0
+     * @deprecated 11.0.0 - Use getFilterById() instead
+     */
+    public function getQueryForFilter($filter);
 }

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

lib/public/Security/StringUtils.php

Indentation +14 added lines, -14 removed lines

@@ -31,18 +31,18 @@
  * @since 8.0.0
  */
 class StringUtils {
-	/**
-	 * Compares whether two strings are equal. To prevent guessing of the string
-	 * length this is done by comparing two hashes against each other and afterwards
-	 * a comparison of the real string to prevent against the unlikely chance of
-	 * collisions.
-	 * @param string $expected The expected value
-	 * @param string $input The input to compare against
-	 * @return bool True if the two strings are equal, otherwise false.
-	 * @since 8.0.0
-	 * @deprecated 9.0.0 Use hash_equals
-	 */
-	public static function equals($expected, $input) {
-		return hash_equals($expected, $input);
-	}
+    /**
+     * Compares whether two strings are equal. To prevent guessing of the string
+     * length this is done by comparing two hashes against each other and afterwards
+     * a comparison of the real string to prevent against the unlikely chance of
+     * collisions.
+     * @param string $expected The expected value
+     * @param string $input The input to compare against
+     * @return bool True if the two strings are equal, otherwise false.
+     * @since 8.0.0
+     * @deprecated 9.0.0 Use hash_equals
+     */
+    public static function equals($expected, $input) {
+        return hash_equals($expected, $input);
+    }
 }

lib/public/Security/ICredentialsManager.php

Indentation +35 added lines, -35 removed lines

@@ -30,43 +30,43 @@
  */
 interface ICredentialsManager {
 
-	/**
-	 * Store a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @param mixed $credentials
-	 * @since 8.2.0
-	 */
-	public function store($userId, $identifier, $credentials);
+    /**
+     * Store a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @param mixed $credentials
+     * @since 8.2.0
+     */
+    public function store($userId, $identifier, $credentials);
 
-	/**
-	 * Retrieve a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @return mixed
-	 * @since 8.2.0
-	 */
-	public function retrieve($userId, $identifier);
+    /**
+     * Retrieve a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @return mixed
+     * @since 8.2.0
+     */
+    public function retrieve($userId, $identifier);
 
-	/**
-	 * Delete a set of credentials
-	 *
-	 * @param string|null $userId Null for system-wide credentials
-	 * @param string $identifier
-	 * @return int rows removed
-	 * @since 8.2.0
-	 */
-	public function delete($userId, $identifier);
+    /**
+     * Delete a set of credentials
+     *
+     * @param string|null $userId Null for system-wide credentials
+     * @param string $identifier
+     * @return int rows removed
+     * @since 8.2.0
+     */
+    public function delete($userId, $identifier);
 
-	/**
-	 * Erase all credentials stored for a user
-	 *
-	 * @param string $userId
-	 * @return int rows removed
-	 * @since 8.2.0
-	 */
-	public function erase($userId);
+    /**
+     * Erase all credentials stored for a user
+     *
+     * @param string $userId
+     * @return int rows removed
+     * @since 8.2.0
+     */
+    public function erase($userId);
 
 }