nextcloud / server

lib/public/Search/Provider.php

Indentation +51 added lines, -51 removed lines

@@ -32,60 +32,60 @@
  */
 abstract class Provider {
 
-	/**
-	 * @since 8.0.0
-	 */
-	const OPTION_APPS = 'apps';
+    /**
+     * @since 8.0.0
+     */
+    const OPTION_APPS = 'apps';
 
-	/**
-	 * List of options
-	 * @var array
-	 * @since 7.0.0
-	 */
-	protected $options;
+    /**
+     * List of options
+     * @var array
+     * @since 7.0.0
+     */
+    protected $options;
 
-	/**
-	 * Constructor
-	 * @param array $options as key => value
-	 * @since 7.0.0 - default value for $options was added in 8.0.0
-	 */
-	public function __construct($options = array()) {
-		$this->options = $options;
-	}
+    /**
+     * Constructor
+     * @param array $options as key => value
+     * @since 7.0.0 - default value for $options was added in 8.0.0
+     */
+    public function __construct($options = array()) {
+        $this->options = $options;
+    }
 
-	/**
-	 * get a value from the options array or null
-	 * @param string $key
-	 * @return mixed
-	 * @since 8.0.0
-	 */
-	public function getOption($key) {
-		if (is_array($this->options) && isset($this->options[$key])) {
-			return $this->options[$key];
-		} else {
-			return null;
-		}
-	}
+    /**
+     * get a value from the options array or null
+     * @param string $key
+     * @return mixed
+     * @since 8.0.0
+     */
+    public function getOption($key) {
+        if (is_array($this->options) && isset($this->options[$key])) {
+            return $this->options[$key];
+        } else {
+            return null;
+        }
+    }
 
-	/**
-	 * checks if the given apps and the apps this provider has results for intersect
-	 * returns true if the given array is empty (all apps)
-	 * or if this provider does not have a list of apps it provides results for (legacy search providers)
-	 * or if the two above arrays have elements in common (intersect)
-	 * @param string[] $apps
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function providesResultsFor(array $apps = array()) {
-		$forApps = $this->getOption(self::OPTION_APPS);
-		return empty($apps) || empty($forApps) || array_intersect($forApps, $apps);
-	}
+    /**
+     * checks if the given apps and the apps this provider has results for intersect
+     * returns true if the given array is empty (all apps)
+     * or if this provider does not have a list of apps it provides results for (legacy search providers)
+     * or if the two above arrays have elements in common (intersect)
+     * @param string[] $apps
+     * @return bool
+     * @since 8.0.0
+     */
+    public function providesResultsFor(array $apps = array()) {
+        $forApps = $this->getOption(self::OPTION_APPS);
+        return empty($apps) || empty($forApps) || array_intersect($forApps, $apps);
+    }
 
-	/**
-	 * Search for $query
-	 * @param string $query
-	 * @return array An array of OCP\Search\Result's
-	 * @since 7.0.0
-	 */
-	abstract public function search($query);
+    /**
+     * Search for $query
+     * @param string $query
+     * @return array An array of OCP\Search\Result's
+     * @since 7.0.0
+     */
+    abstract public function search($query);
 }

lib/public/Search/Result.php

Indentation +39 added lines, -39 removed lines

