nextcloud / server

lib/public/JSON.php

Indentation +145 added lines, -145 removed lines

@@ -40,158 +40,158 @@
  * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
  */
 class JSON {
-	/**
-	 * Encode and print $data in JSON format
-	 * @param array $data The data to use
-	 * @param bool $setContentType the optional content type
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function encodedPrint( $data, $setContentType=true ) {
-		\OC_JSON::encodedPrint($data, $setContentType);
-	}
+    /**
+     * Encode and print $data in JSON format
+     * @param array $data The data to use
+     * @param bool $setContentType the optional content type
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function encodedPrint( $data, $setContentType=true ) {
+        \OC_JSON::encodedPrint($data, $setContentType);
+    }
 
-	/**
-	 * Check if the user is logged in, send json error msg if not.
-	 *
-	 * This method checks if a user is logged in. If not, a json error
-	 * response will be return and the method will exit from execution
-	 * of the script.
-	 * The returned json will be in the format:
-	 *
-	 *     {"status":"error","data":{"message":"Authentication error."}}
-	 *
-	 * Add this call to the start of all ajax method files that requires
-	 * an authenticated user.
-	 * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
-	 */
-	public static function checkLoggedIn() {
-		\OC_JSON::checkLoggedIn();
-	}
+    /**
+     * Check if the user is logged in, send json error msg if not.
+     *
+     * This method checks if a user is logged in. If not, a json error
+     * response will be return and the method will exit from execution
+     * of the script.
+     * The returned json will be in the format:
+     *
+     *     {"status":"error","data":{"message":"Authentication error."}}
+     *
+     * Add this call to the start of all ajax method files that requires
+     * an authenticated user.
+     * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
+     */
+    public static function checkLoggedIn() {
+        \OC_JSON::checkLoggedIn();
+    }
 
-	/**
-	 * Check an ajax get/post call if the request token is valid.
-	 *
-	 * This method checks for a valid variable 'requesttoken' in $_GET,
-	 * $_POST and $_SERVER. If a valid token is not found, a json error
-	 * response will be return and the method will exit from execution
-	 * of the script.
-	 * The returned json will be in the format:
-	 *
-	 *     {"status":"error","data":{"message":"Token expired. Please reload page."}}
-	 *
-	 * Add this call to the start of all ajax method files that creates,
-	 * updates or deletes anything.
-	 * In cases where you e.g. use an ajax call to load a dialog containing
-	 * a submittable form, you will need to add the requesttoken first as a
-	 * parameter to the ajax call, then assign it to the template and finally
-	 * add a hidden input field also named 'requesttoken' containing the value.
-	 * @deprecated 8.1.0 Use annotation based CSRF checks from the AppFramework instead
-	 */
-	public static function callCheck() {
-		\OC_JSON::callCheck();
-	}
+    /**
+     * Check an ajax get/post call if the request token is valid.
+     *
+     * This method checks for a valid variable 'requesttoken' in $_GET,
+     * $_POST and $_SERVER. If a valid token is not found, a json error
+     * response will be return and the method will exit from execution
+     * of the script.
+     * The returned json will be in the format:
+     *
+     *     {"status":"error","data":{"message":"Token expired. Please reload page."}}
+     *
+     * Add this call to the start of all ajax method files that creates,
+     * updates or deletes anything.
+     * In cases where you e.g. use an ajax call to load a dialog containing
+     * a submittable form, you will need to add the requesttoken first as a
+     * parameter to the ajax call, then assign it to the template and finally
+     * add a hidden input field also named 'requesttoken' containing the value.
+     * @deprecated 8.1.0 Use annotation based CSRF checks from the AppFramework instead
+     */
+    public static function callCheck() {
+        \OC_JSON::callCheck();
+    }
 
-	/**
-	 * Send json success msg
-	 *
-	 * Return a json success message with optional extra data.
-	 * @see OCP\JSON::error()		for the format to use.
-	 *
-	 * @param array $data The data to use
-	 * @return string json formatted string.
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function success( $data = array() ) {
-		\OC_JSON::success($data);
-	}
+    /**
+     * Send json success msg
+     *
+     * Return a json success message with optional extra data.
+     * @see OCP\JSON::error()		for the format to use.
+     *
+     * @param array $data The data to use
+     * @return string json formatted string.
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function success( $data = array() ) {
+        \OC_JSON::success($data);
+    }
 
-	/**
-	 * Send json error msg
-	 *
-	 * Return a json error message with optional extra data for
-	 * error message or app specific data.
-	 *
-	 * Example use:
-	 *
-	 *     $id = [some value]
-	 *     OCP\JSON::error(array('data':array('message':'An error happened', 'id': $id)));
-	 *
-	 * Will return the json formatted string:
-	 *
-	 *     {"status":"error","data":{"message":"An error happened", "id":[some value]}}
-	 *
-	 * @param array $data The data to use
-	 * @return string json formatted error string.
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function error( $data = array() ) {
-		\OC_JSON::error( $data );
-	}
+    /**
+     * Send json error msg
+     *
+     * Return a json error message with optional extra data for
+     * error message or app specific data.
+     *
+     * Example use:
+     *
+     *     $id = [some value]
+     *     OCP\JSON::error(array('data':array('message':'An error happened', 'id': $id)));
+     *
+     * Will return the json formatted string:
+     *
+     *     {"status":"error","data":{"message":"An error happened", "id":[some value]}}
+     *
+     * @param array $data The data to use
+     * @return string json formatted error string.
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function error( $data = array() ) {
+        \OC_JSON::error( $data );
+    }
 
-	/**
-	 * Set Content-Type header to jsonrequest
-	 * @param string $type The content type header
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function setContentTypeHeader( $type='application/json' ) {
-		\OC_JSON::setContentTypeHeader($type);
-	}
+    /**
+     * Set Content-Type header to jsonrequest
+     * @param string $type The content type header
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function setContentTypeHeader( $type='application/json' ) {
+        \OC_JSON::setContentTypeHeader($type);
+    }
 
-	/**
-	 * Check if the App is enabled and send JSON error message instead
-	 *
-	 * This method checks if a specific app is enabled. If not, a json error
-	 * response will be return and the method will exit from execution
-	 * of the script.
-	 * The returned json will be in the format:
-	 *
-	 *     {"status":"error","data":{"message":"Application is not enabled."}}
-	 *
-	 * Add this call to the start of all ajax method files that requires
-	 * a specific app to be enabled.
-	 *
-	 * @param string $app The app to check
-	 * @deprecated 8.1.0 Use the AppFramework instead. It will automatically check if the app is enabled.
-	 */
-	public static function checkAppEnabled( $app ) {
-		\OC_JSON::checkAppEnabled($app);
-	}
+    /**
+     * Check if the App is enabled and send JSON error message instead
+     *
+     * This method checks if a specific app is enabled. If not, a json error
+     * response will be return and the method will exit from execution
+     * of the script.
+     * The returned json will be in the format:
+     *
+     *     {"status":"error","data":{"message":"Application is not enabled."}}
+     *
+     * Add this call to the start of all ajax method files that requires
+     * a specific app to be enabled.
+     *
+     * @param string $app The app to check
+     * @deprecated 8.1.0 Use the AppFramework instead. It will automatically check if the app is enabled.
+     */
+    public static function checkAppEnabled( $app ) {
+        \OC_JSON::checkAppEnabled($app);
+    }
 
-	/**
-	 * Check if the user is a admin, send json error msg if not
-	 *
-	 * This method checks if the current user has admin rights. If not, a json error
-	 * response will be return and the method will exit from execution
-	 * of the script.
-	 * The returned json will be in the format:
-	 *
-	 *     {"status":"error","data":{"message":"Authentication error."}}
-	 *
-	 * Add this call to the start of all ajax method files that requires
-	 * administrative rights.
-	 *
-	 * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
-	 */
-	public static function checkAdminUser() {
-		\OC_JSON::checkAdminUser();
-	}
+    /**
+     * Check if the user is a admin, send json error msg if not
+     *
+     * This method checks if the current user has admin rights. If not, a json error
+     * response will be return and the method will exit from execution
+     * of the script.
+     * The returned json will be in the format:
+     *
+     *     {"status":"error","data":{"message":"Authentication error."}}
+     *
+     * Add this call to the start of all ajax method files that requires
+     * administrative rights.
+     *
+     * @deprecated 8.1.0 Use annotation based ACLs from the AppFramework instead
+     */
+    public static function checkAdminUser() {
+        \OC_JSON::checkAdminUser();
+    }
 
-	/**
-	 * Encode JSON
-	 * @param array $data
-	 * @return string
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function encode($data) {
-		return \OC_JSON::encode($data);
-	}
+    /**
+     * Encode JSON
+     * @param array $data
+     * @return string
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function encode($data) {
+        return \OC_JSON::encode($data);
+    }
 
-	/**
-	 * Check is a given user exists - send json error msg if not
-	 * @param string $user
-	 * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
-	 */
-	public static function checkUserExists($user) {
-		\OC_JSON::checkUserExists($user);
-	}
+    /**
+     * Check is a given user exists - send json error msg if not
+     * @param string $user
+     * @deprecated 8.1.0 Use a AppFramework JSONResponse instead
+     */
+    public static function checkUserExists($user) {
+        \OC_JSON::checkUserExists($user);
+    }
 }

