nextcloud / server

lib/public/SabrePluginException.php

Indentation +9 added lines, -9 removed lines

@@ -30,13 +30,13 @@
  */
 class SabrePluginException extends Exception {
 
-	/**
-	 * Returns the HTTP statuscode for this exception
-	 *
-	 * @return int
-	 * @since 8.2.0
-	 */
-	public function getHTTPCode() {
-		return $this->code;
-	}
+    /**
+     * Returns the HTTP statuscode for this exception
+     *
+     * @return int
+     * @since 8.2.0
+     */
+    public function getHTTPCode() {
+        return $this->code;
+    }
 }

lib/public/BackgroundJob/IJob.php

Indentation +46 added lines, -46 removed lines

@@ -32,56 +32,56 @@
  * @since 7.0.0
  */
 interface IJob {
-	/**
-	 * Run the background job with the registered argument
-	 *
-	 * @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job
-	 * @param ILogger $logger
-	 * @since 7.0.0
-	 */
-	public function execute($jobList, ILogger $logger = null);
+    /**
+     * Run the background job with the registered argument
+     *
+     * @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job
+     * @param ILogger $logger
+     * @since 7.0.0
+     */
+    public function execute($jobList, ILogger $logger = null);
 
-	/**
-	 * @param int $id
-	 * @since 7.0.0
-	 */
-	public function setId($id);
+    /**
+     * @param int $id
+     * @since 7.0.0
+     */
+    public function setId($id);
 
-	/**
-	 * @param int $lastRun
-	 * @since 7.0.0
-	 */
-	public function setLastRun($lastRun);
+    /**
+     * @param int $lastRun
+     * @since 7.0.0
+     */
+    public function setLastRun($lastRun);
 
-	/**
-	 * @param mixed $argument
-	 * @since 7.0.0
-	 */
-	public function setArgument($argument);
+    /**
+     * @param mixed $argument
+     * @since 7.0.0
+     */
+    public function setArgument($argument);
 
-	/**
-	 * Get the id of the background job
-	 * This id is determined by the job list when a job is added to the list
-	 *
-	 * @return int
-	 * @since 7.0.0
-	 */
-	public function getId();
+    /**
+     * Get the id of the background job
+     * This id is determined by the job list when a job is added to the list
+     *
+     * @return int
+     * @since 7.0.0
+     */
+    public function getId();
 
-	/**
-	 * Get the last time this job was run as unix timestamp
-	 *
-	 * @return int
-	 * @since 7.0.0
-	 */
-	public function getLastRun();
+    /**
+     * Get the last time this job was run as unix timestamp
+     *
+     * @return int
+     * @since 7.0.0
+     */
+    public function getLastRun();
 
-	/**
-	 * Get the argument associated with the background job
-	 * This is the argument that will be passed to the background job
-	 *
-	 * @return mixed
-	 * @since 7.0.0
-	 */
-	public function getArgument();
+    /**
+     * Get the argument associated with the background job
+     * This is the argument that will be passed to the background job
+     *
+     * @return mixed
+     * @since 7.0.0
+     */
+    public function getArgument();
 }

lib/public/Settings/ISettings.php

Indentation +19 added lines, -19 removed lines

@@ -30,25 +30,25 @@
  */
 interface ISettings {
 
-	/**
-	 * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
-	 * @since 9.1
-	 */
-	public function getForm();
+    /**
+     * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
+     * @since 9.1
+     */
+    public function getForm();
 
-	/**
-	 * @return string the section ID, e.g. 'sharing'
-	 * @since 9.1
-	 */
-	public function getSection();
+    /**
+     * @return string the section ID, e.g. 'sharing'
+     * @since 9.1
+     */
+    public function getSection();
 
-	/**
-	 * @return int whether the form should be rather on the top or bottom of
-	 * the admin section. The forms are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 *
-	 * E.g.: 70
-	 * @since 9.1
-	 */
-	public function getPriority();
+    /**
+     * @return int whether the form should be rather on the top or bottom of
+     * the admin section. The forms are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     *
+     * E.g.: 70
+     * @since 9.1
+     */
+    public function getPriority();
 }

lib/public/Settings/ISection.php

Indentation +25 added lines, -25 removed lines

