From ac8b080e4344b2930bfe1a75aed2a83d7d2a50bd Mon Sep 17 00:00:00 2001 From: Callan Barrett Date: Sun, 5 Oct 2008 04:49:01 +0800 Subject: Clean up packages.php and document new package functions Signed-off-by: Callan Barrett Signed-off-by: Loui Chang --- web/lib/pkgfuncs.inc | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) (limited to 'web/lib') diff --git a/web/lib/pkgfuncs.inc b/web/lib/pkgfuncs.inc index 4fbe666..9910379 100644 --- a/web/lib/pkgfuncs.inc +++ b/web/lib/pkgfuncs.inc @@ -984,6 +984,17 @@ function pkg_search_page($SID="") { return; } +/** + * Flag and un-flag packages out-of-date + * + * @param string $atype Account type, output of account_from_sid + * @param array $ids Array of package IDs to flag/unflag, formatted as + * $package_id => $useless_crap + * @param boolean $action True flags out-of-date, false un-flags. Flags by + * default + * + * @return string Translated success or error messages + */ function pkg_flag ($atype, $ids, $action = True) { if (!$atype) { if ($action) { @@ -1058,6 +1069,15 @@ function pkg_flag ($atype, $ids, $action = True) { } } +/** + * Delete packages + * + * @param string $atype Account type, output of account_from_sid + * @param array $ids Array of package IDs to delete, formatted as + * $package_id => $useless_crap + * + * @return string Translated error or success message + */ function pkg_delete ($atype, $ids) { if (!$atype) { return __("You must be logged in before you can disown packages."); @@ -1131,6 +1151,16 @@ function pkg_delete ($atype, $ids) { return __("The selected packages have been deleted."); } +/** + * Adopt or disown packages + * + * @param string $atype Account type, output of account_from_sid + * @param array $ids Array of package IDs to adopt/disown, formatted as + * $package_id => $whatever + * @param boolean $action Adopts if true, disowns if false. Adopts by default + * + * @return string Translated error or success message + */ function pkg_adopt ($atype, $ids, $action = True) { if (!$atype) { if ($action) { @@ -1189,6 +1219,16 @@ function pkg_adopt ($atype, $ids, $action = True) { } } +/** + * Vote and un-vote for packages + * + * @param string $atype Account type, output of account_from_sid + * @param array $ids Array of package IDs to vote/un-vote, formatted as + * $package_id => $useless + * @param boolean $action Votes if true, un-votes if false. Votes by default + * + * @return string Translated error or success message + */ function pkg_vote ($atype, $ids, $action = True) { if (!$atype) { if ($action) { @@ -1266,6 +1306,14 @@ function pkg_vote ($atype, $ids, $action = True) { } } +/** + * Toggle notification of packages + * + * @param string $atype Account type, output of account_from_sid + * @param array $ids Array of package IDs to toggle, formatted as $package_id => $crap + * + * @return string Translated error or success message + */ function pkg_notify ($atype, $ids, $action = True) { if (!$atype) { # return __("You must be logged in before you can get notifications on comments."); -- cgit v1.2.3-70-g09d2