lib/public/Share.php

Indentation +356 added lines, -356 removed lines

@@ -52,360 +52,360 @@
  */
 class Share extends \OC\Share\Constants {
 
-	/**
-	 * Register a sharing backend class that implements OCP\Share_Backend for an item type
-	 * @param string $itemType Item type
-	 * @param string $class Backend class
-	 * @param string $collectionOf (optional) Depends on item type
-	 * @param array $supportedFileExtensions (optional) List of supported file extensions if this item type depends on files
-	 * @return boolean true if backend is registered or false if error
-	 * @since 5.0.0
-	 */
-	public static function registerBackend($itemType, $class, $collectionOf = null, $supportedFileExtensions = null) {
-		return \OC\Share\Share::registerBackend($itemType, $class, $collectionOf, $supportedFileExtensions);
-	}
-
-	/**
-	 * Check if the Share API is enabled
-	 * @return boolean true if enabled or false
-	 *
-	 * The Share API is enabled by default if not configured
-	 * @since 5.0.0
-	 */
-	public static function isEnabled() {
-		return \OC\Share\Share::isEnabled();
-	}
-
-	/**
-	 * Find which users can access a shared item
-	 * @param string $path to the file
-	 * @param string $ownerUser owner of the file
-	 * @param bool $includeOwner include owner to the list of users with access to the file
-	 * @param bool $returnUserPaths Return an array with the user => path map
-	 * @param bool $recursive take parent folders into account
-	 * @return array
-	 * @note $path needs to be relative to user data dir, e.g. 'file.txt'
-	 *       not '/admin/files/file.txt'
-	 * @since 5.0.0 - $recursive was added in 9.0.0
-	 */
-	public static function getUsersSharingFile($path, $ownerUser, $includeOwner = false, $returnUserPaths = false, $recursive = true) {
-		return \OC\Share\Share::getUsersSharingFile(
-			$path,
-			$ownerUser,
-			\OC::$server->getUserManager(),
-			\OC::$server->getLogger(),
-			$includeOwner,
-			$returnUserPaths,
-			$recursive
-		);
-	}
-
-	/**
-	 * Get the items of item type shared with the current user
-	 * @param string $itemType
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters (optional)
-	 * @param int $limit Number of items to return (optional) Returns all by default
-	 * @param bool $includeCollections (optional)
-	 * @return mixed Return depends on format
-	 * @since 5.0.0
-	 */
-	public static function getItemsSharedWith($itemType, $format = self::FORMAT_NONE,
-		$parameters = null, $limit = -1, $includeCollections = false) {
-
-		return \OC\Share\Share::getItemsSharedWith($itemType, $format, $parameters, $limit, $includeCollections);
-	}
-
-	/**
-	 * Get the items of item type shared with a user
-	 * @param string $itemType
-	 * @param string $user for which user we want the shares
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters (optional)
-	 * @param int $limit Number of items to return (optional) Returns all by default
-	 * @param bool $includeCollections (optional)
-	 * @return mixed Return depends on format
-	 * @since 7.0.0
-	 */
-	public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE,
-		$parameters = null, $limit = -1, $includeCollections = false) {
-
-		return \OC\Share\Share::getItemsSharedWithUser($itemType, $user, $format, $parameters, $limit, $includeCollections);
-	}
-
-	/**
-	 * Get the item of item type shared with the current user
-	 * @param string $itemType
-	 * @param string $itemTarget
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters (optional)
-	 * @param bool $includeCollections (optional)
-	 * @return mixed Return depends on format
-	 * @since 5.0.0
-	 */
-	public static function getItemSharedWith($itemType, $itemTarget, $format = self::FORMAT_NONE,
-		$parameters = null, $includeCollections = false) {
-
-		return \OC\Share\Share::getItemSharedWith($itemType, $itemTarget, $format, $parameters, $includeCollections);
-	}
-
-	/**
-	 * Get the item of item type shared with a given user by source
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param string $user User to whom the item was shared
-	 * @param string $owner Owner of the share
-	 * @return array Return list of items with file_target, permissions and expiration
-	 * @since 6.0.0 - parameter $owner was added in 8.0.0
-	 */
-	public static function getItemSharedWithUser($itemType, $itemSource, $user, $owner = null) {
-		return \OC\Share\Share::getItemSharedWithUser($itemType, $itemSource, $user, $owner);
-	}
-
-	/**
-	 * Get the item of item type shared with the current user by source
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters
-	 * @param bool $includeCollections
-	 * @return array
-	 * @since 5.0.0
-	 */
-	public static function getItemSharedWithBySource($itemType, $itemSource, $format = self::FORMAT_NONE,
-		$parameters = null, $includeCollections = false) {
-		return \OC\Share\Share::getItemSharedWithBySource($itemType, $itemSource, $format, $parameters, $includeCollections);
-	}
-
-	/**
-	 * Get the item of item type shared by a link
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param string $uidOwner Owner of link
-	 * @return array
-	 * @since 5.0.0
-	 */
-	public static function getItemSharedWithByLink($itemType, $itemSource, $uidOwner) {
-		return \OC\Share\Share::getItemSharedWithByLink($itemType, $itemSource, $uidOwner);
-	}
-
-	/**
-	 * Based on the given token the share information will be returned - password protected shares will be verified
-	 * @param string $token
-	 * @param bool $checkPasswordProtection
-	 * @return array|bool false will be returned in case the token is unknown or unauthorized
-	 * @since 5.0.0 - parameter $checkPasswordProtection was added in 7.0.0
-	 */
-	public static function getShareByToken($token, $checkPasswordProtection = true) {
-		return \OC\Share\Share::getShareByToken($token, $checkPasswordProtection);
-	}
-
-	/**
-	 * resolves reshares down to the last real share
-	 * @param array $linkItem
-	 * @return array file owner
-	 * @since 6.0.0
-	 */
-	public static function resolveReShare($linkItem) {
-		return \OC\Share\Share::resolveReShare($linkItem);
-	}
-
-
-	/**
-	 * Get the shared items of item type owned by the current user
-	 * @param string $itemType
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters
-	 * @param int $limit Number of items to return (optional) Returns all by default
-	 * @param bool $includeCollections
-	 * @return mixed Return depends on format
-	 * @since 5.0.0
-	 */
-	public static function getItemsShared($itemType, $format = self::FORMAT_NONE, $parameters = null,
-		$limit = -1, $includeCollections = false) {
-
-		return \OC\Share\Share::getItemsShared($itemType, $format, $parameters, $limit, $includeCollections);
-	}
-
-	/**
-	 * Get the shared item of item type owned by the current user
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $format (optional) Format type must be defined by the backend
-	 * @param mixed $parameters
-	 * @param bool $includeCollections
-	 * @return mixed Return depends on format
-	 * @since 5.0.0
-	 */
-	public static function getItemShared($itemType, $itemSource, $format = self::FORMAT_NONE,
-	                                     $parameters = null, $includeCollections = false) {
-
-		return \OC\Share\Share::getItemShared($itemType, $itemSource, $format, $parameters, $includeCollections);
-	}
-
-	/**
-	 * Get all users an item is shared with
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param string $uidOwner
-	 * @param bool $includeCollections
-	 * @param bool $checkExpireDate
-	 * @return array Return array of users
-	 * @since 5.0.0 - parameter $checkExpireDate was added in 7.0.0
-	 */
-	public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) {
-		return \OC\Share\Share::getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections, $checkExpireDate);
-	}
-
-	/**
-	 * Share an item with a user, group, or via private link
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
-	 * @param string $shareWith User or group the item is being shared with
-	 * @param int $permissions CRUDS
-	 * @param string $itemSourceName
-	 * @param \DateTime $expirationDate
-	 * @param bool $passwordChanged
-	 * @return bool|string Returns true on success or false on failure, Returns token on success for links
-	 * @throws \OC\HintException when the share type is remote and the shareWith is invalid
-	 * @throws \Exception
-	 * @since 5.0.0 - parameter $itemSourceName was added in 6.0.0, parameter $expirationDate was added in 7.0.0, parameter $passwordChanged added in 9.0.0
-	 */
-	public static function shareItem($itemType, $itemSource, $shareType, $shareWith, $permissions, $itemSourceName = null, \DateTime $expirationDate = null, $passwordChanged = null) {
-		return \OC\Share\Share::shareItem($itemType, $itemSource, $shareType, $shareWith, $permissions, $itemSourceName, $expirationDate, $passwordChanged);
-	}
-
-	/**
-	 * Unshare an item from a user, group, or delete a private link
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
-	 * @param string $shareWith User or group the item is being shared with
-	 * @param string $owner owner of the share, if null the current user is used
-	 * @return boolean true on success or false on failure
-	 * @since 5.0.0 - parameter $owner was added in 8.0.0
-	 */
-	public static function unshare($itemType, $itemSource, $shareType, $shareWith, $owner = null) {
-		return \OC\Share\Share::unshare($itemType, $itemSource, $shareType, $shareWith, $owner);
-	}
-
-	/**
-	 * Unshare an item from all users, groups, and remove all links
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @return boolean true on success or false on failure
-	 * @since 5.0.0
-	 */
-	public static function unshareAll($itemType, $itemSource) {
-		return \OC\Share\Share::unshareAll($itemType, $itemSource);
-	}
-
-	/**
-	 * Unshare an item shared with the current user
-	 * @param string $itemType
-	 * @param string $itemOrigin Item target or source
-	 * @param boolean $originIsSource true if $itemOrigin is the source, false if $itemOrigin is the target (optional)
-	 * @return boolean true on success or false on failure
-	 *
-	 * Unsharing from self is not allowed for items inside collections
-	 * @since 5.0.0 - parameter $originIsSource was added in 8.0.0
-	 */
-	public static function unshareFromSelf($itemType, $itemOrigin, $originIsSource = false) {
-		return \OC\Share\Share::unshareFromSelf($itemType, $itemOrigin, $originIsSource);
-	}
-
-	/**
-	 * sent status if users got informed by mail about share
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
-	 * @param string $recipient with whom was the item shared
-	 * @param bool $status
-	 * @since 6.0.0 - parameter $originIsSource was added in 8.0.0
-	 */
-	public static function setSendMailStatus($itemType, $itemSource, $shareType, $recipient, $status) {
-		return \OC\Share\Share::setSendMailStatus($itemType, $itemSource, $shareType, $recipient, $status);
-	}
-
-	/**
-	 * Set the permissions of an item for a specific user or group
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
-	 * @param string $shareWith User or group the item is being shared with
-	 * @param int $permissions CRUDS permissions
-	 * @return boolean true on success or false on failure
-	 * @since 5.0.0
-	 */
-	public static function setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions) {
-		return \OC\Share\Share::setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions);
-	}
-
-	/**
-	 * Set expiration date for a share
-	 * @param string $itemType
-	 * @param string $itemSource
-	 * @param string $date expiration date
-	 * @param int $shareTime timestamp from when the file was shared
-	 * @return boolean
-	 * @since 5.0.0 - parameter $shareTime was added in 8.0.0
-	 */
-	public static function setExpirationDate($itemType, $itemSource, $date, $shareTime = null) {
-		return \OC\Share\Share::setExpirationDate($itemType, $itemSource, $date, $shareTime);
-	}
-
-	/**
-	 * Set password for a public link share
-	 * @param int $shareId
-	 * @param string $password
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public static function setPassword($shareId, $password) {
-		$userSession = \OC::$server->getUserSession();
-		$connection = \OC::$server->getDatabaseConnection();
-		$config = \OC::$server->getConfig();
-		return \OC\Share\Share::setPassword($userSession, $connection, $config, $shareId, $password);
-	}
-
-
-	/**
-	 * Get the backend class for the specified item type
-	 * @param string $itemType
-	 * @return Share_Backend
-	 * @since 5.0.0
-	 */
-	public static function getBackend($itemType) {
-		return \OC\Share\Share::getBackend($itemType);
-	}
-
-	/**
-	 * Delete all shares with type SHARE_TYPE_LINK
-	 * @since 6.0.0
-	 */
-	public static function removeAllLinkShares() {
-		return \OC\Share\Share::removeAllLinkShares();
-	}
-
-	/**
-	 * In case a password protected link is not yet authenticated this function will return false
-	 *
-	 * @param array $linkItem
-	 * @return bool
-	 * @since 7.0.0
-	 */
-	public static function checkPasswordProtectedShare(array $linkItem) {
-		return \OC\Share\Share::checkPasswordProtectedShare($linkItem);
-	}
-
-	/**
-	 * Check if resharing is allowed
-	 *
-	 * @return boolean true if allowed or false
-	 * @since 5.0.0
-	 */
-	public static function isResharingAllowed() {
-		return \OC\Share\Share::isResharingAllowed();
-	}
+    /**
+     * Register a sharing backend class that implements OCP\Share_Backend for an item type
+     * @param string $itemType Item type
+     * @param string $class Backend class
+     * @param string $collectionOf (optional) Depends on item type
+     * @param array $supportedFileExtensions (optional) List of supported file extensions if this item type depends on files
+     * @return boolean true if backend is registered or false if error
+     * @since 5.0.0
+     */
+    public static function registerBackend($itemType, $class, $collectionOf = null, $supportedFileExtensions = null) {
+        return \OC\Share\Share::registerBackend($itemType, $class, $collectionOf, $supportedFileExtensions);
+    }
+
+    /**
+     * Check if the Share API is enabled
+     * @return boolean true if enabled or false
+     *
+     * The Share API is enabled by default if not configured
+     * @since 5.0.0
+     */
+    public static function isEnabled() {
+        return \OC\Share\Share::isEnabled();
+    }
+
+    /**
+     * Find which users can access a shared item
+     * @param string $path to the file
+     * @param string $ownerUser owner of the file
+     * @param bool $includeOwner include owner to the list of users with access to the file
+     * @param bool $returnUserPaths Return an array with the user => path map
+     * @param bool $recursive take parent folders into account
+     * @return array
+     * @note $path needs to be relative to user data dir, e.g. 'file.txt'
+     *       not '/admin/files/file.txt'
+     * @since 5.0.0 - $recursive was added in 9.0.0
+     */
+    public static function getUsersSharingFile($path, $ownerUser, $includeOwner = false, $returnUserPaths = false, $recursive = true) {
+        return \OC\Share\Share::getUsersSharingFile(
+            $path,
+            $ownerUser,
+            \OC::$server->getUserManager(),
+            \OC::$server->getLogger(),
+            $includeOwner,
+            $returnUserPaths,
+            $recursive
+        );
+    }
+
+    /**
+     * Get the items of item type shared with the current user
+     * @param string $itemType
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters (optional)
+     * @param int $limit Number of items to return (optional) Returns all by default
+     * @param bool $includeCollections (optional)
+     * @return mixed Return depends on format
+     * @since 5.0.0
+     */
+    public static function getItemsSharedWith($itemType, $format = self::FORMAT_NONE,
+        $parameters = null, $limit = -1, $includeCollections = false) {
+
+        return \OC\Share\Share::getItemsSharedWith($itemType, $format, $parameters, $limit, $includeCollections);
+    }
+
+    /**
+     * Get the items of item type shared with a user
+     * @param string $itemType
+     * @param string $user for which user we want the shares
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters (optional)
+     * @param int $limit Number of items to return (optional) Returns all by default
+     * @param bool $includeCollections (optional)
+     * @return mixed Return depends on format
+     * @since 7.0.0
+     */
+    public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE,
+        $parameters = null, $limit = -1, $includeCollections = false) {
+
+        return \OC\Share\Share::getItemsSharedWithUser($itemType, $user, $format, $parameters, $limit, $includeCollections);
+    }
+
+    /**
+     * Get the item of item type shared with the current user
+     * @param string $itemType
+     * @param string $itemTarget
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters (optional)
+     * @param bool $includeCollections (optional)
+     * @return mixed Return depends on format
+     * @since 5.0.0
+     */
+    public static function getItemSharedWith($itemType, $itemTarget, $format = self::FORMAT_NONE,
+        $parameters = null, $includeCollections = false) {
+
+        return \OC\Share\Share::getItemSharedWith($itemType, $itemTarget, $format, $parameters, $includeCollections);
+    }
+
+    /**
+     * Get the item of item type shared with a given user by source
+     * @param string $itemType
+     * @param string $itemSource
+     * @param string $user User to whom the item was shared
+     * @param string $owner Owner of the share
+     * @return array Return list of items with file_target, permissions and expiration
+     * @since 6.0.0 - parameter $owner was added in 8.0.0
+     */
+    public static function getItemSharedWithUser($itemType, $itemSource, $user, $owner = null) {
+        return \OC\Share\Share::getItemSharedWithUser($itemType, $itemSource, $user, $owner);
+    }
+
+    /**
+     * Get the item of item type shared with the current user by source
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters
+     * @param bool $includeCollections
+     * @return array
+     * @since 5.0.0
+     */
+    public static function getItemSharedWithBySource($itemType, $itemSource, $format = self::FORMAT_NONE,
+        $parameters = null, $includeCollections = false) {
+        return \OC\Share\Share::getItemSharedWithBySource($itemType, $itemSource, $format, $parameters, $includeCollections);
+    }
+
+    /**
+     * Get the item of item type shared by a link
+     * @param string $itemType
+     * @param string $itemSource
+     * @param string $uidOwner Owner of link
+     * @return array
+     * @since 5.0.0
+     */
+    public static function getItemSharedWithByLink($itemType, $itemSource, $uidOwner) {
+        return \OC\Share\Share::getItemSharedWithByLink($itemType, $itemSource, $uidOwner);
+    }
+
+    /**
+     * Based on the given token the share information will be returned - password protected shares will be verified
+     * @param string $token
+     * @param bool $checkPasswordProtection
+     * @return array|bool false will be returned in case the token is unknown or unauthorized
+     * @since 5.0.0 - parameter $checkPasswordProtection was added in 7.0.0
+     */
+    public static function getShareByToken($token, $checkPasswordProtection = true) {
+        return \OC\Share\Share::getShareByToken($token, $checkPasswordProtection);
+    }
+
+    /**
+     * resolves reshares down to the last real share
+     * @param array $linkItem
+     * @return array file owner
+     * @since 6.0.0
+     */
+    public static function resolveReShare($linkItem) {
+        return \OC\Share\Share::resolveReShare($linkItem);
+    }
+
+
+    /**
+     * Get the shared items of item type owned by the current user
+     * @param string $itemType
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters
+     * @param int $limit Number of items to return (optional) Returns all by default
+     * @param bool $includeCollections
+     * @return mixed Return depends on format
+     * @since 5.0.0
+     */
+    public static function getItemsShared($itemType, $format = self::FORMAT_NONE, $parameters = null,
+        $limit = -1, $includeCollections = false) {
+
+        return \OC\Share\Share::getItemsShared($itemType, $format, $parameters, $limit, $includeCollections);
+    }
+
+    /**
+     * Get the shared item of item type owned by the current user
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $format (optional) Format type must be defined by the backend
+     * @param mixed $parameters
+     * @param bool $includeCollections
+     * @return mixed Return depends on format
+     * @since 5.0.0
+     */
+    public static function getItemShared($itemType, $itemSource, $format = self::FORMAT_NONE,
+                                            $parameters = null, $includeCollections = false) {
+
+        return \OC\Share\Share::getItemShared($itemType, $itemSource, $format, $parameters, $includeCollections);
+    }
+
+    /**
+     * Get all users an item is shared with
+     * @param string $itemType
+     * @param string $itemSource
+     * @param string $uidOwner
+     * @param bool $includeCollections
+     * @param bool $checkExpireDate
+     * @return array Return array of users
+     * @since 5.0.0 - parameter $checkExpireDate was added in 7.0.0
+     */
+    public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) {
+        return \OC\Share\Share::getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections, $checkExpireDate);
+    }
+
+    /**
+     * Share an item with a user, group, or via private link
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
+     * @param string $shareWith User or group the item is being shared with
+     * @param int $permissions CRUDS
+     * @param string $itemSourceName
+     * @param \DateTime $expirationDate
+     * @param bool $passwordChanged
+     * @return bool|string Returns true on success or false on failure, Returns token on success for links
+     * @throws \OC\HintException when the share type is remote and the shareWith is invalid
+     * @throws \Exception
+     * @since 5.0.0 - parameter $itemSourceName was added in 6.0.0, parameter $expirationDate was added in 7.0.0, parameter $passwordChanged added in 9.0.0
+     */
+    public static function shareItem($itemType, $itemSource, $shareType, $shareWith, $permissions, $itemSourceName = null, \DateTime $expirationDate = null, $passwordChanged = null) {
+        return \OC\Share\Share::shareItem($itemType, $itemSource, $shareType, $shareWith, $permissions, $itemSourceName, $expirationDate, $passwordChanged);
+    }
+
+    /**
+     * Unshare an item from a user, group, or delete a private link
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
+     * @param string $shareWith User or group the item is being shared with
+     * @param string $owner owner of the share, if null the current user is used
+     * @return boolean true on success or false on failure
+     * @since 5.0.0 - parameter $owner was added in 8.0.0
+     */
+    public static function unshare($itemType, $itemSource, $shareType, $shareWith, $owner = null) {
+        return \OC\Share\Share::unshare($itemType, $itemSource, $shareType, $shareWith, $owner);
+    }
+
+    /**
+     * Unshare an item from all users, groups, and remove all links
+     * @param string $itemType
+     * @param string $itemSource
+     * @return boolean true on success or false on failure
+     * @since 5.0.0
+     */
+    public static function unshareAll($itemType, $itemSource) {
+        return \OC\Share\Share::unshareAll($itemType, $itemSource);
+    }
+
+    /**
+     * Unshare an item shared with the current user
+     * @param string $itemType
+     * @param string $itemOrigin Item target or source
+     * @param boolean $originIsSource true if $itemOrigin is the source, false if $itemOrigin is the target (optional)
+     * @return boolean true on success or false on failure
+     *
+     * Unsharing from self is not allowed for items inside collections
+     * @since 5.0.0 - parameter $originIsSource was added in 8.0.0
+     */
+    public static function unshareFromSelf($itemType, $itemOrigin, $originIsSource = false) {
+        return \OC\Share\Share::unshareFromSelf($itemType, $itemOrigin, $originIsSource);
+    }
+
+    /**
+     * sent status if users got informed by mail about share
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
+     * @param string $recipient with whom was the item shared
+     * @param bool $status
+     * @since 6.0.0 - parameter $originIsSource was added in 8.0.0
+     */
+    public static function setSendMailStatus($itemType, $itemSource, $shareType, $recipient, $status) {
+        return \OC\Share\Share::setSendMailStatus($itemType, $itemSource, $shareType, $recipient, $status);
+    }
+
+    /**
+     * Set the permissions of an item for a specific user or group
+     * @param string $itemType
+     * @param string $itemSource
+     * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
+     * @param string $shareWith User or group the item is being shared with
+     * @param int $permissions CRUDS permissions
+     * @return boolean true on success or false on failure
+     * @since 5.0.0
+     */
+    public static function setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions) {
+        return \OC\Share\Share::setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions);
+    }
+
+    /**
+     * Set expiration date for a share
+     * @param string $itemType
+     * @param string $itemSource
+     * @param string $date expiration date
+     * @param int $shareTime timestamp from when the file was shared
+     * @return boolean
+     * @since 5.0.0 - parameter $shareTime was added in 8.0.0
+     */
+    public static function setExpirationDate($itemType, $itemSource, $date, $shareTime = null) {
+        return \OC\Share\Share::setExpirationDate($itemType, $itemSource, $date, $shareTime);
+    }
+
+    /**
+     * Set password for a public link share
+     * @param int $shareId
+     * @param string $password
+     * @return boolean
+     * @since 8.1.0
+     */
+    public static function setPassword($shareId, $password) {
+        $userSession = \OC::$server->getUserSession();
+        $connection = \OC::$server->getDatabaseConnection();
+        $config = \OC::$server->getConfig();
+        return \OC\Share\Share::setPassword($userSession, $connection, $config, $shareId, $password);
+    }
+
+
+    /**
+     * Get the backend class for the specified item type
+     * @param string $itemType
+     * @return Share_Backend
+     * @since 5.0.0
+     */
+    public static function getBackend($itemType) {
+        return \OC\Share\Share::getBackend($itemType);
+    }
+
+    /**
+     * Delete all shares with type SHARE_TYPE_LINK
+     * @since 6.0.0
+     */
+    public static function removeAllLinkShares() {
+        return \OC\Share\Share::removeAllLinkShares();
+    }
+
+    /**
+     * In case a password protected link is not yet authenticated this function will return false
+     *
+     * @param array $linkItem
+     * @return bool
+     * @since 7.0.0
+     */
+    public static function checkPasswordProtectedShare(array $linkItem) {
+        return \OC\Share\Share::checkPasswordProtectedShare($linkItem);
+    }
+
+    /**
+     * Check if resharing is allowed
+     *
+     * @return boolean true if allowed or false
+     * @since 5.0.0
+     */
+    public static function isResharingAllowed() {
+        return \OC\Share\Share::isResharingAllowed();
+    }
 }

