nextcloud / server

lib/public/IAvatarManager.php

Indentation +10 added lines, -10 removed lines

@@ -33,14 +33,14 @@
 
 interface IAvatarManager {
 
-	/**
-	 * return a user specific instance of \OCP\IAvatar
-	 * @see \OCP\IAvatar
-	 * @param string $user the ownCloud user id
-	 * @return \OCP\IAvatar
-	 * @throws \Exception In case the username is potentially dangerous
-	 * @throws \OCP\Files\NotFoundException In case there is no user folder yet
-	 * @since 6.0.0
-	 */
-	public function getAvatar($user);
+    /**
+     * return a user specific instance of \OCP\IAvatar
+     * @see \OCP\IAvatar
+     * @param string $user the ownCloud user id
+     * @return \OCP\IAvatar
+     * @throws \Exception In case the username is potentially dangerous
+     * @throws \OCP\Files\NotFoundException In case there is no user folder yet
+     * @since 6.0.0
+     */
+    public function getAvatar($user);
 }

lib/public/IImage.php

Indentation +154 added lines, -154 removed lines

@@ -29,158 +29,158 @@
  * @since 8.1.0
  */
 interface IImage {
-	/**
-	 * Determine whether the object contains an image resource.
-	 *
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function valid();
-
-	/**
-	 * Returns the MIME type of the image or an empty string if no image is loaded.
-	 *
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function mimeType();
-
-	/**
-	 * Returns the width of the image or -1 if no image is loaded.
-	 *
-	 * @return int
-	 * @since 8.1.0
-	 */
-	public function width();
-
-	/**
-	 * Returns the height of the image or -1 if no image is loaded.
-	 *
-	 * @return int
-	 * @since 8.1.0
-	 */
-	public function height();
-
-	/**
-	 * Returns the width when the image orientation is top-left.
-	 *
-	 * @return int
-	 * @since 8.1.0
-	 */
-	public function widthTopLeft();
-
-	/**
-	 * Returns the height when the image orientation is top-left.
-	 *
-	 * @return int
-	 * @since 8.1.0
-	 */
-	public function heightTopLeft();
-
-	/**
-	 * Outputs the image.
-	 *
-	 * @param string $mimeType
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function show($mimeType = null);
-
-	/**
-	 * Saves the image.
-	 *
-	 * @param string $filePath
-	 * @param string $mimeType
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function save($filePath = null, $mimeType = null);
-
-	/**
-	 * @return resource Returns the image resource in any.
-	 * @since 8.1.0
-	 */
-	public function resource();
-
-	/**
-	 * @return string Returns the raw image data.
-	 * @since 8.1.0
-	 */
-	public function data();
-
-	/**
-	 * (I'm open for suggestions on better method name ;)
-	 * Get the orientation based on EXIF data.
-	 *
-	 * @return int The orientation or -1 if no EXIF data is available.
-	 * @since 8.1.0
-	 */
-	public function getOrientation();
-
-	/**
-	 * (I'm open for suggestions on better method name ;)
-	 * Fixes orientation based on EXIF data.
-	 *
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function fixOrientation();
-
-	/**
-	 * Resizes the image preserving ratio.
-	 *
-	 * @param integer $maxSize The maximum size of either the width or height.
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function resize($maxSize);
-
-	/**
-	 * @param int $width
-	 * @param int $height
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function preciseResize($width, $height);
-
-	/**
-	 * Crops the image to the middle square. If the image is already square it just returns.
-	 *
-	 * @param int $size maximum size for the result (optional)
-	 * @return bool for success or failure
-	 * @since 8.1.0
-	 */
-	public function centerCrop($size = 0);
-
-	/**
-	 * Crops the image from point $x$y with dimension $wx$h.
-	 *
-	 * @param int $x Horizontal position
-	 * @param int $y Vertical position
-	 * @param int $w Width
-	 * @param int $h Height
-	 * @return bool for success or failure
-	 * @since 8.1.0
-	 */
-	public function crop($x, $y, $w, $h);
-
-	/**
-	 * Resizes the image to fit within a boundary while preserving ratio.
-	 *
-	 * @param integer $maxWidth
-	 * @param integer $maxHeight
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function fitIn($maxWidth, $maxHeight);
-
-	/**
-	 * Shrinks the image to fit within a boundary while preserving ratio.
-	 *
-	 * @param integer $maxWidth
-	 * @param integer $maxHeight
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function scaleDownToFit($maxWidth, $maxHeight);
+    /**
+     * Determine whether the object contains an image resource.
+     *
+     * @return bool
+     * @since 8.1.0
+     */
+    public function valid();
+
+    /**
+     * Returns the MIME type of the image or an empty string if no image is loaded.
+     *
+     * @return string
+     * @since 8.1.0
+     */
+    public function mimeType();
+
+    /**
+     * Returns the width of the image or -1 if no image is loaded.
+     *
+     * @return int
+     * @since 8.1.0
+     */
+    public function width();
+
+    /**
+     * Returns the height of the image or -1 if no image is loaded.
+     *
+     * @return int
+     * @since 8.1.0
+     */
+    public function height();
+
+    /**
+     * Returns the width when the image orientation is top-left.
+     *
+     * @return int
+     * @since 8.1.0
+     */
+    public function widthTopLeft();
+
+    /**
+     * Returns the height when the image orientation is top-left.
+     *
+     * @return int
+     * @since 8.1.0
+     */
+    public function heightTopLeft();
+
+    /**
+     * Outputs the image.
+     *
+     * @param string $mimeType
+     * @return bool
+     * @since 8.1.0
+     */
+    public function show($mimeType = null);
+
+    /**
+     * Saves the image.
+     *
+     * @param string $filePath
+     * @param string $mimeType
+     * @return bool
+     * @since 8.1.0
+     */
+    public function save($filePath = null, $mimeType = null);
+
+    /**
+     * @return resource Returns the image resource in any.
+     * @since 8.1.0
+     */
+    public function resource();
+
+    /**
+     * @return string Returns the raw image data.
+     * @since 8.1.0
+     */
+    public function data();
+
+    /**
+     * (I'm open for suggestions on better method name ;)
+     * Get the orientation based on EXIF data.
+     *
+     * @return int The orientation or -1 if no EXIF data is available.
+     * @since 8.1.0
+     */
+    public function getOrientation();
+
+    /**
+     * (I'm open for suggestions on better method name ;)
+     * Fixes orientation based on EXIF data.
+     *
+     * @return bool
+     * @since 8.1.0
+     */
+    public function fixOrientation();
+
+    /**
+     * Resizes the image preserving ratio.
+     *
+     * @param integer $maxSize The maximum size of either the width or height.
+     * @return bool
+     * @since 8.1.0
+     */
+    public function resize($maxSize);
+
+    /**
+     * @param int $width
+     * @param int $height
+     * @return bool
+     * @since 8.1.0
+     */
+    public function preciseResize($width, $height);
+
+    /**
+     * Crops the image to the middle square. If the image is already square it just returns.
+     *
+     * @param int $size maximum size for the result (optional)
+     * @return bool for success or failure
+     * @since 8.1.0
+     */
+    public function centerCrop($size = 0);
+
+    /**
+     * Crops the image from point $x$y with dimension $wx$h.
+     *
+     * @param int $x Horizontal position
+     * @param int $y Vertical position
+     * @param int $w Width
+     * @param int $h Height
+     * @return bool for success or failure
+     * @since 8.1.0
+     */
+    public function crop($x, $y, $w, $h);
+
+    /**
+     * Resizes the image to fit within a boundary while preserving ratio.
+     *
+     * @param integer $maxWidth
+     * @param integer $maxHeight
+     * @return bool
+     * @since 8.1.0
+     */
+    public function fitIn($maxWidth, $maxHeight);
+
+    /**
+     * Shrinks the image to fit within a boundary while preserving ratio.
+     *
+     * @param integer $maxWidth
+     * @param integer $maxHeight
+     * @return bool
+     * @since 8.1.0
+     */
+    public function scaleDownToFit($maxWidth, $maxHeight);
 }

