nextcloud / server

lib/public/Activity/IEvent.php

Indentation +279 added lines, -279 removed lines

@@ -37,283 +37,283 @@
  * @since 8.2.0
  */
 interface IEvent {
-	/**
-	 * Set the app of the activity
-	 *
-	 * @param string $app
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the app id is invalid
-	 * @since 8.2.0
-	 */
-	public function setApp($app);
-
-	/**
-	 * Set the type of the activity
-	 *
-	 * @param string $type
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the type is invalid
-	 * @since 8.2.0
-	 */
-	public function setType($type);
-
-	/**
-	 * Set the affected user of the activity
-	 *
-	 * @param string $user
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the affected user is invalid
-	 * @since 8.2.0
-	 */
-	public function setAffectedUser($user);
-
-	/**
-	 * Set the author of the activity
-	 *
-	 * @param string $author
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the author is invalid
-	 * @since 8.2.0
-	 */
-	public function setAuthor($author);
-
-	/**
-	 * Set the author of the activity
-	 *
-	 * @param int $timestamp
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the timestamp is invalid
-	 * @since 8.2.0
-	 */
-	public function setTimestamp($timestamp);
-
-	/**
-	 * Set the subject of the activity
-	 *
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setSubject($subject, array $parameters = []);
-
-	/**
-	 * @param string $subject
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject is invalid
-	 * @since 11.0.0
-	 */
-	public function setParsedSubject($subject);
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getParsedSubject();
-
-	/**
-	 * @param string $subject
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichSubject($subject, array $parameters = []);
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichSubject();
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichSubjectParameters();
-
-	/**
-	 * Set the message of the activity
-	 *
-	 * @param string $message
-	 * @param array $parameters
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 8.2.0
-	 */
-	public function setMessage($message, array $parameters = []);
-
-	/**
-	 * @param string $message
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message is invalid
-	 * @since 11.0.0
-	 */
-	public function setParsedMessage($message);
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getParsedMessage();
-
-	/**
-	 * @param string $message
-	 * @param array $parameters
-	 * @return $this
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
-	 * @since 11.0.0
-	 */
-	public function setRichMessage($message, array $parameters = []);
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getRichMessage();
-
-	/**
-	 * @return array[]
-	 * @since 11.0.0
-	 */
-	public function getRichMessageParameters();
-
-	/**
-	 * Set the object of the activity
-	 *
-	 * @param string $objectType
-	 * @param int $objectId
-	 * @param string $objectName
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the object is invalid
-	 * @since 8.2.0
-	 */
-	public function setObject($objectType, $objectId, $objectName = '');
-
-	/**
-	 * Set the link of the activity
-	 *
-	 * @param string $link
-	 * @return IEvent
-	 * @throws \InvalidArgumentException if the link is invalid
-	 * @since 8.2.0
-	 */
-	public function setLink($link);
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getApp();
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getType();
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getAffectedUser();
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getAuthor();
-
-	/**
-	 * @return int
-	 * @since 8.2.0
-	 */
-	public function getTimestamp();
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getSubject();
-
-	/**
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getSubjectParameters();
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getMessage();
-
-	/**
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getMessageParameters();
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getObjectType();
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getObjectId();
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getObjectName();
-
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getLink();
-
-	/**
-	 * @param string $icon
-	 * @return $this
-	 * @throws \InvalidArgumentException if the icon is invalid
-	 * @since 11.0.0
-	 */
-	public function setIcon($icon);
-
-	/**
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getIcon();
-
-	/**
-	 * @param IEvent $child
-	 * @since 11.0.0
-	 */
-	public function setChildEvent(IEvent $child);
-
-	/**
-	 * @return IEvent|null
-	 * @since 11.0.0
-	 */
-	public function getChildEvent();
-
-	/**
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function isValid();
-
-	/**
-	 * @return bool
-	 * @since 11.0.0
-	 */
-	public function isValidParsed();
+    /**
+     * Set the app of the activity
+     *
+     * @param string $app
+     * @return IEvent
+     * @throws \InvalidArgumentException if the app id is invalid
+     * @since 8.2.0
+     */
+    public function setApp($app);
+
+    /**
+     * Set the type of the activity
+     *
+     * @param string $type
+     * @return IEvent
+     * @throws \InvalidArgumentException if the type is invalid
+     * @since 8.2.0
+     */
+    public function setType($type);
+
+    /**
+     * Set the affected user of the activity
+     *
+     * @param string $user
+     * @return IEvent
+     * @throws \InvalidArgumentException if the affected user is invalid
+     * @since 8.2.0
+     */
+    public function setAffectedUser($user);
+
+    /**
+     * Set the author of the activity
+     *
+     * @param string $author
+     * @return IEvent
+     * @throws \InvalidArgumentException if the author is invalid
+     * @since 8.2.0
+     */
+    public function setAuthor($author);
+
+    /**
+     * Set the author of the activity
+     *
+     * @param int $timestamp
+     * @return IEvent
+     * @throws \InvalidArgumentException if the timestamp is invalid
+     * @since 8.2.0
+     */
+    public function setTimestamp($timestamp);
+
+    /**
+     * Set the subject of the activity
+     *
+     * @param string $subject
+     * @param array $parameters
+     * @return IEvent
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setSubject($subject, array $parameters = []);
+
+    /**
+     * @param string $subject
+     * @return $this
+     * @throws \InvalidArgumentException if the subject is invalid
+     * @since 11.0.0
+     */
+    public function setParsedSubject($subject);
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getParsedSubject();
+
+    /**
+     * @param string $subject
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichSubject($subject, array $parameters = []);
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichSubject();
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichSubjectParameters();
+
+    /**
+     * Set the message of the activity
+     *
+     * @param string $message
+     * @param array $parameters
+     * @return IEvent
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 8.2.0
+     */
+    public function setMessage($message, array $parameters = []);
+
+    /**
+     * @param string $message
+     * @return $this
+     * @throws \InvalidArgumentException if the message is invalid
+     * @since 11.0.0
+     */
+    public function setParsedMessage($message);
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getParsedMessage();
+
+    /**
+     * @param string $message
+     * @param array $parameters
+     * @return $this
+     * @throws \InvalidArgumentException if the message or parameters are invalid
+     * @since 11.0.0
+     */
+    public function setRichMessage($message, array $parameters = []);
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getRichMessage();
+
+    /**
+     * @return array[]
+     * @since 11.0.0
+     */
+    public function getRichMessageParameters();
+
+    /**
+     * Set the object of the activity
+     *
+     * @param string $objectType
+     * @param int $objectId
+     * @param string $objectName
+     * @return IEvent
+     * @throws \InvalidArgumentException if the object is invalid
+     * @since 8.2.0
+     */
+    public function setObject($objectType, $objectId, $objectName = '');
+
+    /**
+     * Set the link of the activity
+     *
+     * @param string $link
+     * @return IEvent
+     * @throws \InvalidArgumentException if the link is invalid
+     * @since 8.2.0
+     */
+    public function setLink($link);
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getApp();
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getType();
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getAffectedUser();
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getAuthor();
+
+    /**
+     * @return int
+     * @since 8.2.0
+     */
+    public function getTimestamp();
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getSubject();
+
+    /**
+     * @return array
+     * @since 8.2.0
+     */
+    public function getSubjectParameters();
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getMessage();
+
+    /**
+     * @return array
+     * @since 8.2.0
+     */
+    public function getMessageParameters();
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getObjectType();
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getObjectId();
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getObjectName();
+
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function getLink();
+
+    /**
+     * @param string $icon
+     * @return $this
+     * @throws \InvalidArgumentException if the icon is invalid
+     * @since 11.0.0
+     */
+    public function setIcon($icon);
+
+    /**
+     * @return string
+     * @since 11.0.0
+     */
+    public function getIcon();
+
+    /**
+     * @param IEvent $child
+     * @since 11.0.0
+     */
+    public function setChildEvent(IEvent $child);
+
+    /**
+     * @return IEvent|null
+     * @since 11.0.0
+     */
+    public function getChildEvent();
+
+    /**
+     * @return bool
+     * @since 11.0.0
+     */
+    public function isValid();
+
+    /**
+     * @return bool
+     * @since 11.0.0
+     */
+    public function isValidParsed();
 }

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

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