lib/public/IL10N.php

Indentation +61 added lines, -61 removed lines

@@ -43,69 +43,69 @@
  * @since 6.0.0
  */
 interface IL10N {
-	/**
-	 * Translating
-	 * @param string $text The text we need a translation for
-	 * @param array $parameters default:array() Parameters for sprintf
-	 * @return \OC_L10N_String Translation or the same text
-	 *
-	 * Returns the translation. If no translation is found, $text will be
-	 * returned.
-	 * @since 6.0.0
-	 */
-	public function t($text, $parameters = array());
+    /**
+     * Translating
+     * @param string $text The text we need a translation for
+     * @param array $parameters default:array() Parameters for sprintf
+     * @return \OC_L10N_String Translation or the same text
+     *
+     * Returns the translation. If no translation is found, $text will be
+     * returned.
+     * @since 6.0.0
+     */
+    public function t($text, $parameters = array());
 
-	/**
-	 * Translating
-	 * @param string $text_singular the string to translate for exactly one object
-	 * @param string $text_plural the string to translate for n objects
-	 * @param integer $count Number of objects
-	 * @param array $parameters default:array() Parameters for sprintf
-	 * @return \OC_L10N_String Translation or the same text
-	 *
-	 * Returns the translation. If no translation is found, $text will be
-	 * returned. %n will be replaced with the number of objects.
-	 *
-	 * The correct plural is determined by the plural_forms-function
-	 * provided by the po file.
-	 * @since 6.0.0
-	 *
-	 */
-	public function n($text_singular, $text_plural, $count, $parameters = array());
+    /**
+     * Translating
+     * @param string $text_singular the string to translate for exactly one object
+     * @param string $text_plural the string to translate for n objects
+     * @param integer $count Number of objects
+     * @param array $parameters default:array() Parameters for sprintf
+     * @return \OC_L10N_String Translation or the same text
+     *
+     * Returns the translation. If no translation is found, $text will be
+     * returned. %n will be replaced with the number of objects.
+     *
+     * The correct plural is determined by the plural_forms-function
+     * provided by the po file.
+     * @since 6.0.0
+     *
+     */
+    public function n($text_singular, $text_plural, $count, $parameters = array());
 
-	/**
-	 * Localization
-	 * @param string $type Type of localization
-	 * @param \DateTime|int|string $data parameters for this localization
-	 * @param array $options currently supports following options:
-	 * 			- 'width': handed into \Punic\Calendar::formatDate as second parameter
-	 * @return string|int|false
-	 *
-	 * Returns the localized data.
-	 *
-	 * Implemented types:
-	 *  - date
-	 *    - Creates a date
-	 *    - l10n-field: date
-	 *    - params: timestamp (int/string)
-	 *  - datetime
-	 *    - Creates date and time
-	 *    - l10n-field: datetime
-	 *    - params: timestamp (int/string)
-	 *  - time
-	 *    - Creates a time
-	 *    - l10n-field: time
-	 *    - params: timestamp (int/string)
-	 * @since 6.0.0 - parameter $options was added in 8.0.0
-	 */
-	public function l($type, $data, $options = array());
+    /**
+     * Localization
+     * @param string $type Type of localization
+     * @param \DateTime|int|string $data parameters for this localization
+     * @param array $options currently supports following options:
+     * 			- 'width': handed into \Punic\Calendar::formatDate as second parameter
+     * @return string|int|false
+     *
+     * Returns the localized data.
+     *
+     * Implemented types:
+     *  - date
+     *    - Creates a date
+     *    - l10n-field: date
+     *    - params: timestamp (int/string)
+     *  - datetime
+     *    - Creates date and time
+     *    - l10n-field: datetime
+     *    - params: timestamp (int/string)
+     *  - time
+     *    - Creates a time
+     *    - l10n-field: time
+     *    - params: timestamp (int/string)
+     * @since 6.0.0 - parameter $options was added in 8.0.0
+     */
+    public function l($type, $data, $options = array());
 
 
-	/**
-	 * The code (en, de, ...) of the language that is used for this IL10N object
-	 *
-	 * @return string language
-	 * @since 7.0.0
-	 */
-	public function getLanguageCode();
+    /**
+     * The code (en, de, ...) of the language that is used for this IL10N object
+     *
+     * @return string language
+     * @since 7.0.0
+     */
+    public function getLanguageCode();
 }