@@ -31,47 +31,47 @@
  */
 class Result {
 
-	/**
-	 * A unique identifier for the result, usually given as the item ID in its
-	 * corresponding application.
-	 * @var string
-	 * @since 7.0.0
-	 */
-	public $id;
+    /**
+     * A unique identifier for the result, usually given as the item ID in its
+     * corresponding application.
+     * @var string
+     * @since 7.0.0
+     */
+    public $id;
 
-	/**
-	 * The name of the item returned; this will be displayed in the search
-	 * results.
-	 * @var string
-	 * @since 7.0.0
-	 */
-	public $name;
+    /**
+     * The name of the item returned; this will be displayed in the search
+     * results.
+     * @var string
+     * @since 7.0.0
+     */
+    public $name;
 
-	/**
-	 * URL to the application item.
-	 * @var string
-	 * @since 7.0.0
-	 */
-	public $link;
+    /**
+     * URL to the application item.
+     * @var string
+     * @since 7.0.0
+     */
+    public $link;
 
-	/**
-	 * The type of search result returned; for consistency, name this the same
-	 * as the class name (e.g. \OC\Search\File -> 'file') in lowercase. 
-	 * @var string
-	 * @since 7.0.0
-	 */
-	public $type = 'generic';
+    /**
+     * The type of search result returned; for consistency, name this the same
+     * as the class name (e.g. \OC\Search\File -> 'file') in lowercase. 
+     * @var string
+     * @since 7.0.0
+     */
+    public $type = 'generic';
 
-	/**
-	 * Create a new search result
-	 * @param string $id unique identifier from application: '[app_name]/[item_identifier_in_app]'
-	 * @param string $name displayed text of result
-	 * @param string $link URL to the result within its app
-	 * @since 7.0.0
-	 */
-	public function __construct($id = null, $name = null, $link = null) {
-		$this->id = $id;
-		$this->name = $name;
-		$this->link = $link;
-	}
+    /**
+     * Create a new search result
+     * @param string $id unique identifier from application: '[app_name]/[item_identifier_in_app]'
+     * @param string $name displayed text of result
+     * @param string $link URL to the result within its app
+     * @since 7.0.0
+     */
+    public function __construct($id = null, $name = null, $link = null) {
+        $this->id = $id;
+        $this->name = $name;
+        $this->link = $link;
+    }
 }

lib/public/Search/PagedProvider.php

Indentation +32 added lines, -32 removed lines

@@ -30,39 +30,39 @@
  */
 abstract class PagedProvider extends Provider {
 
-	/**
-	 * show all results
-	 * @since 8.0.0
-	 */
-	const SIZE_ALL = 0;
+    /**
+     * show all results
+     * @since 8.0.0
+     */
+    const SIZE_ALL = 0;
 
-	/**
-	 * Constructor
-	 * @param array $options
-	 * @since 8.0.0
-	 */
-	public function __construct($options) {
-		$this->options = $options;
-	}
+    /**
+     * Constructor
+     * @param array $options
+     * @since 8.0.0
+     */
+    public function __construct($options) {
+        $this->options = $options;
+    }
 
-	/**
-	 * Search for $query
-	 * @param string $query
-	 * @return array An array of OCP\Search\Result's
-	 * @since 8.0.0
-	 */
-	public function search($query) {
-		// old apps might assume they get all results, so we use SIZE_ALL
-		$this->searchPaged($query, 1, self::SIZE_ALL);
-	}
+    /**
+     * Search for $query
+     * @param string $query
+     * @return array An array of OCP\Search\Result's
+     * @since 8.0.0
+     */
+    public function search($query) {
+        // old apps might assume they get all results, so we use SIZE_ALL
+        $this->searchPaged($query, 1, self::SIZE_ALL);
+    }
 
-	/**
-	 * Search for $query
-	 * @param string $query
-	 * @param int $page pages start at page 1
-	 * @param int $size 0 = SIZE_ALL
-	 * @return array An array of OCP\Search\Result's
-	 * @since 8.0.0
-	 */
-	abstract public function searchPaged($query, $page, $size);
+    /**
+     * Search for $query
+     * @param string $query
+     * @param int $page pages start at page 1
+     * @param int $size 0 = SIZE_ALL
+     * @return array An array of OCP\Search\Result's
+     * @since 8.0.0
+     */
+    abstract public function searchPaged($query, $page, $size);
 }

lib/public/Share_Backend_Collection.php

Indentation +7 added lines, -7 removed lines

@@ -31,11 +31,11 @@
  * @since 5.0.0
  */
 interface Share_Backend_Collection extends Share_Backend {
-	/**
-	 * Get the sources of the children of the item
-	 * @param string $itemSource
-	 * @return array Returns an array of children each inside an array with the keys: source, target, and file_path if applicable
-	 * @since 5.0.0
-	 */
-	public function getChildren($itemSource);
+    /**
+     * Get the sources of the children of the item
+     * @param string $itemSource
+     * @return array Returns an array of children each inside an array with the keys: source, target, and file_path if applicable
+     * @since 5.0.0
+     */
+    public function getChildren($itemSource);
 }