@@ -28,31 +28,31 @@
  * @since 9.1
  */
 interface ISection {
-	/**
-	 * returns the ID of the section. It is supposed to be a lower case string,
-	 * e.g. 'ldap'
-	 *
-	 * @returns string
-	 * @since 9.1
-	 */
-	public function getID();
+    /**
+     * returns the ID of the section. It is supposed to be a lower case string,
+     * e.g. 'ldap'
+     *
+     * @returns string
+     * @since 9.1
+     */
+    public function getID();
 
-	/**
-	 * returns the translated name as it should be displayed, e.g. 'LDAP / AD
-	 * integration'. Use the L10N service to translate it.
-	 *
-	 * @return string
-	 * @since 9.1
-	 */
-	public function getName();
+    /**
+     * returns the translated name as it should be displayed, e.g. 'LDAP / AD
+     * integration'. Use the L10N service to translate it.
+     *
+     * @return string
+     * @since 9.1
+     */
+    public function getName();
 
-	/**
-	 * @return int whether the form should be rather on the top or bottom of
-	 * the settings navigation. The sections are arranged in ascending order of
-	 * the priority values. It is required to return a value between 0 and 99.
-	 *
-	 * E.g.: 70
-	 * @since 9.1
-	 */
-	public function getPriority();
+    /**
+     * @return int whether the form should be rather on the top or bottom of
+     * the settings navigation. The sections are arranged in ascending order of
+     * the priority values. It is required to return a value between 0 and 99.
+     *
+     * E.g.: 70
+     * @since 9.1
+     */
+    public function getPriority();
 }

lib/public/Settings/IManager.php

Indentation +62 added lines, -62 removed lines

@@ -27,72 +27,72 @@
  * @since 9.1
  */
 interface IManager {
-	/**
-	 * @since 9.1.0
-	 */
-	const KEY_ADMIN_SETTINGS = 'admin';
+    /**
+     * @since 9.1.0
+     */
+    const KEY_ADMIN_SETTINGS = 'admin';
 
-	/**
-	 * @since 9.1.0
-	 */
-	const KEY_ADMIN_SECTION  = 'admin-section';
+    /**
+     * @since 9.1.0
+     */
+    const KEY_ADMIN_SECTION  = 'admin-section';
 
-	/**
-	 * sets up settings according to data specified by an apps info.xml, within
-	 * the <settings> element.
-	 *
-	 * @param array $settings an associative array, allowed keys are as specified
-	 *                        by the KEY_ constant of  this interface. The value
-	 *                        must always be a class name, implement either
-	 *                        IAdmin or ISection. I.e. only one section and admin
-	 *                        setting can be configured per app.
-	 * @since 9.1.0
-	 */
-	public function setupSettings(array $settings);
+    /**
+     * sets up settings according to data specified by an apps info.xml, within
+     * the <settings> element.
+     *
+     * @param array $settings an associative array, allowed keys are as specified
+     *                        by the KEY_ constant of  this interface. The value
+     *                        must always be a class name, implement either
+     *                        IAdmin or ISection. I.e. only one section and admin
+     *                        setting can be configured per app.
+     * @since 9.1.0
+     */
+    public function setupSettings(array $settings);
 
-	/**
-	 * attempts to remove an apps section and/or settings entry. A listener is
-	 * added centrally making sure that this method is called ones an app was
-	 * disabled.
-	 *
-	 * What this does not help with is when applications change their settings
-	 * or section classes during their life time. New entries will be added,
-	 * but inactive ones will still reside in the database.
-	 *
-	 * @param string $appId
-	 * @since 9.1.0
-	 */
-	public function onAppDisabled($appId);
+    /**
+     * attempts to remove an apps section and/or settings entry. A listener is
+     * added centrally making sure that this method is called ones an app was
+     * disabled.
+     *
+     * What this does not help with is when applications change their settings
+     * or section classes during their life time. New entries will be added,
+     * but inactive ones will still reside in the database.
+     *
+     * @param string $appId
+     * @since 9.1.0
+     */
+    public function onAppDisabled($appId);
 
-	/**
-	 * The method should check all registered classes whether they are still
-	 * instantiable and remove them, if not. This method is called by a
-	 * background job once, after one or more apps were updated.
-	 *
-	 * An app`s info.xml can change during an update and make it unknown whether
-	 * a registered class name was changed or not. An old one would just stay
-	 * registered. Another case is if an admin takes a radical approach and
-	 * simply removes an app from the app folder. These unregular checks will
-	 * take care of such situations.
-	 *
-	 * @since 9.1.0
-	 */
-	public function checkForOrphanedClassNames();
+    /**
+     * The method should check all registered classes whether they are still
+     * instantiable and remove them, if not. This method is called by a
+     * background job once, after one or more apps were updated.
+     *
+     * An app`s info.xml can change during an update and make it unknown whether
+     * a registered class name was changed or not. An old one would just stay
+     * registered. Another case is if an admin takes a radical approach and
+     * simply removes an app from the app folder. These unregular checks will
+     * take care of such situations.
+     *
+     * @since 9.1.0
+     */
+    public function checkForOrphanedClassNames();
 
-	/**
-	 * returns a list of the admin sections
-	 *
-	 * @return array array of ISection[] where key is the priority
-	 * @since 9.1.0
-	 */
-	public function getAdminSections();
+    /**
+     * returns a list of the admin sections
+     *
+     * @return array array of ISection[] where key is the priority
+     * @since 9.1.0
+     */
+    public function getAdminSections();
 
-	/**
-	 * returns a list of the admin settings
-	 *
-	 * @param string $section the section id for which to load the settings
-	 * @return array array of IAdmin[] where key is the priority
-	 * @since 9.1.0
-	 */
-	public function getAdminSettings($section);
+    /**
+     * returns a list of the admin settings
+     *
+     * @param string $section the section id for which to load the settings
+     * @return array array of IAdmin[] where key is the priority
+     * @since 9.1.0
+     */
+    public function getAdminSettings($section);
 }