lib/public/IAddressBook.php

Indentation +54 added lines, -54 removed lines

@@ -31,64 +31,64 @@
 // use OCP namespace for all classes that are considered public.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP {
-	/**
-	 * Interface IAddressBook
-	 *
-	 * @package OCP
-	 * @since 5.0.0
-	 */
-	interface IAddressBook {
+    /**
+     * Interface IAddressBook
+     *
+     * @package OCP
+     * @since 5.0.0
+     */
+    interface IAddressBook {
 
-		/**
-		 * @return string defining the technical unique key
-		 * @since 5.0.0
-		 */
-		public function getKey();
+        /**
+         * @return string defining the technical unique key
+         * @since 5.0.0
+         */
+        public function getKey();
 
-		/**
-		 * In comparison to getKey() this function returns a human readable (maybe translated) name
-		 * @return mixed
-		 * @since 5.0.0
-		 */
-		public function getDisplayName();
+        /**
+         * In comparison to getKey() this function returns a human readable (maybe translated) name
+         * @return mixed
+         * @since 5.0.0
+         */
+        public function getDisplayName();
 
-		/**
-		 * @param string $pattern which should match within the $searchProperties
-		 * @param array $searchProperties defines the properties within the query pattern should match
-		 * @param array $options - for future use. One should always have options!
-		 * @return array an array of contacts which are arrays of key-value-pairs
-		 * @since 5.0.0
-		 */
-		public function search($pattern, $searchProperties, $options);
-		//	// dummy results
-		//	return array(
-		//		array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'),
-		//		array('id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => array('d@e.f', 'g@h.i')),
-		//	);
+        /**
+         * @param string $pattern which should match within the $searchProperties
+         * @param array $searchProperties defines the properties within the query pattern should match
+         * @param array $options - for future use. One should always have options!
+         * @return array an array of contacts which are arrays of key-value-pairs
+         * @since 5.0.0
+         */
+        public function search($pattern, $searchProperties, $options);
+        //	// dummy results
+        //	return array(
+        //		array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'),
+        //		array('id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => array('d@e.f', 'g@h.i')),
+        //	);
 
-		/**
-		 * @param array $properties this array if key-value-pairs defines a contact
-		 * @return array an array representing the contact just created or updated
-		 * @since 5.0.0
-		 */
-		public function createOrUpdate($properties);
-		//	// dummy
-		//	return array('id'    => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c',
-		//		     'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif',
-		//		     'ADR'   => ';;123 Main Street;Any Town;CA;91921-1234'
-		//	);
+        /**
+         * @param array $properties this array if key-value-pairs defines a contact
+         * @return array an array representing the contact just created or updated
+         * @since 5.0.0
+         */
+        public function createOrUpdate($properties);
+        //	// dummy
+        //	return array('id'    => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c',
+        //		     'PHOTO' => 'VALUE=uri:http://www.abc.com/pub/photos/jqpublic.gif',
+        //		     'ADR'   => ';;123 Main Street;Any Town;CA;91921-1234'
+        //	);
 
-		/**
-		 * @return mixed
-		 * @since 5.0.0
-		 */
-		public function getPermissions();
+        /**
+         * @return mixed
+         * @since 5.0.0
+         */
+        public function getPermissions();
 
-		/**
-		 * @param object $id the unique identifier to a contact
-		 * @return bool successful or not
-		 * @since 5.0.0
-		 */
-		public function delete($id);
-	}
+        /**
+         * @param object $id the unique identifier to a contact
+         * @return bool successful or not
+         * @since 5.0.0
+         */
+        public function delete($id);
+    }
 }

