nextcloud / server

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

lib/public/Security/IContentSecurityPolicyManager.php

Indentation +18 added lines, -18 removed lines

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

lib/public/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);
 
 }