Spacing +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
 	/**
 	 * @since 9.1.0
 	 */
-	const KEY_ADMIN_SECTION  = 'admin-section';
+	const KEY_ADMIN_SECTION = 'admin-section';
 
 	/**
 	 * sets up settings according to data specified by an apps info.xml, within

lib/public/Share_Backend.php

Indentation +57 added lines, -57 removed lines

@@ -33,65 +33,65 @@
  */
 interface Share_Backend {
 
-	/**
-	 * Check if this $itemSource exist for the user
-	 * @param string $itemSource
-	 * @param string $uidOwner Owner of the item
-	 * @return boolean|null Source
-	 *
-	 * Return false if the item does not exist for the user
-	 * @since 5.0.0
-	 */
-	public function isValidSource($itemSource, $uidOwner);
+    /**
+     * Check if this $itemSource exist for the user
+     * @param string $itemSource
+     * @param string $uidOwner Owner of the item
+     * @return boolean|null Source
+     *
+     * Return false if the item does not exist for the user
+     * @since 5.0.0
+     */
+    public function isValidSource($itemSource, $uidOwner);
 
-	/**
-	 * Get a unique name of the item for the specified user
-	 * @param string $itemSource
-	 * @param string|false $shareWith User the item is being shared with
-	 * @param array|null $exclude List of similar item names already existing as shared items @deprecated since version OC7
-	 * @return string Target name
-	 *
-	 * This function needs to verify that the user does not already have an item with this name.
-	 * If it does generate a new name e.g. name_#
-	 * @since 5.0.0
-	 */
-	public function generateTarget($itemSource, $shareWith, $exclude = null);
+    /**
+     * Get a unique name of the item for the specified user
+     * @param string $itemSource
+     * @param string|false $shareWith User the item is being shared with
+     * @param array|null $exclude List of similar item names already existing as shared items @deprecated since version OC7
+     * @return string Target name
+     *
+     * This function needs to verify that the user does not already have an item with this name.
+     * If it does generate a new name e.g. name_#
+     * @since 5.0.0
+     */
+    public function generateTarget($itemSource, $shareWith, $exclude = null);
 
-	/**
-	 * Converts the shared item sources back into the item in the specified format
-	 * @param array $items Shared items
-	 * @param int $format
-	 * @return array
-	 *
-	 * The items array is a 3-dimensional array with the item_source as the
-	 * first key and the share id as the second key to an array with the share
-	 * info.
-	 *
-	 * The key/value pairs included in the share info depend on the function originally called:
-	 * If called by getItem(s)Shared: id, item_type, item, item_source,
-	 * share_type, share_with, permissions, stime, file_source
-	 *
-	 * If called by getItem(s)SharedWith: id, item_type, item, item_source,
-	 * item_target, share_type, share_with, permissions, stime, file_source,
-	 * file_target
-	 *
-	 * This function allows the backend to control the output of shared items with custom formats.
-	 * It is only called through calls to the public getItem(s)Shared(With) functions.
-	 * @since 5.0.0
-	 */
-	public function formatItems($items, $format, $parameters = null);
+    /**
+     * Converts the shared item sources back into the item in the specified format
+     * @param array $items Shared items
+     * @param int $format
+     * @return array
+     *
+     * The items array is a 3-dimensional array with the item_source as the
+     * first key and the share id as the second key to an array with the share
+     * info.
+     *
+     * The key/value pairs included in the share info depend on the function originally called:
+     * If called by getItem(s)Shared: id, item_type, item, item_source,
+     * share_type, share_with, permissions, stime, file_source
+     *
+     * If called by getItem(s)SharedWith: id, item_type, item, item_source,
+     * item_target, share_type, share_with, permissions, stime, file_source,
+     * file_target
+     *
+     * This function allows the backend to control the output of shared items with custom formats.
+     * It is only called through calls to the public getItem(s)Shared(With) functions.
+     * @since 5.0.0
+     */
+    public function formatItems($items, $format, $parameters = null);
 
-	/**
-	 * Check if a given share type is allowd by the back-end
-	 *
-	 * @param int $shareType share type
-	 * @return boolean
-	 *
-	 * The back-end can enable/disable specific share types. Just return true if
-	 * the back-end doesn't provide any specific settings for it and want to allow
-	 * all share types defined by the share API
-	 * @since 8.0.0
-	 */
-	public function isShareTypeAllowed($shareType);
+    /**
+     * Check if a given share type is allowd by the back-end
+     *
+     * @param int $shareType share type
+     * @return boolean
+     *
+     * The back-end can enable/disable specific share types. Just return true if
+     * the back-end doesn't provide any specific settings for it and want to allow
+     * all share types defined by the share API
+     * @since 8.0.0
+     */
+    public function isShareTypeAllowed($shareType);
 
 }