lib/public/LDAP/ILDAPProvider.php

Indentation +65 added lines, -65 removed lines

@@ -29,77 +29,77 @@
  * @since 11.0.0
  */
 interface ILDAPProvider {
-	/**
-	 * Translate a user id to LDAP DN.
-	 * @param string $uid user id
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function getUserDN($uid);
+    /**
+     * Translate a user id to LDAP DN.
+     * @param string $uid user id
+     * @return string
+     * @since 11.0.0
+     */
+    public function getUserDN($uid);
 	
-	/**
-	 * Translate a LDAP DN to an internal user name.
-	 * @param string $dn LDAP DN
-	 * @return string with the internal user name
-	 * @throws \Exception if translation was unsuccessful
-	 * @since 11.0.0
-	 */
-	public function getUserName($dn);
+    /**
+     * Translate a LDAP DN to an internal user name.
+     * @param string $dn LDAP DN
+     * @return string with the internal user name
+     * @throws \Exception if translation was unsuccessful
+     * @since 11.0.0
+     */
+    public function getUserName($dn);
 	
-	/**
-	 * Convert a stored DN so it can be used as base parameter for LDAP queries.
-	 * @param string $dn the DN
-	 * @return string
-	 * @since 11.0.0
-	 */
-	public function DNasBaseParameter($dn);
+    /**
+     * Convert a stored DN so it can be used as base parameter for LDAP queries.
+     * @param string $dn the DN
+     * @return string
+     * @since 11.0.0
+     */
+    public function DNasBaseParameter($dn);
 	
-	/**
-	 * Sanitize a DN received from the LDAP server.
-	 * @param array $dn the DN in question
-	 * @return array the sanitized DN
-	 * @since 11.0.0
-	 */
-	public function sanitizeDN($dn);
+    /**
+     * Sanitize a DN received from the LDAP server.
+     * @param array $dn the DN in question
+     * @return array the sanitized DN
+     * @since 11.0.0
+     */
+    public function sanitizeDN($dn);
 	
-	/**
-	 * Return a new LDAP connection resource for the specified user. 
-	 * @param string $uid user id
-	 * @return resource of the LDAP connection
-	 * @since 11.0.0
-	 */
-	public function getLDAPConnection($uid);
+    /**
+     * Return a new LDAP connection resource for the specified user. 
+     * @param string $uid user id
+     * @return resource of the LDAP connection
+     * @since 11.0.0
+     */
+    public function getLDAPConnection($uid);
 	
-	/**
-	 * Get the LDAP base for users.
-	 * @param string $uid user id
-	 * @return string the base for users
-	 * @throws \Exception if user id was not found in LDAP
-	 * @since 11.0.0
-	 */
-	public function getLDAPBaseUsers($uid);
+    /**
+     * Get the LDAP base for users.
+     * @param string $uid user id
+     * @return string the base for users
+     * @throws \Exception if user id was not found in LDAP
+     * @since 11.0.0
+     */
+    public function getLDAPBaseUsers($uid);
 	
-	/**
-	 * Get the LDAP base for groups.
-	 * @param string $uid user id
-	 * @return string the base for groups
-	 * @throws \Exception if user id was not found in LDAP
-	 * @since 11.0.0
-	 */
-	public function getLDAPBaseGroups($uid);
+    /**
+     * Get the LDAP base for groups.
+     * @param string $uid user id
+     * @return string the base for groups
+     * @throws \Exception if user id was not found in LDAP
+     * @since 11.0.0
+     */
+    public function getLDAPBaseGroups($uid);
 	
-	/**
-	 * Check whether a LDAP DN exists
-	 * @param string $dn LDAP DN
-	 * @return bool whether the DN exists
-	 * @since 11.0.0
-	 */
-	public function dnExists($dn);
+    /**
+     * Check whether a LDAP DN exists
+     * @param string $dn LDAP DN
+     * @return bool whether the DN exists
+     * @since 11.0.0
+     */
+    public function dnExists($dn);
 	
-	/**
-	 * Clear the cache if a cache is used, otherwise do nothing.
-	 * @param string $uid user id
-	 * @since 11.0.0
-	 */
-	public function clearCache($uid);
+    /**
+     * Clear the cache if a cache is used, otherwise do nothing.
+     * @param string $uid user id
+     * @since 11.0.0
+     */
+    public function clearCache($uid);
 }