lib/public/AppFramework/Utility/ITimeFactory.php

Indentation +5 added lines, -5 removed lines

@@ -31,10 +31,10 @@
  */
 interface ITimeFactory {
 
-	/**
-	 * @return int the result of a call to time()
-	 * @since 8.0.0
-	 */
-	public function getTime();
+    /**
+     * @return int the result of a call to time()
+     * @since 8.0.0
+     */
+    public function getTime();
 
 }

lib/public/AppFramework/Utility/IControllerMethodReflector.php

Indentation +30 added lines, -30 removed lines

@@ -34,38 +34,38 @@
  */
 interface IControllerMethodReflector {
 
-	/**
-	 * @param object $object an object or classname
-	 * @param string $method the method which we want to inspect
-	 * @return void
-	 * @since 8.0.0
-	 */
-	public function reflect($object, $method);
+    /**
+     * @param object $object an object or classname
+     * @param string $method the method which we want to inspect
+     * @return void
+     * @since 8.0.0
+     */
+    public function reflect($object, $method);
 
-	/**
-	 * Inspects the PHPDoc parameters for types
-	 *
-	 * @param string $parameter the parameter whose type comments should be
-	 * parsed
-	 * @return string|null type in the type parameters (@param int $something)
-	 * would return int or null if not existing
-	 * @since 8.0.0
-	 */
-	public function getType($parameter);
+    /**
+     * Inspects the PHPDoc parameters for types
+     *
+     * @param string $parameter the parameter whose type comments should be
+     * parsed
+     * @return string|null type in the type parameters (@param int $something)
+     * would return int or null if not existing
+     * @since 8.0.0
+     */
+    public function getType($parameter);
 
-	/**
-	 * @return array the arguments of the method with key => default value
-	 * @since 8.0.0
-	 */
-	public function getParameters();
+    /**
+     * @return array the arguments of the method with key => default value
+     * @since 8.0.0
+     */
+    public function getParameters();
 
-	/**
-	 * Check if a method contains an annotation
-	 *
-	 * @param string $name the name of the annotation
-	 * @return bool true if the annotation is found
-	 * @since 8.0.0
-	 */
-	public function hasAnnotation($name);
+    /**
+     * Check if a method contains an annotation
+     *
+     * @param string $name the name of the annotation
+     * @return bool true if the annotation is found
+     * @since 8.0.0
+     */
+    public function hasAnnotation($name);
 
 }

lib/public/AppFramework/OCSController.php

Indentation +64 added lines, -64 removed lines