lib/public/ILogger.php

Indentation +100 added lines, -100 removed lines

@@ -33,113 +33,113 @@
  * https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#3-psrlogloggerinterface
  */
 interface ILogger {
-	/**
-	 * System is unusable.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function emergency($message, array $context = array());
+    /**
+     * System is unusable.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function emergency($message, array $context = array());
 
-	/**
-	 * Action must be taken immediately.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function alert($message, array $context = array());
+    /**
+     * Action must be taken immediately.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function alert($message, array $context = array());
 
-	/**
-	 * Critical conditions.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function critical($message, array $context = array());
+    /**
+     * Critical conditions.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function critical($message, array $context = array());
 
-	/**
-	 * Runtime errors that do not require immediate action but should typically
-	 * be logged and monitored.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function error($message, array $context = array());
+    /**
+     * Runtime errors that do not require immediate action but should typically
+     * be logged and monitored.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function error($message, array $context = array());
 
-	/**
-	 * Exceptional occurrences that are not errors.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function warning($message, array $context = array());
+    /**
+     * Exceptional occurrences that are not errors.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function warning($message, array $context = array());
 
-	/**
-	 * Normal but significant events.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function notice($message, array $context = array());
+    /**
+     * Normal but significant events.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function notice($message, array $context = array());
 
-	/**
-	 * Interesting events.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function info($message, array $context = array());
+    /**
+     * Interesting events.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function info($message, array $context = array());
 
-	/**
-	 * Detailed debug information.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return null
-	 * @since 7.0.0
-	 */
-	public function debug($message, array $context = array());
+    /**
+     * Detailed debug information.
+     *
+     * @param string $message
+     * @param array $context
+     * @return null
+     * @since 7.0.0
+     */
+    public function debug($message, array $context = array());
 
-	/**
-	 * Logs with an arbitrary level.
-	 *
-	 * @param mixed $level
-	 * @param string $message
-	 * @param array $context
-	 * @return mixed
-	 * @since 7.0.0
-	 */
-	public function log($level, $message, array $context = array());
+    /**
+     * Logs with an arbitrary level.
+     *
+     * @param mixed $level
+     * @param string $message
+     * @param array $context
+     * @return mixed
+     * @since 7.0.0
+     */
+    public function log($level, $message, array $context = array());
 
-	/**
-	 * Logs an exception very detailed
-	 * An additional message can we written to the log by adding it to the
-	 * context.
-	 *
-	 * <code>
-	 * $logger->logException($ex, [
-	 *     'message' => 'Exception during cron job execution'
-	 * ]);
-	 * </code>
-	 *
-	 * @param \Exception | \Throwable $exception
-	 * @param array $context
-	 * @return void
-	 * @since 8.2.0
-	 */
-	public function logException($exception, array $context = array());
+    /**
+     * Logs an exception very detailed
+     * An additional message can we written to the log by adding it to the
+     * context.
+     *
+     * <code>
+     * $logger->logException($ex, [
+     *     'message' => 'Exception during cron job execution'
+     * ]);
+     * </code>
+     *
+     * @param \Exception | \Throwable $exception
+     * @param array $context
+     * @return void
+     * @since 8.2.0
+     */
+    public function logException($exception, array $context = array());
 }