lib/public/LDAP/ILDAPProviderFactory.php

Indentation +14 added lines, -14 removed lines

@@ -35,19 +35,19 @@
  */
 interface ILDAPProviderFactory {
 
-	/**
-	 * Constructor for the LDAP provider factory
-	 *
-	 * @param IServerContainer $serverContainer server container
-	 * @since 11.0.0
-	 */
-	public function __construct(IServerContainer $serverContainer);
+    /**
+     * Constructor for the LDAP provider factory
+     *
+     * @param IServerContainer $serverContainer server container
+     * @since 11.0.0
+     */
+    public function __construct(IServerContainer $serverContainer);
 	
-	/**
-	 * creates and returns an instance of the ILDAPProvider
-	 *
-	 * @return ILDAPProvider
-	 * @since 11.0.0
-	 */
-	public function getLDAPProvider();
+    /**
+     * creates and returns an instance of the ILDAPProvider
+     *
+     * @return ILDAPProvider
+     * @since 11.0.0
+     */
+    public function getLDAPProvider();
 }

lib/public/LDAP/IDeletionFlagSupport.php

Indentation +12 added lines, -12 removed lines

@@ -29,17 +29,17 @@
  * @since 11.0.0
  */
 interface IDeletionFlagSupport {
-	/**
-	 * Flag record for deletion.
-	 * @param string $uid user id
-	 * @since 11.0.0
-	 */
-	public function flagRecord($uid);
+    /**
+     * Flag record for deletion.
+     * @param string $uid user id
+     * @since 11.0.0
+     */
+    public function flagRecord($uid);
 	
-	/**
-	 * Unflag record for deletion.
-	 * @param string $uid user id
-	 * @since 11.0.0
-	 */
-	public function unflagRecord($uid);
+    /**
+     * Unflag record for deletion.
+     * @param string $uid user id
+     * @since 11.0.0
+     */
+    public function unflagRecord($uid);
 }