@@ -42,73 +42,73 @@
  */
 abstract class OCSController extends ApiController {
 
-	/** @var int */
-	private $ocsVersion;
+    /** @var int */
+    private $ocsVersion;
 
-	/**
-	 * constructor of the controller
-	 * @param string $appName the name of the app
-	 * @param IRequest $request an instance of the request
-	 * @param string $corsMethods comma separated string of HTTP verbs which
-	 * should be allowed for websites or webapps when calling your API, defaults to
-	 * 'PUT, POST, GET, DELETE, PATCH'
-	 * @param string $corsAllowedHeaders comma separated string of HTTP headers
-	 * which should be allowed for websites or webapps when calling your API,
-	 * defaults to 'Authorization, Content-Type, Accept'
-	 * @param int $corsMaxAge number in seconds how long a preflighted OPTIONS
-	 * request should be cached, defaults to 1728000 seconds
-	 * @since 8.1.0
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								$corsMethods='PUT, POST, GET, DELETE, PATCH',
-								$corsAllowedHeaders='Authorization, Content-Type, Accept',
-								$corsMaxAge=1728000){
-		parent::__construct($appName, $request, $corsMethods,
-							$corsAllowedHeaders, $corsMaxAge);
-		$this->registerResponder('json', function ($data) {
-			return $this->buildOCSResponse('json', $data);
-		});
-		$this->registerResponder('xml', function ($data) {
-			return $this->buildOCSResponse('xml', $data);
-		});
-	}
+    /**
+     * constructor of the controller
+     * @param string $appName the name of the app
+     * @param IRequest $request an instance of the request
+     * @param string $corsMethods comma separated string of HTTP verbs which
+     * should be allowed for websites or webapps when calling your API, defaults to
+     * 'PUT, POST, GET, DELETE, PATCH'
+     * @param string $corsAllowedHeaders comma separated string of HTTP headers
+     * which should be allowed for websites or webapps when calling your API,
+     * defaults to 'Authorization, Content-Type, Accept'
+     * @param int $corsMaxAge number in seconds how long a preflighted OPTIONS
+     * request should be cached, defaults to 1728000 seconds
+     * @since 8.1.0
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                $corsMethods='PUT, POST, GET, DELETE, PATCH',
+                                $corsAllowedHeaders='Authorization, Content-Type, Accept',
+                                $corsMaxAge=1728000){
+        parent::__construct($appName, $request, $corsMethods,
+                            $corsAllowedHeaders, $corsMaxAge);
+        $this->registerResponder('json', function ($data) {
+            return $this->buildOCSResponse('json', $data);
+        });
+        $this->registerResponder('xml', function ($data) {
+            return $this->buildOCSResponse('xml', $data);
+        });
+    }
 
-	/**
-	 * @param int $version
-	 * @since 11.0.0
-	 * @internal
-	 */
-	public function setOCSVersion($version) {
-		$this->ocsVersion = $version;
-	}
+    /**
+     * @param int $version
+     * @since 11.0.0
+     * @internal
+     */
+    public function setOCSVersion($version) {
+        $this->ocsVersion = $version;
+    }
 
-	/**
-	 * Since the OCS endpoints default to XML we need to find out the format
-	 * again
-	 * @param mixed $response the value that was returned from a controller and
-	 * is not a Response instance
-	 * @param string $format the format for which a formatter has been registered
-	 * @throws \DomainException if format does not match a registered formatter
-	 * @return Response
-	 * @since 9.1.0
-	 */
-	public function buildResponse($response, $format = 'xml') {
-		return parent::buildResponse($response, $format);
-	}
+    /**
+     * Since the OCS endpoints default to XML we need to find out the format
+     * again
+     * @param mixed $response the value that was returned from a controller and
+     * is not a Response instance
+     * @param string $format the format for which a formatter has been registered
+     * @throws \DomainException if format does not match a registered formatter
+     * @return Response
+     * @since 9.1.0
+     */
+    public function buildResponse($response, $format = 'xml') {
+        return parent::buildResponse($response, $format);
+    }
 
-	/**
-	 * Unwrap data and build ocs response
-	 * @param string $format json or xml
-	 * @param DataResponse $data the data which should be transformed
-	 * @since 8.1.0
-	 * @return \OC\AppFramework\OCS\BaseResponse
-	 */
-	private function buildOCSResponse($format, DataResponse $data) {
-		if ($this->ocsVersion === 1) {
-			return new \OC\AppFramework\OCS\V1Response($data, $format);
-		}
-		return new \OC\AppFramework\OCS\V2Response($data, $format);
-	}
+    /**
+     * Unwrap data and build ocs response
+     * @param string $format json or xml
+     * @param DataResponse $data the data which should be transformed
+     * @since 8.1.0
+     * @return \OC\AppFramework\OCS\BaseResponse
+     */
+    private function buildOCSResponse($format, DataResponse $data) {
+        if ($this->ocsVersion === 1) {
+            return new \OC\AppFramework\OCS\V1Response($data, $format);
+        }
+        return new \OC\AppFramework\OCS\V2Response($data, $format);
+    }
 
 }

lib/public/AppFramework/Http/OCSResponse.php

Indentation +48 added lines, -48 removed lines

