nextcloud / server

lib/public/iimage.php

Indentation +154 added lines, -154 removed lines

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

lib/public/itags.php

Indentation +174 added lines, -174 removed lines

@@ -50,179 +50,179 @@
 
 interface ITags {
 
-	/**
-	 * Check if any tags are saved for this type and user.
-	 *
-	 * @return boolean
-	 * @since 6.0.0
-	 */
-	public function isEmpty();
-
-	/**
-	 * Returns an array mapping a given tag's properties to its values:
-	 * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
-	 *
-	 * @param string $id The ID of the tag that is going to be mapped
-	 * @return array|false
-	 * @since 8.0.0
-	 */
-	public function getTag($id);
-
-	/**
-	 * Get the tags for a specific user.
-	 *
-	 * This returns an array with id/name maps:
-	 * [
-	 * 	['id' => 0, 'name' = 'First tag'],
-	 * 	['id' => 1, 'name' = 'Second tag'],
-	 * ]
-	 *
-	 * @return array
-	 * @since 6.0.0
-	 */
-	public function getTags();
-
-	/**
-	 * Get a list of tags for the given item ids.
-	 *
-	 * This returns an array with object id / tag names:
-	 * [
-	 *   1 => array('First tag', 'Second tag'),
-	 *   2 => array('Second tag'),
-	 *   3 => array('Second tag', 'Third tag'),
-	 * ]
-	 *
-	 * @param array $objIds item ids
-	 * @return array|boolean with object id as key and an array
-	 * of tag names as value or false if an error occurred
-	 * @since 8.0.0
-	 */
-	public function getTagsForObjects(array $objIds);
-
-	/**
-	 * Get a list of items tagged with $tag.
-	 *
-	 * Throws an exception if the tag could not be found.
-	 *
-	 * @param string|integer $tag Tag id or name.
-	 * @return array|false An array of object ids or false on error.
-	 * @since 6.0.0
-	 */
-	public function getIdsForTag($tag);
-
-	/**
-	 * Checks whether a tag is already saved.
-	 *
-	 * @param string $name The name to check for.
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function hasTag($name);
-
-	/**
-	 * Checks whether a tag is saved for the given user,
-	 * disregarding the ones shared with him or her.
-	 *
-	 * @param string $name The tag name to check for.
-	 * @param string $user The user whose tags are to be checked.
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function userHasTag($name, $user);
-
-	/**
-	 * Add a new tag.
-	 *
-	 * @param string $name A string with a name of the tag
-	 * @return int|false the id of the added tag or false if it already exists.
-	 * @since 6.0.0
-	 */
-	public function add($name);
-
-	/**
-	 * Rename tag.
-	 *
-	 * @param string|integer $from The name or ID of the existing tag
-	 * @param string $to The new name of the tag.
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function rename($from, $to);
-
-	/**
-	 * Add a list of new tags.
-	 *
-	 * @param string[] $names A string with a name or an array of strings containing
-	 * the name(s) of the to add.
-	 * @param bool $sync When true, save the tags
-	 * @param int|null $id int Optional object id to add to this|these tag(s)
-	 * @return bool Returns false on error.
-	 * @since 6.0.0
-	 */
-	public function addMultiple($names, $sync=false, $id = null);
-
-	/**
-	 * Delete tag/object relations from the db
-	 *
-	 * @param array $ids The ids of the objects
-	 * @return boolean Returns false on error.
-	 * @since 6.0.0
-	 */
-	public function purgeObjects(array $ids);
-
-	/**
-	 * Get favorites for an object type
-	 *
-	 * @return array|false An array of object ids.
-	 * @since 6.0.0
-	 */
-	public function getFavorites();
-
-	/**
-	 * Add an object to favorites
-	 *
-	 * @param int $objid The id of the object
-	 * @return boolean
-	 * @since 6.0.0
-	 */
-	public function addToFavorites($objid);
-
-	/**
-	 * Remove an object from favorites
-	 *
-	 * @param int $objid The id of the object
-	 * @return boolean
-	 * @since 6.0.0
-	 */
-	public function removeFromFavorites($objid);
-
-	/**
-	 * Creates a tag/object relation.
-	 *
-	 * @param int $objid The id of the object
-	 * @param string $tag The id or name of the tag
-	 * @return boolean Returns false on database error.
-	 * @since 6.0.0
-	 */
-	public function tagAs($objid, $tag);
-
-	/**
-	 * Delete single tag/object relation from the db
-	 *
-	 * @param int $objid The id of the object
-	 * @param string $tag The id or name of the tag
-	 * @return boolean
-	 * @since 6.0.0
-	 */
-	public function unTag($objid, $tag);
-
-	/**
-	 * Delete tags from the database
-	 *
-	 * @param string[]|integer[] $names An array of tags (names or IDs) to delete
-	 * @return bool Returns false on error
-	 * @since 6.0.0
-	 */
-	public function delete($names);
+    /**
+     * Check if any tags are saved for this type and user.
+     *
+     * @return boolean
+     * @since 6.0.0
+     */
+    public function isEmpty();
+
+    /**
+     * Returns an array mapping a given tag's properties to its values:
+     * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype']
+     *
+     * @param string $id The ID of the tag that is going to be mapped
+     * @return array|false
+     * @since 8.0.0
+     */
+    public function getTag($id);
+
+    /**
+     * Get the tags for a specific user.
+     *
+     * This returns an array with id/name maps:
+     * [
+     * 	['id' => 0, 'name' = 'First tag'],
+     * 	['id' => 1, 'name' = 'Second tag'],
+     * ]
+     *
+     * @return array
+     * @since 6.0.0
+     */
+    public function getTags();
+
+    /**
+     * Get a list of tags for the given item ids.
+     *
+     * This returns an array with object id / tag names:
+     * [
+     *   1 => array('First tag', 'Second tag'),
+     *   2 => array('Second tag'),
+     *   3 => array('Second tag', 'Third tag'),
+     * ]
+     *
+     * @param array $objIds item ids
+     * @return array|boolean with object id as key and an array
+     * of tag names as value or false if an error occurred
+     * @since 8.0.0
+     */
+    public function getTagsForObjects(array $objIds);
+
+    /**
+     * Get a list of items tagged with $tag.
+     *
+     * Throws an exception if the tag could not be found.
+     *
+     * @param string|integer $tag Tag id or name.
+     * @return array|false An array of object ids or false on error.
+     * @since 6.0.0
+     */
+    public function getIdsForTag($tag);
+
+    /**
+     * Checks whether a tag is already saved.
+     *
+     * @param string $name The name to check for.
+     * @return bool
+     * @since 6.0.0
+     */
+    public function hasTag($name);
+
+    /**
+     * Checks whether a tag is saved for the given user,
+     * disregarding the ones shared with him or her.
+     *
+     * @param string $name The tag name to check for.
+     * @param string $user The user whose tags are to be checked.
+     * @return bool
+     * @since 8.0.0
+     */
+    public function userHasTag($name, $user);
+
+    /**
+     * Add a new tag.
+     *
+     * @param string $name A string with a name of the tag
+     * @return int|false the id of the added tag or false if it already exists.
+     * @since 6.0.0
+     */
+    public function add($name);
+
+    /**
+     * Rename tag.
+     *
+     * @param string|integer $from The name or ID of the existing tag
+     * @param string $to The new name of the tag.
+     * @return bool
+     * @since 6.0.0
+     */
+    public function rename($from, $to);
+
+    /**
+     * Add a list of new tags.
+     *
+     * @param string[] $names A string with a name or an array of strings containing
+     * the name(s) of the to add.
+     * @param bool $sync When true, save the tags
+     * @param int|null $id int Optional object id to add to this|these tag(s)
+     * @return bool Returns false on error.
+     * @since 6.0.0
+     */
+    public function addMultiple($names, $sync=false, $id = null);
+
+    /**
+     * Delete tag/object relations from the db
+     *
+     * @param array $ids The ids of the objects
+     * @return boolean Returns false on error.
+     * @since 6.0.0
+     */
+    public function purgeObjects(array $ids);
+
+    /**
+     * Get favorites for an object type
+     *
+     * @return array|false An array of object ids.
+     * @since 6.0.0
+     */
+    public function getFavorites();
+
+    /**
+     * Add an object to favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     * @since 6.0.0
+     */
+    public function addToFavorites($objid);
+
+    /**
+     * Remove an object from favorites
+     *
+     * @param int $objid The id of the object
+     * @return boolean
+     * @since 6.0.0
+     */
+    public function removeFromFavorites($objid);
+
+    /**
+     * Creates a tag/object relation.
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @return boolean Returns false on database error.
+     * @since 6.0.0
+     */
+    public function tagAs($objid, $tag);
+
+    /**
+     * Delete single tag/object relation from the db
+     *
+     * @param int $objid The id of the object
+     * @param string $tag The id or name of the tag
+     * @return boolean
+     * @since 6.0.0
+     */
+    public function unTag($objid, $tag);
+
+    /**
+     * Delete tags from the database
+     *
+     * @param string[]|integer[] $names An array of tags (names or IDs) to delete
+     * @return bool Returns false on error
+     * @since 6.0.0
+     */
+    public function delete($names);
 
 }

