nextcloud / server

lib/public/BackgroundJob.php

Spacing +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
 	 * @since 5.0.0
 	 */
 	public static function setExecutionType($type) {
-		if( !in_array( $type, array('none', 'ajax', 'webcron', 'cron'))) {
+		if (!in_array($type, array('none', 'ajax', 'webcron', 'cron'))) {
 			return false;
 		}
 		\OC::$server->getConfig()->setAppValue('core', 'backgroundjobs_mode', $type);

Indentation +123 added lines, -123 removed lines

@@ -50,136 +50,136 @@
  * @since 4.5.0
  */
 class BackgroundJob {
-	/**
-	 * get the execution type of background jobs
-	 *
-	 * @return string
-	 *
-	 * This method returns the type how background jobs are executed. If the user
-	 * did not select something, the type is ajax.
-	 * @since 5.0.0
-	 */
-	public static function getExecutionType() {
-		return \OC::$server->getConfig()->getAppValue('core', 'backgroundjobs_mode', 'ajax');
-	}
+    /**
+     * get the execution type of background jobs
+     *
+     * @return string
+     *
+     * This method returns the type how background jobs are executed. If the user
+     * did not select something, the type is ajax.
+     * @since 5.0.0
+     */
+    public static function getExecutionType() {
+        return \OC::$server->getConfig()->getAppValue('core', 'backgroundjobs_mode', 'ajax');
+    }
 
-	/**
-	 * sets the background jobs execution type
-	 *
-	 * @param string $type execution type
-	 * @return false|null
-	 *
-	 * This method sets the execution type of the background jobs. Possible types
-	 * are "none", "ajax", "webcron", "cron"
-	 * @since 5.0.0
-	 */
-	public static function setExecutionType($type) {
-		if( !in_array( $type, array('none', 'ajax', 'webcron', 'cron'))) {
-			return false;
-		}
-		\OC::$server->getConfig()->setAppValue('core', 'backgroundjobs_mode', $type);
-	}
+    /**
+     * sets the background jobs execution type
+     *
+     * @param string $type execution type
+     * @return false|null
+     *
+     * This method sets the execution type of the background jobs. Possible types
+     * are "none", "ajax", "webcron", "cron"
+     * @since 5.0.0
+     */
+    public static function setExecutionType($type) {
+        if( !in_array( $type, array('none', 'ajax', 'webcron', 'cron'))) {
+            return false;
+        }
+        \OC::$server->getConfig()->setAppValue('core', 'backgroundjobs_mode', $type);
+    }
 
-	/**
-	 * @param string $job
-	 * @param mixed $argument
-	 * @deprecated 8.1.0 Use \OC::$server->getJobList()->add() instead
-	 * @since 6.0.0
-	 */
-	public static function registerJob($job, $argument = null) {
-		$jobList = \OC::$server->getJobList();
-		$jobList->add($job, $argument);
-	}
+    /**
+     * @param string $job
+     * @param mixed $argument
+     * @deprecated 8.1.0 Use \OC::$server->getJobList()->add() instead
+     * @since 6.0.0
+     */
+    public static function registerJob($job, $argument = null) {
+        $jobList = \OC::$server->getJobList();
+        $jobList->add($job, $argument);
+    }
 
-	/**
-	 * @deprecated 6.0.0
-	 * creates a regular task
-	 * @param string $klass class name
-	 * @param string $method method name
-	 * @return boolean|null
-	 * @since 4.5.0
-	 */
-	public static function addRegularTask($klass, $method) {
-		if (!\OCP\Util::needUpgrade()) {
-			self::registerJob('OC\BackgroundJob\Legacy\RegularJob', array($klass, $method));
-			return true;
-		}
-	}
+    /**
+     * @deprecated 6.0.0
+     * creates a regular task
+     * @param string $klass class name
+     * @param string $method method name
+     * @return boolean|null
+     * @since 4.5.0
+     */
+    public static function addRegularTask($klass, $method) {
+        if (!\OCP\Util::needUpgrade()) {
+            self::registerJob('OC\BackgroundJob\Legacy\RegularJob', array($klass, $method));
+            return true;
+        }
+    }
 
-	/**
-	 * @deprecated 6.0.0
-	 * gets all regular tasks
-	 * @return array
-	 *
-	 * key is string "$klass-$method", value is array( $klass, $method )
-	 * @since 4.5.0
-	 */
-	static public function allRegularTasks() {
-		return [];
-	}
+    /**
+     * @deprecated 6.0.0
+     * gets all regular tasks
+     * @return array
+     *
+     * key is string "$klass-$method", value is array( $klass, $method )
+     * @since 4.5.0
+     */
+    static public function allRegularTasks() {
+        return [];
+    }
 
-	/**
-	 * @deprecated 6.0.0
-	 * Gets one queued task
-	 * @param int $id ID of the task
-	 * @return BackgroundJob\IJob|null
-	 * @since 4.5.0
-	 */
-	public static function findQueuedTask($id) {
-		$jobList = \OC::$server->getJobList();
-		return $jobList->getById($id);
-	}
+    /**
+     * @deprecated 6.0.0
+     * Gets one queued task
+     * @param int $id ID of the task
+     * @return BackgroundJob\IJob|null
+     * @since 4.5.0
+     */
+    public static function findQueuedTask($id) {
+        $jobList = \OC::$server->getJobList();
+        return $jobList->getById($id);
+    }
 
-	/**
-	 * @deprecated 6.0.0
-	 * Gets all queued tasks
-	 * @return array an array of associative arrays
-	 * @since 4.5.0
-	 */
-	public static function allQueuedTasks() {
-		return [];
-	}
+    /**
+     * @deprecated 6.0.0
+     * Gets all queued tasks
+     * @return array an array of associative arrays
+     * @since 4.5.0
+     */
+    public static function allQueuedTasks() {
+        return [];
+    }
 
-	/**
-	 * @deprecated 6.0.0
-	 * Gets all queued tasks of a specific app
-	 * @param string $app app name
-	 * @return array an array of associative arrays
-	 * @since 4.5.0
-	 */
-	public static function queuedTaskWhereAppIs($app) {
-		return [];
-	}
+    /**
+     * @deprecated 6.0.0
+     * Gets all queued tasks of a specific app
+     * @param string $app app name
+     * @return array an array of associative arrays
+     * @since 4.5.0
+     */
+    public static function queuedTaskWhereAppIs($app) {
+        return [];
+    }
 
-	/**
-	 * @deprecated 6.0.0
-	 * queues a task
-	 * @param string $app app name
-	 * @param string $class class name
-	 * @param string $method method name
-	 * @param string $parameters all useful data as text
-	 * @return boolean id of task
-	 * @since 4.5.0
-	 */
-	public static function addQueuedTask($app, $class, $method, $parameters) {
-		self::registerJob('OC\BackgroundJob\Legacy\QueuedJob', array('app' => $app, 'klass' => $class, 'method' => $method, 'parameters' => $parameters));
-		return true;
-	}
+    /**
+     * @deprecated 6.0.0
+     * queues a task
+     * @param string $app app name
+     * @param string $class class name
+     * @param string $method method name
+     * @param string $parameters all useful data as text
+     * @return boolean id of task
+     * @since 4.5.0
+     */
+    public static function addQueuedTask($app, $class, $method, $parameters) {
+        self::registerJob('OC\BackgroundJob\Legacy\QueuedJob', array('app' => $app, 'klass' => $class, 'method' => $method, 'parameters' => $parameters));
+        return true;
+    }
 
-	/**
-	 * @deprecated 6.0.0
-	 * deletes a queued task
-	 * @param int $id id of task
-	 * @return boolean|null
-	 *
-	 * Deletes a report
-	 * @since 4.5.0
-	 */
-	public static function deleteQueuedTask($id) {
-		$jobList = \OC::$server->getJobList();
-		$job = $jobList->getById($id);
-		if ($job) {
-			$jobList->remove($job);
-		}
-	}
+    /**
+     * @deprecated 6.0.0
+     * deletes a queued task
+     * @param int $id id of task
+     * @return boolean|null
+     *
+     * Deletes a report
+     * @since 4.5.0
+     */
+    public static function deleteQueuedTask($id) {
+        $jobList = \OC::$server->getJobList();
+        $job = $jobList->getById($id);
+        if ($job) {
+            $jobList->remove($job);
+        }
+    }
 }

lib/public/IDateTimeFormatter.php

Indentation +106 added lines, -106 removed lines

@@ -30,116 +30,116 @@
  * @since 8.0.0
  */
 interface IDateTimeFormatter {
-	/**
-	 * Formats the date of the given timestamp
-	 *
-	 * @param int|\DateTime		$timestamp
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
-	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
-	 * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
-	 * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
-	 * 				The exact format is dependent on the language
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted date string
-	 * @since 8.0.0
-	 */
-	public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
+    /**
+     * Formats the date of the given timestamp
+     *
+     * @param int|\DateTime		$timestamp
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
+     * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
+     * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
+     * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
+     * 				The exact format is dependent on the language
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted date string
+     * @since 8.0.0
+     */
+    public function formatDate($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Formats the date of the given timestamp
-	 *
-	 * @param int|\DateTime		$timestamp
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
-	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
-	 * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
-	 * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
-	 * 				The exact format is dependent on the language
-	 * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N	$l			The locale to use
-	 * @return string Formatted relative date string
-	 * @since 8.0.0
-	 */
-	public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
+    /**
+     * Formats the date of the given timestamp
+     *
+     * @param int|\DateTime		$timestamp
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
+     * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
+     * 				medium:	e.g. 'MMM d, y'			=> 'Aug 20, 2014'
+     * 				short:	e.g. 'M/d/yy'			=> '8/20/14'
+     * 				The exact format is dependent on the language
+     * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N	$l			The locale to use
+     * @return string Formatted relative date string
+     * @since 8.0.0
+     */
+    public function formatDateRelativeDay($timestamp, $format = 'long', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Gives the relative date of the timestamp
-	 * Only works for past dates
-	 *
-	 * @param int|\DateTime	$timestamp
-	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
-	 * @return string	Dates returned are:
-	 * 				<  1 month	=> Today, Yesterday, n days ago
-	 * 				< 13 month	=> last month, n months ago
-	 * 				>= 13 month	=> last year, n years ago
-	 * @param \OCP\IL10N		$l			The locale to use
-	 * @return string Formatted date span
-	 * @since 8.0.0
-	 */
-	public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null);
+    /**
+     * Gives the relative date of the timestamp
+     * Only works for past dates
+     *
+     * @param int|\DateTime	$timestamp
+     * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
+     * @return string	Dates returned are:
+     * 				<  1 month	=> Today, Yesterday, n days ago
+     * 				< 13 month	=> last month, n months ago
+     * 				>= 13 month	=> last year, n years ago
+     * @param \OCP\IL10N		$l			The locale to use
+     * @return string Formatted date span
+     * @since 8.0.0
+     */
+    public function formatDateSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Formats the time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp
-	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
-	 * 				full:	e.g. 'h:mm:ss a zzzz'	=> '11:42:13 AM GMT+0:00'
-	 * 				long:	e.g. 'h:mm:ss a z'		=> '11:42:13 AM GMT'
-	 * 				medium:	e.g. 'h:mm:ss a'		=> '11:42:13 AM'
-	 * 				short:	e.g. 'h:mm a'			=> '11:42 AM'
-	 * 				The exact format is dependent on the language
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N		$l			The locale to use
-	 * @return string Formatted time string
-	 * @since 8.0.0
-	 */
-	public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
+    /**
+     * Formats the time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp
+     * @param string	$format			Either 'full', 'long', 'medium' or 'short'
+     * 				full:	e.g. 'h:mm:ss a zzzz'	=> '11:42:13 AM GMT+0:00'
+     * 				long:	e.g. 'h:mm:ss a z'		=> '11:42:13 AM GMT'
+     * 				medium:	e.g. 'h:mm:ss a'		=> '11:42:13 AM'
+     * 				short:	e.g. 'h:mm a'			=> '11:42 AM'
+     * 				The exact format is dependent on the language
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N		$l			The locale to use
+     * @return string Formatted time string
+     * @since 8.0.0
+     */
+    public function formatTime($timestamp, $format = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Gives the relative past time of the timestamp
-	 *
-	 * @param int|\DateTime	$timestamp
-	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
-	 * @return string	Dates returned are:
-	 * 				< 60 sec	=> seconds ago
-	 * 				<  1 hour	=> n minutes ago
-	 * 				<  1 day	=> n hours ago
-	 * 				<  1 month	=> Yesterday, n days ago
-	 * 				< 13 month	=> last month, n months ago
-	 * 				>= 13 month	=> last year, n years ago
-	 * @param \OCP\IL10N		$l			The locale to use
-	 * @return string Formatted time span
-	 * @since 8.0.0
-	 */
-	public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null);
+    /**
+     * Gives the relative past time of the timestamp
+     *
+     * @param int|\DateTime	$timestamp
+     * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
+     * @return string	Dates returned are:
+     * 				< 60 sec	=> seconds ago
+     * 				<  1 hour	=> n minutes ago
+     * 				<  1 day	=> n hours ago
+     * 				<  1 month	=> Yesterday, n days ago
+     * 				< 13 month	=> last month, n months ago
+     * 				>= 13 month	=> last year, n years ago
+     * @param \OCP\IL10N		$l			The locale to use
+     * @return string Formatted time span
+     * @since 8.0.0
+     */
+    public function formatTimeSpan($timestamp, $baseTimestamp = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp
-	 * @param string	$formatDate		See formatDate() for description
-	 * @param string	$formatTime		See formatTime() for description
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N		$l			The locale to use
-	 * @return string Formatted date and time string
-	 * @since 8.0.0
-	 */
-	public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp
+     * @param string	$formatDate		See formatDate() for description
+     * @param string	$formatTime		See formatTime() for description
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N		$l			The locale to use
+     * @return string Formatted date and time string
+     * @since 8.0.0
+     */
+    public function formatDateTime($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
 
-	/**
-	 * Formats the date and time of the given timestamp
-	 *
-	 * @param int|\DateTime $timestamp
-	 * @param string	$formatDate		See formatDate() for description
-	 * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
-	 * @param string	$formatTime		See formatTime() for description
-	 * @param \DateTimeZone	$timeZone	The timezone to use
-	 * @param \OCP\IL10N		$l			The locale to use
-	 * @return string Formatted relative date and time string
-	 * @since 8.0.0
-	 */
-	public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
+    /**
+     * Formats the date and time of the given timestamp
+     *
+     * @param int|\DateTime $timestamp
+     * @param string	$formatDate		See formatDate() for description
+     * 					Uses 'Today', 'Yesterday' and 'Tomorrow' when applicable
+     * @param string	$formatTime		See formatTime() for description
+     * @param \DateTimeZone	$timeZone	The timezone to use
+     * @param \OCP\IL10N		$l			The locale to use
+     * @return string Formatted relative date and time string
+     * @since 8.0.0
+     */
+    public function formatDateTimeRelativeDay($timestamp, $formatDate = 'long', $formatTime = 'medium', \DateTimeZone $timeZone = null, \OCP\IL10N $l = null);
 }

lib/public/UserInterface.php

Indentation +57 added lines, -57 removed lines

@@ -40,68 +40,68 @@
  */
 interface UserInterface {
 
-	/**
-	 * Check if backend implements actions
-	 * @param int $actions bitwise-or'ed actions
-	 * @return boolean
-	 *
-	 * Returns the supported actions as int to be
-	 * compared with \OC_User_Backend::CREATE_USER etc.
-	 * @since 4.5.0
-	 */
-	public function implementsActions($actions);
+    /**
+     * Check if backend implements actions
+     * @param int $actions bitwise-or'ed actions
+     * @return boolean
+     *
+     * Returns the supported actions as int to be
+     * compared with \OC_User_Backend::CREATE_USER etc.
+     * @since 4.5.0
+     */
+    public function implementsActions($actions);
 
-	/**
-	 * delete a user
-	 * @param string $uid The username of the user to delete
-	 * @return bool
-	 * @since 4.5.0
-	 */
-	public function deleteUser($uid);
+    /**
+     * delete a user
+     * @param string $uid The username of the user to delete
+     * @return bool
+     * @since 4.5.0
+     */
+    public function deleteUser($uid);
 
-	/**
-	 * Get a list of all users
-	 *
-	 * @param string $search
-	 * @param null|int $limit
-	 * @param null|int $offset
-	 * @return string[] an array of all uids
-	 * @since 4.5.0
-	 */
-	public function getUsers($search = '', $limit = null, $offset = null);
+    /**
+     * Get a list of all users
+     *
+     * @param string $search
+     * @param null|int $limit
+     * @param null|int $offset
+     * @return string[] an array of all uids
+     * @since 4.5.0
+     */
+    public function getUsers($search = '', $limit = null, $offset = null);
 
-	/**
-	 * check if a user exists
-	 * @param string $uid the username
-	 * @return boolean
-	 * @since 4.5.0
-	 */
-	public function userExists($uid);
+    /**
+     * check if a user exists
+     * @param string $uid the username
+     * @return boolean
+     * @since 4.5.0
+     */
+    public function userExists($uid);
 
-	/**
-	 * get display name of the user
-	 * @param string $uid user ID of the user
-	 * @return string display name
-	 * @since 4.5.0
-	 */
-	public function getDisplayName($uid);
+    /**
+     * get display name of the user
+     * @param string $uid user ID of the user
+     * @return string display name
+     * @since 4.5.0
+     */
+    public function getDisplayName($uid);
 
-	/**
-	 * Get a list of all display names and user ids.
-	 *
-	 * @param string $search
-	 * @param string|null $limit
-	 * @param string|null $offset
-	 * @return array an array of all displayNames (value) and the corresponding uids (key)
-	 * @since 4.5.0
-	 */
-	public function getDisplayNames($search = '', $limit = null, $offset = null);
+    /**
+     * Get a list of all display names and user ids.
+     *
+     * @param string $search
+     * @param string|null $limit
+     * @param string|null $offset
+     * @return array an array of all displayNames (value) and the corresponding uids (key)
+     * @since 4.5.0
+     */
+    public function getDisplayNames($search = '', $limit = null, $offset = null);
 
-	/**
-	 * Check if a user list is available or not
-	 * @return boolean if users can be listed or not
-	 * @since 4.5.0
-	 */
-	public function hasUserListings();
+    /**
+     * Check if a user list is available or not
+     * @return boolean if users can be listed or not
+     * @since 4.5.0
+     */
+    public function hasUserListings();
 
 }

lib/public/Encryption/IEncryptionModule.php

Indentation +146 added lines, -146 removed lines

@@ -35,151 +35,151 @@
  */
 interface IEncryptionModule {
 
-	/**
-	 * @return string defining the technical unique id
-	 * @since 8.1.0
-	 */
-	public function getId();
-
-	/**
-	 * In comparison to getKey() this function returns a human readable (maybe translated) name
-	 *
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function getDisplayName();
-
-	/**
-	 * start receiving chunks from a file. This is the place where you can
-	 * perform some initial step before starting encrypting/decrypting the
-	 * chunks
-	 *
-	 * @param string $path to the file
-	 * @param string $user who read/write the file (null for public access)
-	 * @param string $mode php stream open mode
-	 * @param array $header contains the header data read from the file
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 *
-	 * $return array $header contain data as key-value pairs which should be
-	 *                       written to the header, in case of a write operation
-	 *                       or if no additional data is needed return a empty array
-	 * @since 8.1.0
-	 */
-	public function begin($path, $user, $mode, array $header, array $accessList);
-
-	/**
-	 * last chunk received. This is the place where you can perform some final
-	 * operation and return some remaining data if something is left in your
-	 * buffer.
-	 *
-	 * @param string $path to the file
-	 * @param string $position id of the last block (looks like "<Number>end")
-	 *
-	 * @return string remained data which should be written to the file in case
-	 *                of a write operation
-	 *
-	 * @since 8.1.0
-	 * @since 9.0.0 parameter $position added
-	 */
-	public function end($path, $position);
-
-	/**
-	 * encrypt data
-	 *
-	 * @param string $data you want to encrypt
-	 * @param string $position position of the block we want to encrypt (starts with '0')
-	 *
-	 * @return mixed encrypted data
-	 *
-	 * @since 8.1.0
-	 * @since 9.0.0 parameter $position added
-	 */
-	public function encrypt($data, $position);
-
-	/**
-	 * decrypt data
-	 *
-	 * @param string $data you want to decrypt
-	 * @param string $position position of the block we want to decrypt
-	 *
-	 * @return mixed decrypted data
-	 *
-	 * @since 8.1.0
-	 * @since 9.0.0 parameter $position added
-	 */
-	public function decrypt($data, $position);
-
-	/**
-	 * update encrypted file, e.g. give additional users access to the file
-	 *
-	 * @param string $path path to the file which should be updated
-	 * @param string $uid of the user who performs the operation
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public function update($path, $uid, array $accessList);
-
-	/**
-	 * should the file be encrypted or not
-	 *
-	 * @param string $path
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public function shouldEncrypt($path);
-
-	/**
-	 * get size of the unencrypted payload per block.
-	 * ownCloud read/write files with a block size of 8192 byte
-	 *
-	 * @param bool $signed
-	 * @return int
-	 * @since 8.1.0 optional parameter $signed was added in 9.0.0
-	 */
-	public function getUnencryptedBlockSize($signed = false);
-
-	/**
-	 * check if the encryption module is able to read the file,
-	 * e.g. if all encryption keys exists
-	 *
-	 * @param string $path
-	 * @param string $uid user for whom we want to check if he can read the file
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public function isReadable($path, $uid);
-
-	/**
-	 * Initial encryption of all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output write some status information to the terminal during encryption
-	 * @since 8.2.0
-	 */
-	public function encryptAll(InputInterface $input, OutputInterface $output);
-
-	/**
-	 * prepare encryption module to decrypt all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output write some status information to the terminal during encryption
-	 * @param $user (optional) for which the files should be decrypted, default = all users
-	 * @return bool return false on failure or if it isn't supported by the module
-	 * @since 8.2.0
-	 */
-	public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '');
-
-	/**
-	 * Check if the module is ready to be used by that specific user.
-	 * In case a module is not ready - because e.g. key pairs have not been generated
-	 * upon login this method can return false before any operation starts and might
-	 * cause issues during operations.
-	 *
-	 * @param string $user
-	 * @return boolean
-	 * @since 9.1.0
-	 */
-	public function isReadyForUser($user);
+    /**
+     * @return string defining the technical unique id
+     * @since 8.1.0
+     */
+    public function getId();
+
+    /**
+     * In comparison to getKey() this function returns a human readable (maybe translated) name
+     *
+     * @return string
+     * @since 8.1.0
+     */
+    public function getDisplayName();
+
+    /**
+     * start receiving chunks from a file. This is the place where you can
+     * perform some initial step before starting encrypting/decrypting the
+     * chunks
+     *
+     * @param string $path to the file
+     * @param string $user who read/write the file (null for public access)
+     * @param string $mode php stream open mode
+     * @param array $header contains the header data read from the file
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     *
+     * $return array $header contain data as key-value pairs which should be
+     *                       written to the header, in case of a write operation
+     *                       or if no additional data is needed return a empty array
+     * @since 8.1.0
+     */
+    public function begin($path, $user, $mode, array $header, array $accessList);
+
+    /**
+     * last chunk received. This is the place where you can perform some final
+     * operation and return some remaining data if something is left in your
+     * buffer.
+     *
+     * @param string $path to the file
+     * @param string $position id of the last block (looks like "<Number>end")
+     *
+     * @return string remained data which should be written to the file in case
+     *                of a write operation
+     *
+     * @since 8.1.0
+     * @since 9.0.0 parameter $position added
+     */
+    public function end($path, $position);
+
+    /**
+     * encrypt data
+     *
+     * @param string $data you want to encrypt
+     * @param string $position position of the block we want to encrypt (starts with '0')
+     *
+     * @return mixed encrypted data
+     *
+     * @since 8.1.0
+     * @since 9.0.0 parameter $position added
+     */
+    public function encrypt($data, $position);
+
+    /**
+     * decrypt data
+     *
+     * @param string $data you want to decrypt
+     * @param string $position position of the block we want to decrypt
+     *
+     * @return mixed decrypted data
+     *
+     * @since 8.1.0
+     * @since 9.0.0 parameter $position added
+     */
+    public function decrypt($data, $position);
+
+    /**
+     * update encrypted file, e.g. give additional users access to the file
+     *
+     * @param string $path path to the file which should be updated
+     * @param string $uid of the user who performs the operation
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     * @return boolean
+     * @since 8.1.0
+     */
+    public function update($path, $uid, array $accessList);
+
+    /**
+     * should the file be encrypted or not
+     *
+     * @param string $path
+     * @return boolean
+     * @since 8.1.0
+     */
+    public function shouldEncrypt($path);
+
+    /**
+     * get size of the unencrypted payload per block.
+     * ownCloud read/write files with a block size of 8192 byte
+     *
+     * @param bool $signed
+     * @return int
+     * @since 8.1.0 optional parameter $signed was added in 9.0.0
+     */
+    public function getUnencryptedBlockSize($signed = false);
+
+    /**
+     * check if the encryption module is able to read the file,
+     * e.g. if all encryption keys exists
+     *
+     * @param string $path
+     * @param string $uid user for whom we want to check if he can read the file
+     * @return boolean
+     * @since 8.1.0
+     */
+    public function isReadable($path, $uid);
+
+    /**
+     * Initial encryption of all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output write some status information to the terminal during encryption
+     * @since 8.2.0
+     */
+    public function encryptAll(InputInterface $input, OutputInterface $output);
+
+    /**
+     * prepare encryption module to decrypt all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output write some status information to the terminal during encryption
+     * @param $user (optional) for which the files should be decrypted, default = all users
+     * @return bool return false on failure or if it isn't supported by the module
+     * @since 8.2.0
+     */
+    public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '');
+
+    /**
+     * Check if the module is ready to be used by that specific user.
+     * In case a module is not ready - because e.g. key pairs have not been generated
+     * upon login this method can return false before any operation starts and might
+     * cause issues during operations.
+     *
+     * @param string $user
+     * @return boolean
+     * @since 9.1.0
+     */
+    public function isReadyForUser($user);
 
 }

lib/public/Encryption/IFile.php

Indentation +8 added lines, -8 removed lines

@@ -32,13 +32,13 @@
  */
 interface IFile {
 
-	/**
-	 * get list of users with access to the file
-	 *
-	 * @param string $path to the file
-	 * @return array
-	 * @since 8.1.0
-	 */
-	public function getAccessList($path);
+    /**
+     * get list of users with access to the file
+     *
+     * @param string $path to the file
+     * @return array
+     * @since 8.1.0
+     */
+    public function getAccessList($path);
 
 }

lib/public/Encryption/Exceptions/GenericEncryptionException.php

Indentation +13 added lines, -13 removed lines

@@ -35,18 +35,18 @@
  */
 class GenericEncryptionException extends HintException {
 
-	/**
-	 * @param string $message
-	 * @param string $hint
-	 * @param int $code
-	 * @param \Exception $previous
-	 * @since 8.1.0
-	 */
-	public function __construct($message = '', $hint = '', $code = 0, \Exception $previous = null) {
-		if (empty($message)) {
-			$message = 'Unspecified encryption exception';
-		}
-		parent::__construct($message, $hint, $code, $previous);
-	}
+    /**
+     * @param string $message
+     * @param string $hint
+     * @param int $code
+     * @param \Exception $previous
+     * @since 8.1.0
+     */
+    public function __construct($message = '', $hint = '', $code = 0, \Exception $previous = null) {
+        if (empty($message)) {
+            $message = 'Unspecified encryption exception';
+        }
+        parent::__construct($message, $hint, $code, $previous);
+    }
 
 }

lib/public/Encryption/IManager.php

Indentation +55 added lines, -55 removed lines

@@ -34,67 +34,67 @@
  */
 interface IManager {
 
-	/**
-	 * Check if encryption is available (at least one encryption module needs to be enabled)
-	 *
-	 * @return bool true if enabled, false if not
-	 * @since 8.1.0
-	 */
-	public function isEnabled();
+    /**
+     * Check if encryption is available (at least one encryption module needs to be enabled)
+     *
+     * @return bool true if enabled, false if not
+     * @since 8.1.0
+     */
+    public function isEnabled();
 
-	/**
-	 * Registers an callback function which must return an encryption module instance
-	 *
-	 * @param string $id
-	 * @param string $displayName
-	 * @param callable $callback
-	 * @throws ModuleAlreadyExistsException
-	 * @since 8.1.0
-	 */
-	public function registerEncryptionModule($id, $displayName, callable $callback);
+    /**
+     * Registers an callback function which must return an encryption module instance
+     *
+     * @param string $id
+     * @param string $displayName
+     * @param callable $callback
+     * @throws ModuleAlreadyExistsException
+     * @since 8.1.0
+     */
+    public function registerEncryptionModule($id, $displayName, callable $callback);
 
-	/**
-	 * Unregisters an encryption module
-	 *
-	 * @param string $moduleId
-	 * @since 8.1.0
-	 */
-	public function unregisterEncryptionModule($moduleId);
+    /**
+     * Unregisters an encryption module
+     *
+     * @param string $moduleId
+     * @since 8.1.0
+     */
+    public function unregisterEncryptionModule($moduleId);
 
-	/**
-	 * get a list of all encryption modules
-	 *
-	 * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
-	 * @since 8.1.0
-	 */
-	public function getEncryptionModules();
+    /**
+     * get a list of all encryption modules
+     *
+     * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
+     * @since 8.1.0
+     */
+    public function getEncryptionModules();
 
 
-	/**
-	 * get a specific encryption module
-	 *
-	 * @param string $moduleId Empty to get the default module
-	 * @return IEncryptionModule
-	 * @throws ModuleDoesNotExistsException
-	 * @since 8.1.0
-	 */
-	public function getEncryptionModule($moduleId = '');
+    /**
+     * get a specific encryption module
+     *
+     * @param string $moduleId Empty to get the default module
+     * @return IEncryptionModule
+     * @throws ModuleDoesNotExistsException
+     * @since 8.1.0
+     */
+    public function getEncryptionModule($moduleId = '');
 
-	/**
-	 * get default encryption module Id
-	 *
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function getDefaultEncryptionModuleId();
+    /**
+     * get default encryption module Id
+     *
+     * @return string
+     * @since 8.1.0
+     */
+    public function getDefaultEncryptionModuleId();
 
-	/**
-	 * set default encryption module Id
-	 *
-	 * @param string $moduleId
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function setDefaultEncryptionModule($moduleId);
+    /**
+     * set default encryption module Id
+     *
+     * @param string $moduleId
+     * @return string
+     * @since 8.1.0
+     */
+    public function setDefaultEncryptionModule($moduleId);
 
 }

lib/public/IGroupManager.php

Indentation +81 added lines, -81 removed lines

@@ -45,96 +45,96 @@
  * @since 8.0.0
  */
 interface IGroupManager {
-	/**
-	 * Checks whether a given backend is used
-	 *
-	 * @param string $backendClass Full classname including complete namespace
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function isBackendUsed($backendClass);
+    /**
+     * Checks whether a given backend is used
+     *
+     * @param string $backendClass Full classname including complete namespace
+     * @return bool
+     * @since 8.1.0
+     */
+    public function isBackendUsed($backendClass);
 
-	/**
-	 * @param \OCP\GroupInterface $backend
-	 * @since 8.0.0
-	 */
-	public function addBackend($backend);
+    /**
+     * @param \OCP\GroupInterface $backend
+     * @since 8.0.0
+     */
+    public function addBackend($backend);
 
-	/**
-	 * @since 8.0.0
-	 */
-	public function clearBackends();
+    /**
+     * @since 8.0.0
+     */
+    public function clearBackends();
 
-	/**
-	 * @param string $gid
-	 * @return \OCP\IGroup
-	 * @since 8.0.0
-	 */
-	public function get($gid);
+    /**
+     * @param string $gid
+     * @return \OCP\IGroup
+     * @since 8.0.0
+     */
+    public function get($gid);
 
-	/**
-	 * @param string $gid
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function groupExists($gid);
+    /**
+     * @param string $gid
+     * @return bool
+     * @since 8.0.0
+     */
+    public function groupExists($gid);
 
-	/**
-	 * @param string $gid
-	 * @return \OCP\IGroup
-	 * @since 8.0.0
-	 */
-	public function createGroup($gid);
+    /**
+     * @param string $gid
+     * @return \OCP\IGroup
+     * @since 8.0.0
+     */
+    public function createGroup($gid);
 
-	/**
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OCP\IGroup[]
-	 * @since 8.0.0
-	 */
-	public function search($search, $limit = null, $offset = null);
+    /**
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return \OCP\IGroup[]
+     * @since 8.0.0
+     */
+    public function search($search, $limit = null, $offset = null);
 
-	/**
-	 * @param \OCP\IUser|null $user
-	 * @return \OCP\IGroup[]
-	 * @since 8.0.0
-	 */
-	public function getUserGroups($user);
+    /**
+     * @param \OCP\IUser|null $user
+     * @return \OCP\IGroup[]
+     * @since 8.0.0
+     */
+    public function getUserGroups($user);
 
-	/**
-	 * @param \OCP\IUser $user
-	 * @return array with group names
-	 * @since 8.0.0
-	 */
-	public function getUserGroupIds($user);
+    /**
+     * @param \OCP\IUser $user
+     * @return array with group names
+     * @since 8.0.0
+     */
+    public function getUserGroupIds($user);
 
-	/**
-	 * get a list of all display names in a group
-	 *
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of display names (value) and user ids (key)
-	 * @since 8.0.0
-	 */
-	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0);
+    /**
+     * get a list of all display names in a group
+     *
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of display names (value) and user ids (key)
+     * @since 8.0.0
+     */
+    public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0);
 
-	/**
-	 * Checks if a userId is in the admin group
-	 * @param string $userId
-	 * @return bool if admin
-	 * @since 8.0.0
-	 */
-	public function isAdmin($userId);
+    /**
+     * Checks if a userId is in the admin group
+     * @param string $userId
+     * @return bool if admin
+     * @since 8.0.0
+     */
+    public function isAdmin($userId);
 
-	/**
-	 * Checks if a userId is in a group
-	 * @param string $userId
-	 * @param string $group
-	 * @return bool if in group
-	 * @since 8.0.0
-	 */
-	public function isInGroup($userId, $group);
+    /**
+     * Checks if a userId is in a group
+     * @param string $userId
+     * @param string $group
+     * @return bool if in group
+     * @since 8.0.0
+     */
+    public function isInGroup($userId, $group);
 }

lib/public/IAvatar.php

Indentation +38 added lines, -38 removed lines

@@ -35,46 +35,46 @@
  */
 interface IAvatar {
 
-	/**
-	 * get the users avatar
-	 * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image
-	 * @return boolean|\OCP\IImage containing the avatar or false if there's no image
-	 * @since 6.0.0 - size of -1 was added in 9.0.0
-	 */
-	public function get($size = 64);
+    /**
+     * get the users avatar
+     * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image
+     * @return boolean|\OCP\IImage containing the avatar or false if there's no image
+     * @since 6.0.0 - size of -1 was added in 9.0.0
+     */
+    public function get($size = 64);
 
-	/**
-	 * Check if an avatar exists for the user
-	 *
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function exists();
+    /**
+     * Check if an avatar exists for the user
+     *
+     * @return bool
+     * @since 8.1.0
+     */
+    public function exists();
 
-	/**
-	 * sets the users avatar
-	 * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar
-	 * @throws \Exception if the provided file is not a jpg or png image
-	 * @throws \Exception if the provided image is not valid
-	 * @throws \OC\NotSquareException if the image is not square
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function set($data);
+    /**
+     * sets the users avatar
+     * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar
+     * @throws \Exception if the provided file is not a jpg or png image
+     * @throws \Exception if the provided image is not valid
+     * @throws \OC\NotSquareException if the image is not square
+     * @return void
+     * @since 6.0.0
+     */
+    public function set($data);
 
-	/**
-	 * remove the users avatar
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function remove();
+    /**
+     * remove the users avatar
+     * @return void
+     * @since 6.0.0
+     */
+    public function remove();
 
-	/**
-	 * Get the file of the avatar
-	 * @param int $size -1 can be used to not scale the image
-	 * @return File
-	 * @throws NotFoundException
-	 * @since 9.0.0
-	 */
-	public function getFile($size);
+    /**
+     * Get the file of the avatar
+     * @param int $size -1 can be used to not scale the image
+     * @return File
+     * @throws NotFoundException
+     * @since 9.0.0
+     */
+    public function getFile($size);
 }