lib/public/App/ManagerEvent.php

Indentation +51 added lines, -51 removed lines

@@ -32,61 +32,61 @@
  */
 class ManagerEvent extends Event {
 
-	const EVENT_APP_ENABLE = 'OCP\App\IAppManager::enableApp';
-	const EVENT_APP_ENABLE_FOR_GROUPS = 'OCP\App\IAppManager::enableAppForGroups';
-	const EVENT_APP_DISABLE = 'OCP\App\IAppManager::disableApp';
+    const EVENT_APP_ENABLE = 'OCP\App\IAppManager::enableApp';
+    const EVENT_APP_ENABLE_FOR_GROUPS = 'OCP\App\IAppManager::enableAppForGroups';
+    const EVENT_APP_DISABLE = 'OCP\App\IAppManager::disableApp';
 
-	/**
-	 * @since 9.1.0
-	 */
-	const EVENT_APP_UPDATE = 'OCP\App\IAppManager::updateApp';
+    /**
+     * @since 9.1.0
+     */
+    const EVENT_APP_UPDATE = 'OCP\App\IAppManager::updateApp';
 
-	/** @var string */
-	protected $event;
-	/** @var string */
-	protected $appID;
-	/** @var \OCP\IGroup[] */
-	protected $groups;
+    /** @var string */
+    protected $event;
+    /** @var string */
+    protected $appID;
+    /** @var \OCP\IGroup[] */
+    protected $groups;
 
-	/**
-	 * DispatcherEvent constructor.
-	 *
-	 * @param string $event
-	 * @param $appID
-	 * @param \OCP\IGroup[] $groups
-	 * @since 9.0.0
-	 */
-	public function __construct($event, $appID, array $groups = null) {
-		$this->event = $event;
-		$this->appID = $appID;
-		$this->groups = $groups;
-	}
+    /**
+     * DispatcherEvent constructor.
+     *
+     * @param string $event
+     * @param $appID
+     * @param \OCP\IGroup[] $groups
+     * @since 9.0.0
+     */
+    public function __construct($event, $appID, array $groups = null) {
+        $this->event = $event;
+        $this->appID = $appID;
+        $this->groups = $groups;
+    }
 
-	/**
-	 * @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 string
-	 * @since 9.0.0
-	 */
-	public function getAppID() {
-		return $this->appID;
-	}
+    /**
+     * @return string
+     * @since 9.0.0
+     */
+    public function getAppID() {
+        return $this->appID;
+    }
 
-	/**
-	 * returns the group Ids
-	 * @return string[]
-	 * @since 9.0.0
-	 */
-	public function getGroups() {
-		return array_map(function ($group) {
-			/** @var \OCP\IGroup $group */
-			return $group->getGID();
-		}, $this->groups);
-	}
+    /**
+     * returns the group Ids
+     * @return string[]
+     * @since 9.0.0
+     */
+    public function getGroups() {
+        return array_map(function ($group) {
+            /** @var \OCP\IGroup $group */
+            return $group->getGID();
+        }, $this->groups);
+    }
 }