lib/public/ICacheFactory.php

Indentation +17 added lines, -17 removed lines

@@ -30,22 +30,22 @@
  * @since 7.0.0
  */
 interface ICacheFactory{
-	/**
-	 * Get a memory cache instance
-	 *
-	 * All entries added trough the cache instance will be namespaced by $prefix to prevent collisions between apps
-	 *
-	 * @param string $prefix
-	 * @return \OCP\ICache
-	 * @since 7.0.0
-	 */
-	public function create($prefix = '');
+    /**
+     * Get a memory cache instance
+     *
+     * All entries added trough the cache instance will be namespaced by $prefix to prevent collisions between apps
+     *
+     * @param string $prefix
+     * @return \OCP\ICache
+     * @since 7.0.0
+     */
+    public function create($prefix = '');
 
-	/**
-	 * Check if any memory cache backend is available
-	 *
-	 * @return bool
-	 * @since 7.0.0
-	 */
-	public function isAvailable();
+    /**
+     * Check if any memory cache backend is available
+     *
+     * @return bool
+     * @since 7.0.0
+     */
+    public function isAvailable();
 }

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
  * @package OCP
  * @since 7.0.0
  */
-interface ICacheFactory{
+interface ICacheFactory {
 	/**
 	 * Get a memory cache instance
 	 *

lib/public/ISession.php

Indentation +57 added lines, -57 removed lines

@@ -42,68 +42,68 @@
  */
 interface ISession {
 
-	/**
-	 * Set a value in the session
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @since 6.0.0
-	 */
-	public function set($key, $value);
+    /**
+     * Set a value in the session
+     *
+     * @param string $key
+     * @param mixed $value
+     * @since 6.0.0
+     */
+    public function set($key, $value);
 
-	/**
-	 * Get a value from the session
-	 *
-	 * @param string $key
-	 * @return mixed should return null if $key does not exist
-	 * @since 6.0.0
-	 */
-	public function get($key);
+    /**
+     * Get a value from the session
+     *
+     * @param string $key
+     * @return mixed should return null if $key does not exist
+     * @since 6.0.0
+     */
+    public function get($key);
 
-	/**
-	 * Check if a named key exists in the session
-	 *
-	 * @param string $key
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function exists($key);
+    /**
+     * Check if a named key exists in the session
+     *
+     * @param string $key
+     * @return bool
+     * @since 6.0.0
+     */
+    public function exists($key);
 
-	/**
-	 * Remove a $key/$value pair from the session
-	 *
-	 * @param string $key
-	 * @since 6.0.0
-	 */
-	public function remove($key);
+    /**
+     * Remove a $key/$value pair from the session
+     *
+     * @param string $key
+     * @since 6.0.0
+     */
+    public function remove($key);
 
-	/**
-	 * Reset and recreate the session
-	 * @since 6.0.0
-	 */
-	public function clear();
+    /**
+     * Reset and recreate the session
+     * @since 6.0.0
+     */
+    public function clear();
 
-	/**
-	 * Close the session and release the lock
-	 * @since 7.0.0
-	 */
-	public function close();
+    /**
+     * Close the session and release the lock
+     * @since 7.0.0
+     */
+    public function close();
 
-	/**
-	 * Wrapper around session_regenerate_id
-	 *
-	 * @param bool $deleteOldSession Whether to delete the old associated session file or not.
-	 * @return void
-	 * @since 9.0.0
-	 */
-	public function regenerateId($deleteOldSession = true);
+    /**
+     * Wrapper around session_regenerate_id
+     *
+     * @param bool $deleteOldSession Whether to delete the old associated session file or not.
+     * @return void
+     * @since 9.0.0
+     */
+    public function regenerateId($deleteOldSession = true);
 
-	/**
-	 * Wrapper around session_id
-	 *
-	 * @return string
-	 * @throws SessionNotAvailableException
-	 * @since 9.1.0
-	 */
-	public function getId();
+    /**
+     * Wrapper around session_id
+     *
+     * @return string
+     * @throws SessionNotAvailableException
+     * @since 9.1.0
+     */
+    public function getId();
 }