diff options
Diffstat (limited to 'lib/private/share/share.php')
| -rw-r--r-- | lib/private/share/share.php | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/lib/private/share/share.php b/lib/private/share/share.php index 6f8830e73f2..a8537a916fb 100644 --- a/lib/private/share/share.php +++ b/lib/private/share/share.php @@ -254,13 +254,13 @@ class Share extends \OC\Share\Constants { /** * Get the items of item type shared with a user - * @param string Item type - * @param sting user id 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 Number of items to return (optional) Returns all by default - * @param boolean include collections (optional) - * @return Return depends on format + * @param string $itemType + * @param string $user id 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 boolean $includeCollections (optional) + * @return mixed Return depends on format */ public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE, $parameters = null, $limit = -1, $includeCollections = false) { @@ -352,7 +352,7 @@ class Share extends \OC\Share\Constants { * @param string $itemType * @param string $itemSource * @param string $uidOwner Owner of link - * @return Item + * @return array */ public static function getItemSharedWithByLink($itemType, $itemSource, $uidOwner) { return self::getItems($itemType, $itemSource, self::SHARE_TYPE_LINK, null, $uidOwner, self::FORMAT_NONE, @@ -362,7 +362,7 @@ class Share extends \OC\Share\Constants { /** * Based on the given token the share information will be returned - password protected shares will be verified * @param string $token - * @return array | boolean false will be returned in case the token is unknown or unauthorized + * @return array|boolean false will be returned in case the token is unknown or unauthorized */ public static function getShareByToken($token, $checkPasswordProtection = true) { $query = \OC_DB::prepare('SELECT * FROM `*PREFIX*share` WHERE `token` = ?', 1); @@ -388,8 +388,8 @@ class Share extends \OC\Share\Constants { /** * resolves reshares down to the last real share - * @param $linkItem - * @return $fileOwner + * @param array $linkItem + * @return array file owner */ public static function resolveReShare($linkItem) { @@ -446,7 +446,7 @@ class Share extends \OC\Share\Constants { * @param string $uidOwner * @param boolean $includeCollections * @param boolean $checkExpireDate - * @return Return array of users + * @return array Return array of users */ public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) { @@ -926,6 +926,7 @@ class Share extends \OC\Share\Constants { /** * Get the backend class for the specified item type * @param string $itemType + * @throws \Exception * @return \OCP\Share_Backend */ public static function getBackend($itemType) { @@ -1000,10 +1001,10 @@ class Share extends \OC\Share\Constants { /** * Get shared items from the database * @param string $itemType - * @param string Item source or target (optional) + * @param string $item Item source or target (optional) * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, SHARE_TYPE_LINK, $shareTypeUserAndGroups, or $shareTypeGroupUserUnique * @param string $shareWith User or group the item is being shared with - * @param string uidOwner User that is the owner of shared items (optional) + * @param string $uidOwner User that is the owner of shared items (optional) * @param int $format Format to convert items to with formatItems() (optional) * @param mixed $parameters to pass to formatItems() (optional) * @param int $limit Number of items to return, -1 to return all matches (optional) @@ -1353,6 +1354,7 @@ class Share extends \OC\Share\Constants { * @param boolean|array $parentFolder Parent folder target (optional) * @param string $token (optional) * @param string $itemSourceName name of the source item (optional) + * @throws \Exception * @return boolean Returns true on success or false on failure */ private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner, @@ -1641,7 +1643,7 @@ class Share extends \OC\Share\Constants { } /** - * @breif construct select statement + * @brief construct select statement * @param int $format * @param boolean $fileDependent ist it a file/folder share or a generla share * @param string $uidOwner |