diff options
author | Robin McCorkell <rmccorkell@karoshi.org.uk> | 2014-05-11 21:51:30 +0100 |
---|---|---|
committer | Robin McCorkell <rmccorkell@karoshi.org.uk> | 2014-05-13 19:08:14 +0100 |
commit | 87b548ed91c03f051a93cc39bf94650922c1f55f (patch) | |
tree | 1c2a03d338f3c9a9e729b08d66c83ef9a55782f2 /lib/private/share | |
parent | a7ae2e874a28aed2c190840634db50a19ab1d2e7 (diff) | |
download | nextcloud-server-87b548ed91c03f051a93cc39bf94650922c1f55f.tar.gz nextcloud-server-87b548ed91c03f051a93cc39bf94650922c1f55f.zip |
Fix all PHPDoc types and variable names, in /lib
Diffstat (limited to 'lib/private/share')
-rw-r--r-- | lib/private/share/helper.php | 20 | ||||
-rw-r--r-- | lib/private/share/hooks.php | 10 | ||||
-rw-r--r-- | lib/private/share/mailnotifications.php | 4 | ||||
-rw-r--r-- | lib/private/share/searchresultsorter.php | 4 | ||||
-rw-r--r-- | lib/private/share/share.php | 22 |
5 files changed, 30 insertions, 30 deletions
diff --git a/lib/private/share/helper.php b/lib/private/share/helper.php index 515ec85909a..68f4a35af19 100644 --- a/lib/private/share/helper.php +++ b/lib/private/share/helper.php @@ -25,13 +25,13 @@ class Helper extends \OC\Share\Constants { /** * Generate a unique target for the item - * @param string Item type - * @param string Item source - * @param int SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK - * @param string User or group the item is being shared with - * @param string User that is the owner of shared item - * @param string The suggested target originating from a reshare (optional) - * @param int The id of the parent group share (optional) + * @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 $uidOwner User that is the owner of shared item + * @param string $suggestedTarget The suggested target originating from a reshare (optional) + * @param int $groupParent The id of the parent group share (optional) * @return string Item target */ public static function generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner, @@ -142,9 +142,9 @@ class Helper extends \OC\Share\Constants { /** * Delete all reshares of an item - * @param int Id of item to delete - * @param bool If true, exclude the parent from the delete (optional) - * @param string The user that the parent was shared with (optinal) + * @param int $parent Id of item to delete + * @param bool $excludeParent If true, exclude the parent from the delete (optional) + * @param string $uidOwner The user that the parent was shared with (optinal) */ public static function delete($parent, $excludeParent = false, $uidOwner = null) { $ids = array($parent); diff --git a/lib/private/share/hooks.php b/lib/private/share/hooks.php index a33c71eedd2..9ac64d888ea 100644 --- a/lib/private/share/hooks.php +++ b/lib/private/share/hooks.php @@ -22,9 +22,9 @@ namespace OC\Share; class Hooks extends \OC\Share\Constants { - /** + /** * Function that is called after a user is deleted. Cleans up the shares of that user. - * @param array arguments + * @param array $arguments */ public static function post_deleteUser($arguments) { // Delete any items shared with the deleted user @@ -42,7 +42,7 @@ class Hooks extends \OC\Share\Constants { /** * Function that is called after a user is added to a group. * TODO what does it do? - * @param array arguments + * @param array $arguments */ public static function post_addToGroup($arguments) { // Find the group shares and check if the user needs a unique target @@ -76,7 +76,7 @@ class Hooks extends \OC\Share\Constants { /** * Function that is called after a user is removed from a group. Shares are cleaned up. - * @param array arguments + * @param array $arguments */ public static function post_removeFromGroup($arguments) { $sql = 'SELECT `id`, `share_type` FROM `*PREFIX*share`' @@ -95,7 +95,7 @@ class Hooks extends \OC\Share\Constants { /** * Function that is called after a group is removed. Cleans up the shares to that group. - * @param array arguments + * @param array $arguments */ public static function post_deleteGroup($arguments) { $sql = 'SELECT `id` FROM `*PREFIX*share` WHERE `share_type` = ? AND `share_with` = ?'; diff --git a/lib/private/share/mailnotifications.php b/lib/private/share/mailnotifications.php index 5110df0e571..0cd36e97d54 100644 --- a/lib/private/share/mailnotifications.php +++ b/lib/private/share/mailnotifications.php @@ -50,8 +50,8 @@ class MailNotifications { * @brief inform users if a file was shared with them * * @param array $recipientList list of recipients - * @param type $itemSource shared item source - * @param type $itemType shared item type + * @param string $itemSource shared item source + * @param string $itemType shared item type * @return array list of user to whom the mail send operation failed */ public function sendInternalShareMail($recipientList, $itemSource, $itemType) { diff --git a/lib/private/share/searchresultsorter.php b/lib/private/share/searchresultsorter.php index 76abbf30846..91709902fff 100644 --- a/lib/private/share/searchresultsorter.php +++ b/lib/private/share/searchresultsorter.php @@ -18,8 +18,8 @@ class SearchResultSorter { * @param string $search the search term as was given by the user * @param string $key the array key containing the value that should be compared * against - * @param $encoding optional, encoding to use, defaults to UTF-8 - * @param $log optional, an \OC\Log instance + * @param string $encoding optional, encoding to use, defaults to UTF-8 + * @param \OC\Log $log optional */ public function __construct($search, $key, \OC\Log $log = null, $encoding = 'UTF-8') { $this->encoding = $encoding; diff --git a/lib/private/share/share.php b/lib/private/share/share.php index 211c7e7cb1c..98275a59a6f 100644 --- a/lib/private/share/share.php +++ b/lib/private/share/share.php @@ -254,12 +254,12 @@ 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) + * @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 Return depends on format */ public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE, @@ -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) { @@ -1000,10 +1000,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) |