@@ -36,58 +36,58 @@
  */
 class OCSResponse extends Response {
 
-	private $data;
-	private $format;
-	private $statuscode;
-	private $message;
-	private $itemscount;
-	private $itemsperpage;
+    private $data;
+    private $format;
+    private $statuscode;
+    private $message;
+    private $itemscount;
+    private $itemsperpage;
 
-	/**
-	 * generates the xml or json response for the API call from an multidimenional data array.
-	 * @param string $format
-	 * @param int $statuscode
-	 * @param string $message
-	 * @param array $data
-	 * @param int|string $itemscount
-	 * @param int|string $itemsperpage
-	 * @since 8.1.0
-	 * @deprecated 9.2.0 To implement an OCS endpoint extend the OCSController
-	 */
-	public function __construct($format, $statuscode, $message,
-								$data=[], $itemscount='',
-								$itemsperpage='') {
-		$this->format = $format;
-		$this->statuscode = $statuscode;
-		$this->message = $message;
-		$this->data = $data;
-		$this->itemscount = $itemscount;
-		$this->itemsperpage = $itemsperpage;
+    /**
+     * generates the xml or json response for the API call from an multidimenional data array.
+     * @param string $format
+     * @param int $statuscode
+     * @param string $message
+     * @param array $data
+     * @param int|string $itemscount
+     * @param int|string $itemsperpage
+     * @since 8.1.0
+     * @deprecated 9.2.0 To implement an OCS endpoint extend the OCSController
+     */
+    public function __construct($format, $statuscode, $message,
+                                $data=[], $itemscount='',
+                                $itemsperpage='') {
+        $this->format = $format;
+        $this->statuscode = $statuscode;
+        $this->message = $message;
+        $this->data = $data;
+        $this->itemscount = $itemscount;
+        $this->itemsperpage = $itemsperpage;
 
-		// set the correct header based on the format parameter
-		if ($format === 'json') {
-			$this->addHeader(
-				'Content-Type', 'application/json; charset=utf-8'
-			);
-		} else {
-			$this->addHeader(
-				'Content-Type', 'application/xml; charset=utf-8'
-			);
-		}
-	}
+        // set the correct header based on the format parameter
+        if ($format === 'json') {
+            $this->addHeader(
+                'Content-Type', 'application/json; charset=utf-8'
+            );
+        } else {
+            $this->addHeader(
+                'Content-Type', 'application/xml; charset=utf-8'
+            );
+        }
+    }
 
-	/**
-	 * @return string
-	 * @since 8.1.0
-	 * @deprecated 9.2.0 To implement an OCS endpoint extend the OCSController
-	 */
-	public function render() {
-		$r = new \OC_OCS_Result($this->data, $this->statuscode, $this->message);
-		$r->setTotalItems($this->itemscount);
-		$r->setItemsPerPage($this->itemsperpage);
+    /**
+     * @return string
+     * @since 8.1.0
+     * @deprecated 9.2.0 To implement an OCS endpoint extend the OCSController
+     */
+    public function render() {
+        $r = new \OC_OCS_Result($this->data, $this->statuscode, $this->message);
+        $r->setTotalItems($this->itemscount);
+        $r->setItemsPerPage($this->itemsperpage);
 
-		return \OC_API::renderResult($this->format, $r->getMeta(), $r->getData());
-	}
+        return \OC_API::renderResult($this->format, $r->getMeta(), $r->getData());
+    }
 
 
 }

lib/public/AppFramework/Http/RedirectResponse.php

Indentation +21 added lines, -21 removed lines

@@ -36,27 +36,27 @@
  */
 class RedirectResponse extends Response {
 
-	private $redirectURL;
-
-	/**
-	 * Creates a response that redirects to a url
-	 * @param string $redirectURL the url to redirect to
-	 * @since 7.0.0
-	 */
-	public function __construct($redirectURL) {
-		$this->redirectURL = $redirectURL;
-		$this->setStatus(Http::STATUS_SEE_OTHER);
-		$this->addHeader('Location', $redirectURL);
-	}
-
-
-	/**
-	 * @return string the url to redirect
-	 * @since 7.0.0
-	 */
-	public function getRedirectURL() {
-		return $this->redirectURL;
-	}
+    private $redirectURL;
+
+    /**
+     * Creates a response that redirects to a url
+     * @param string $redirectURL the url to redirect to
+     * @since 7.0.0
+     */
+    public function __construct($redirectURL) {
+        $this->redirectURL = $redirectURL;
+        $this->setStatus(Http::STATUS_SEE_OTHER);
+        $this->addHeader('Location', $redirectURL);
+    }
+
+
+    /**
+     * @return string the url to redirect
+     * @since 7.0.0
+     */
+    public function getRedirectURL() {
+        return $this->redirectURL;
+    }
 
 
 }