lib/public/Preview/IProvider.php

Indentation +25 added lines, -25 removed lines

@@ -29,31 +29,31 @@
  * @since 8.1.0
  */
 interface IProvider {
-	/**
-	 * @return string Regex with the mimetypes that are supported by this provider
-	 * @since 8.1.0
-	 */
-	public function getMimeType();
+    /**
+     * @return string Regex with the mimetypes that are supported by this provider
+     * @since 8.1.0
+     */
+    public function getMimeType();
 
-	/**
-	 * Check if a preview can be generated for $path
-	 *
-	 * @param \OCP\Files\FileInfo $file
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function isAvailable(\OCP\Files\FileInfo $file);
+    /**
+     * Check if a preview can be generated for $path
+     *
+     * @param \OCP\Files\FileInfo $file
+     * @return bool
+     * @since 8.1.0
+     */
+    public function isAvailable(\OCP\Files\FileInfo $file);
 
-	/**
-	 * get thumbnail for file at path $path
-	 *
-	 * @param string $path Path of file
-	 * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
-	 * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
-	 * @param bool $scalingup Disable/Enable upscaling of previews
-	 * @param \OC\Files\View $fileview fileview object of user folder
-	 * @return bool|\OCP\IImage false if no preview was generated
-	 * @since 8.1.0
-	 */
-	public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview);
+    /**
+     * get thumbnail for file at path $path
+     *
+     * @param string $path Path of file
+     * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
+     * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
+     * @param bool $scalingup Disable/Enable upscaling of previews
+     * @param \OC\Files\View $fileview fileview object of user folder
+     * @return bool|\OCP\IImage false if no preview was generated
+     * @since 8.1.0
+     */
+    public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview);
 }

lib/public/IMemcache.php

Indentation +47 added lines, -47 removed lines

@@ -37,55 +37,55 @@
  * @since 8.1.0
  */
 interface IMemcache extends ICache {
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function add($key, $value, $ttl = 0);
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     * @since 8.1.0
+     */
+    public function add($key, $value, $ttl = 0);
 
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 * @since 8.1.0
-	 */
-	public function inc($key, $step = 1);
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     * @since 8.1.0
+     */
+    public function inc($key, $step = 1);
 
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 * @since 8.1.0
-	 */
-	public function dec($key, $step = 1);
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     * @since 8.1.0
+     */
+    public function dec($key, $step = 1);
 
-	/**
-	 * Compare and set
-	 *
-	 * @param string $key
-	 * @param mixed $old
-	 * @param mixed $new
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function cas($key, $old, $new);
+    /**
+     * Compare and set
+     *
+     * @param string $key
+     * @param mixed $old
+     * @param mixed $new
+     * @return bool
+     * @since 8.1.0
+     */
+    public function cas($key, $old, $new);
 
-	/**
-	 * Compare and delete
-	 *
-	 * @param string $key
-	 * @param mixed $old
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function cad($key, $old);
+    /**
+     * Compare and delete
+     *
+     * @param string $key
+     * @param mixed $old
+     * @return bool
+     * @since 8.1.0
+     */
+    public function cad($key, $old);
 }

lib/public/BackgroundJob.php

Indentation +38 added lines, -38 removed lines

@@ -50,44 +50,44 @@
  * @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);
+    }
 }

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