lib/public/iusersession.php

Indentation +36 added lines, -36 removed lines

@@ -40,44 +40,44 @@
  * @since 6.0.0
  */
 interface IUserSession {
-	/**
-	 * Do a user login
-	 * @param string $user the username
-	 * @param string $password the password
-	 * @return bool true if successful
-	 * @since 6.0.0
-	 */
-	public function login($user, $password);
+    /**
+     * Do a user login
+     * @param string $user the username
+     * @param string $password the password
+     * @return bool true if successful
+     * @since 6.0.0
+     */
+    public function login($user, $password);
 
-	/**
-	 * Logs the user out including all the session data
-	 * Logout, destroys session
-	 * @return void
-	 * @since 6.0.0
-	 */
-	public function logout();
+    /**
+     * Logs the user out including all the session data
+     * Logout, destroys session
+     * @return void
+     * @since 6.0.0
+     */
+    public function logout();
 
-	/**
-	 * set the currently active user
-	 *
-	 * @param \OCP\IUser|null $user
-	 * @since 8.0.0
-	 */
-	public function setUser($user);
+    /**
+     * set the currently active user
+     *
+     * @param \OCP\IUser|null $user
+     * @since 8.0.0
+     */
+    public function setUser($user);
 
-	/**
-	 * get the current active user
-	 *
-	 * @return \OCP\IUser|null Current user, otherwise null
-	 * @since 8.0.0
-	 */
-	public function getUser();
+    /**
+     * get the current active user
+     *
+     * @return \OCP\IUser|null Current user, otherwise null
+     * @since 8.0.0
+     */
+    public function getUser();
 
-	/**
-	 * Checks whether the user is logged in
-	 *
-	 * @return bool if logged in
-	 * @since 8.0.0
-	 */
-	public function isLoggedIn();
+    /**
+     * Checks whether the user is logged in
+     *
+     * @return bool if logged in
+     * @since 8.0.0
+     */
+    public function isLoggedIn();
 }

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/ieventsource.php