lib/public/ICache.php

Indentation +38 added lines, -38 removed lines

@@ -39,46 +39,46 @@
  */
 interface ICache {
 
-	/**
-	 * Get a value from the user cache
-	 * @param string $key
-	 * @return mixed
-	 * @since 6.0.0
-	 */
-	public function get($key);
+    /**
+     * Get a value from the user cache
+     * @param string $key
+     * @return mixed
+     * @since 6.0.0
+     */
+    public function get($key);
 
-	/**
-	 * Set a value in the user cache
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function set($key, $value, $ttl = 0);
+    /**
+     * Set a value in the user cache
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     * @since 6.0.0
+     */
+    public function set($key, $value, $ttl = 0);
 
-	/**
-	 * Check if a value is set in the user cache
-	 * @param string $key
-	 * @return bool
-	 * @since 6.0.0
-	 * @deprecated 9.1.0 Directly read from GET to prevent race conditions
-	 */
-	public function hasKey($key);
+    /**
+     * Check if a value is set in the user cache
+     * @param string $key
+     * @return bool
+     * @since 6.0.0
+     * @deprecated 9.1.0 Directly read from GET to prevent race conditions
+     */
+    public function hasKey($key);
 
-	/**
-	 * Remove an item from the user cache
-	 * @param string $key
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function remove($key);
+    /**
+     * Remove an item from the user cache
+     * @param string $key
+     * @return bool
+     * @since 6.0.0
+     */
+    public function remove($key);
 
-	/**
-	 * Clear the user cache of all entries starting with a prefix
-	 * @param string $prefix (optional)
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function clear($prefix = '');
+    /**
+     * Clear the user cache of all entries starting with a prefix
+     * @param string $prefix (optional)
+     * @return bool
+     * @since 6.0.0
+     */
+    public function clear($prefix = '');
 }

lib/public/AutoloadNotAllowedException.php

Indentation +7 added lines, -7 removed lines

@@ -27,12 +27,12 @@
  * @since 8.2.0
  */
 class AutoloadNotAllowedException extends \DomainException {
-	/**
-	 * @param string $path
-	 * @since 8.2.0
-	 */
-	public function __construct($path) {
-		parent::__construct('Autoload path not allowed: '.$path);
-	}
+    /**
+     * @param string $path
+     * @since 8.2.0
+     */
+    public function __construct($path) {
+        parent::__construct('Autoload path not allowed: '.$path);
+    }
 }