Indentation +15 added lines, -15 removed lines

@@ -33,20 +33,20 @@
  * @since 8.0.0
  */
 interface IEventSource {
-	/**
-	 * send a message to the client
-	 *
-	 * @param string $type
-	 * @param mixed $data
-	 *
-	 * if only one parameter is given, a typeless message will be send with that parameter as data
-	 * @since 8.0.0
-	 */
-	public function send($type, $data = null);
+    /**
+     * send a message to the client
+     *
+     * @param string $type
+     * @param mixed $data
+     *
+     * if only one parameter is given, a typeless message will be send with that parameter as data
+     * @since 8.0.0
+     */
+    public function send($type, $data = null);
 
-	/**
-	 * close the connection of the event source
-	 * @since 8.0.0
-	 */
-	public function close();
+    /**
+     * close the connection of the event source
+     * @since 8.0.0
+     */
+    public function close();
 }

lib/public/itagmanager.php

Indentation +13 added lines, -13 removed lines

@@ -46,17 +46,17 @@
  */
 interface ITagManager {
 
-	/**
-	 * Create a new \OCP\ITags instance and load tags from db for the current user.
-	 *
-	 * @see \OCP\ITags
-	 * @param string $type The type identifier e.g. 'contact' or 'event'.
-	 * @param array $defaultTags An array of default tags to be used if none are stored.
-	 * @param boolean $includeShared Whether to include tags for items shared with this user by others.
-	 * @param string $userId user for which to retrieve the tags, defaults to the currently
-	 * logged in user
-	 * @return \OCP\ITags
-	 * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0
-	*/
-	public function load($type, $defaultTags = array(), $includeShared = false, $userId = null);
+    /**
+     * Create a new \OCP\ITags instance and load tags from db for the current user.
+     *
+     * @see \OCP\ITags
+     * @param string $type The type identifier e.g. 'contact' or 'event'.
+     * @param array $defaultTags An array of default tags to be used if none are stored.
+     * @param boolean $includeShared Whether to include tags for items shared with this user by others.
+     * @param string $userId user for which to retrieve the tags, defaults to the currently
+     * logged in user
+     * @return \OCP\ITags
+     * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0
+     */
+    public function load($type, $defaultTags = array(), $includeShared = false, $userId = null);
 }

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/share.php

Indentation +348 added lines, -348 removed lines

@@ -51,352 +51,352 @@
  */
 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, $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, paramter $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, $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, paramter $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/diagnostics/ieventlogger.php

Indentation +28 added lines, -28 removed lines

@@ -30,35 +30,35 @@
  * @since 8.0.0
  */
 interface IEventLogger {
-	/**
-	 * Mark the start of an event
-	 *
-	 * @param string $id
-	 * @param string $description
-	 * @since 8.0.0
-	 */
-	public function start($id, $description);
+    /**
+     * Mark the start of an event
+     *
+     * @param string $id
+     * @param string $description
+     * @since 8.0.0
+     */
+    public function start($id, $description);
 
-	/**
-	 * Mark the end of an event
-	 *
-	 * @param string $id
-	 * @since 8.0.0
-	 */
-	public function end($id);
+    /**
+     * Mark the end of an event
+     *
+     * @param string $id
+     * @since 8.0.0
+     */
+    public function end($id);
 
-	/**
-	 * @param string $id
-	 * @param string $description
-	 * @param float $start
-	 * @param float $end
-	 * @since 8.0.0
-	 */
-	public function log($id, $description, $start, $end);
+    /**
+     * @param string $id
+     * @param string $description
+     * @param float $start
+     * @param float $end
+     * @since 8.0.0
+     */
+    public function log($id, $description, $start, $end);
 
-	/**
-	 * @return \OCP\Diagnostics\IEvent[]
-	 * @since 8.0.0
-	 */
-	public function getEvents();
+    /**
+     * @return \OCP\Diagnostics\IEvent[]
+     * @since 8.0.0
+     */
+    public function getEvents();
 }