From 4235d24039258c80ef102e8a52550add5117f2e5 Mon Sep 17 00:00:00 2001 From: canyonknight Date: Sun, 3 Feb 2013 16:26:30 +0000 Subject: Remove documentation references to database parameter Signed-off-by: Lukas Fleischer --- web/lib/acctfuncs.inc.php | 24 ------------------------ web/lib/aur.inc.php | 18 ------------------ web/lib/pkgfuncs.inc.php | 24 ------------------------ web/lib/stats.inc.php | 5 ----- 4 files changed, 71 deletions(-) (limited to 'web/lib') diff --git a/web/lib/acctfuncs.inc.php b/web/lib/acctfuncs.inc.php index fe13b49..e982849 100644 --- a/web/lib/acctfuncs.inc.php +++ b/web/lib/acctfuncs.inc.php @@ -84,7 +84,6 @@ function display_account_form($UTYPE,$A,$U="",$T="",$S="", * @param string $I The IRC nickname of the user * @param string $K The PGP fingerprint of the user * @param string $UID The user ID of the modified account - * @param \PDO $dbh An already established database connection * * @return string|void Return void if successful, otherwise return error */ @@ -282,7 +281,6 @@ function search_accounts_form() { * @param string $R The real name search criteria * @param string $I The IRC nickname search criteria * @param string $K The PGP key fingerprint search criteria - * @param \PDO $dbh An already established database connection * * @return void */ @@ -385,7 +383,6 @@ function search_results_page($UTYPE,$O=0,$SB="",$U="",$T="", * * @global int $MAX_SESSIONS_PER_USER Maximum sessions a single user may have open * @global int $PERSISTENT_COOKIE_TIMEOUT Time until cookie expires - * @param \PDO $dbh An already established database connection * * @return array Session ID for user, error message if applicable */ @@ -514,7 +511,6 @@ function valid_username($user) { * Determine if a username exists in the database * * @param string $user Username to check in the database - * @param \PDO $dbh An already established database connection * * @return string|void Return user ID if in database, otherwise void */ @@ -543,7 +539,6 @@ function valid_user($user) { * Determine if a user already has a proposal open about themselves * * @param string $user Username to checkout for open proposal - * @param \PDO $dbh An already established database connection * * @return bool True if there is an open proposal about the user, otherwise false */ @@ -569,7 +564,6 @@ function open_user_proposals($user) { * @param string $user The use the vote is about * @param int $votelength The length of time for the vote to last * @param string $submitteruid The user ID of the individual who submitted the proposal - * @param \PDO $dbh An already established database connection * * @return void */ @@ -590,7 +584,6 @@ function add_tu_proposal($agenda, $user, $votelength, $submitteruid) { * * @param string $resetkey A password reset key to be stored in database * @param string $uid The user ID to store the reset key for - * @param \PDO $dbh An already established database connection * * @return void */ @@ -611,7 +604,6 @@ function create_resetkey($resetkey, $uid) { * @param string $salt New salt for the user's password * @param string $resetkey Code e-mailed to a user to reset a password * @param string $email E-mail address of the user resetting their password - * @param \PDO $dbh An already established database connection * * @return string|void Redirect page if successful, otherwise return error message */ @@ -656,7 +648,6 @@ function good_passwd($passwd) { * * @param string $userID The user ID to check the password against * @param string $passwd The password the visitor sent - * @param \PDO $dbh An already established database connection * * @return bool True if password was correct and properly salted, otherwise false */ @@ -718,7 +709,6 @@ function valid_pgp_fingerprint($fingerprint) { * Determine if the user account has been suspended * * @param string $id The ID of user to check if suspended - * @param \PDO $dbh An already established database connection * * @return bool True if the user is suspended, otherwise false */ @@ -744,7 +734,6 @@ function user_suspended($id) { * Delete a specified user account from the database * * @param int $id The user ID of the account to be deleted - * @param \PDO $dbh An already established database connection * * @return void */ @@ -761,7 +750,6 @@ function user_delete($id) { * Determine if a user is either a Trusted User or Developer * * @param string $id The ID of the user to check if privileged - * @param \PDO $dbh An already established database connection * * @return int|string Return 0 if un-privileged, "2" if Trusted User, "3" if Developer */ @@ -785,7 +773,6 @@ function user_is_privileged($id) { * Remove the session from the database on logout * * @param string $sid User's session ID - * @param \PDO $dbh An already established database connection * * @return void */ @@ -802,7 +789,6 @@ function delete_session_id($sid) { * Remove all sessions belonging to a particular user * * @param int $uid ID of user to remove all sessions for - * @param \PDO $dbh An already established database connection * * @return void */ @@ -819,7 +805,6 @@ function delete_user_sessions($uid) { * Remove sessions from the database that have exceed the timeout * * @global int $LOGIN_TIMEOUT Time until session expires - * @param \PDO $dbh An already established database connection * * @return void */ @@ -841,7 +826,6 @@ function clear_expired_sessions() { * * @param string $uid The User ID of account to get information for * @param string $username The username of the account to get for - * @param \PDO $dbh An already established database connection * * @return array Account details for the specified user */ @@ -871,7 +855,6 @@ function account_details($uid, $username) { * * @param string $voteid The ID of the Trusted User proposal * @param string $uid The ID to check if the user already voted - * @param \PDO $dbh An already established database connection * * @return bool True if the user has already voted, otherwise false */ @@ -895,7 +878,6 @@ function tu_voted($voteid, $uid) { * Get all current Trusted User proposals from the database * * @param string $order Ascending or descending order for the proposal listing - * @param \PDO $dbh An already established database connection * * @return array The details for all current Trusted User proposals */ @@ -920,7 +902,6 @@ function current_proposal_list($order) { * * @param string $order Ascending or descending order for the proposal listing * @param string $lim The number of proposals to list with the offset - * @param \PDO $dbh An already established database connection * * @return array The details for the subset of past Trusted User proposals */ @@ -943,8 +924,6 @@ function past_proposal_list($order, $lim) { /** * Determine the total number of Trusted User proposals * - * @param \PDO $dbh An already established database connection - * * @return string The total number of Trusted User proposals */ function proposal_count() { @@ -963,7 +942,6 @@ function proposal_count() { * Get all details related to a specific vote from the database * * @param string $voteid The ID of the Trusted User proposal - * @param \PDO $dbh An already established database connection * * @return array All stored details for a specific vote */ @@ -985,7 +963,6 @@ function vote_details($voteid) { * Get an alphabetical list of users who voted for a proposal with HTML links * * @param string $voteid The ID of the Trusted User proposal - * @param \PDO $dbh An already established database connection * * @return array All users who voted for a specific proposal */ @@ -1018,7 +995,6 @@ function voter_list($voteid) { * @param string $uid The user ID of the individual voting * @param string $vote Vote position, either "Yes", "No", or "Abstain" * @param int $newtotal The total number of votes after the user has voted - * @param \PDO $dbh An already established database connection * * @return void */ diff --git a/web/lib/aur.inc.php b/web/lib/aur.inc.php index 77a84e4..3182dc9 100644 --- a/web/lib/aur.inc.php +++ b/web/lib/aur.inc.php @@ -26,7 +26,6 @@ include_once("cachefuncs.inc.php"); * * @global array $_COOKIE User cookie values * @global string $LOGIN_TIMEOUT Time until session times out - * @param \PDO $dbh Already established database connection * * @return void */ @@ -137,7 +136,6 @@ function new_sid() { * Determine the user's username in the database using a user ID * * @param string $id User's ID - * @param \PDO $dbh Already established database connection * * @return string Username if it exists, otherwise "None" */ @@ -162,7 +160,6 @@ function username_from_id($id="") { * Determine the user's username in the database using a session ID * * @param string $sid User's session ID - * @param \PDO $dbh Already established database connection * * @return string Username of the visitor */ @@ -190,7 +187,6 @@ function username_from_sid($sid="") { * Determine the user's e-mail address in the database using a session ID * * @param string $sid User's session ID - * @param \PDO $dbh Already established database connection * * @return string User's e-mail address as given during registration */ @@ -218,7 +214,6 @@ function email_from_sid($sid="") { * Determine the user's account type in the database using a session ID * * @param string $sid User's session ID - * @param \PDO $dbh Already established database connection * * @return string Account type of user ("User", "Trusted User", or "Developer") */ @@ -247,7 +242,6 @@ function account_from_sid($sid="") { * Determine the user's ID in the database using a session ID * * @param string $sid User's session ID - * @param \PDO $dbh Already established database connection * * @return string|int The user's name, 0 on query failure */ @@ -307,7 +301,6 @@ function html_footer($ver="") { * * @param string $name Name of the package to be submitted * @param string $sid User's session ID - * @param \PDO $dbh Already established database connection * * @return int 0 if the user can't submit, 1 if the user can submit */ @@ -364,7 +357,6 @@ function rm_tree($dirname) { * Determine the user's ID in the database using a username * * @param string $username The username of an account - * @param \PDO $dbh Already established database connection * * @return string Return user ID if exists for username, otherwise "None" */ @@ -389,7 +381,6 @@ function uid_from_username($username="") { * Determine the user's ID in the database using an e-mail address * * @param string $email An e-mail address in foo@example.com format - * @param \PDO $dbh Already established database connection * * @return string The user's ID */ @@ -458,7 +449,6 @@ function mkurl($append) { * Determine a user's salt from the database * * @param string $user_id The user ID of the user trying to log in - * @param \PDO $dbh Already established database connection * * @return string|void Return the salt for the requested user, otherwise void */ @@ -480,7 +470,6 @@ function get_salt($user_id) { * * @param string $user_id The user ID of the user who is salting their password * @param string $passwd The password of the user logging in - * @param \PDO $dbh Already established database connection */ function save_salt($user_id, $passwd) { if(!$dbh) { @@ -549,8 +538,6 @@ function parse_comment($comment) { /** * Wrapper for beginning a database transaction - * - * @param \PDO $dbh Already established database connection */ function begin_atomic_commit() { if(!$dbh) { @@ -561,8 +548,6 @@ function begin_atomic_commit() { /** * Wrapper for committing a database transaction - * - * @param \PDO $dbh Already established database connection */ function end_atomic_commit() { if(!$dbh) { @@ -575,8 +560,6 @@ function end_atomic_commit() { * * Determine the row ID for the most recently insterted row * - * @param \PDO $dbh Already established database connection - * * @return string The ID of the last inserted row */ function last_insert_id() { @@ -590,7 +573,6 @@ function last_insert_id() { * Determine package information for latest package * * @param int $numpkgs Number of packages to get information on - * @param \PDO $dbh Already established database connection * * @return array $packages Package info for the specified number of recent packages */ diff --git a/web/lib/pkgfuncs.inc.php b/web/lib/pkgfuncs.inc.php index 21fc37c..acaa218 100644 --- a/web/lib/pkgfuncs.inc.php +++ b/web/lib/pkgfuncs.inc.php @@ -10,7 +10,6 @@ include_once("config.inc.php"); * @param string $comment_id The comment ID in the database * @param string $atype The account type of the user trying to delete a comment * @param string|int $uid The user ID of the individual trying to delete a comment - * @param \PDO $dbh An already established database connection * * @return bool True if the user can delete the comment, otherwise false */ @@ -106,7 +105,6 @@ function pkgCategories() { * Check to see if the package name already exists in the database * * @param string $name The package name to check - * @param \PDO $dbh An already established database connection * * @return string|void Package name if it already exists */ @@ -129,7 +127,6 @@ function pkgid_from_name($name="") { * Get package dependencies for a specific package * * @param int $pkgid The package to get dependencies for - * @param \PDO $dbh An already established database connection * * @return array All package dependencies for the package */ @@ -159,7 +156,6 @@ function package_dependencies($pkgid) { * Determine packages that depend on a package * * @param string $name The package name for the dependency search - * @param \PDO $dbh An already established database connection * * @return array All packages that depend on the specified package name */ @@ -186,7 +182,6 @@ function package_required($name="") { * Get the number of non-deleted comments for a specific package * * @param string $pkgid The package ID to get comment count for - * @param \PDO $dbh An already established database connection * * @return string The number of comments left for a specific package */ @@ -218,7 +213,6 @@ function package_comments_count($pkgid) { * Get all package comment information for a specific package * * @param int $pkgid The package ID to get comments for - * @param \PDO $dbh An already established database connection * * @return array All package comment information for a specific package */ @@ -260,7 +254,6 @@ function package_comments($pkgid) { * @param string $pkgid The package ID to add the comment on * @param string $uid The user ID of the individual who left the comment * @param string $comment The comment left on a package page - * @param \PDO $dbh An already established database connection * * @return void */ @@ -317,7 +310,6 @@ function add_package_comment($pkgid, $uid, $comment) { * Get all package sources for a specific package * * @param string $pkgid The package ID to get the sources for - * @param \PDO $dbh An already established database connection * * @return array All sources associated with a specific package */ @@ -346,7 +338,6 @@ function package_sources($pkgid) { * Get a list of all packages a logged-in user has voted for * * @param string $sid The session ID of the visitor - * @param \PDO $dbh An already established database connection * * @return array All packages the visitor has voted for */ @@ -374,7 +365,6 @@ function pkgvotes_from_sid($sid="") { * Determine package names from package IDs * * @param string|array $pkgids The package IDs to get names for - * @param \PDO $dbh An already established database connection * * @return array|string All names if multiple package IDs, otherwise package name */ @@ -415,7 +405,6 @@ function pkgname_from_id($pkgids) { * Determine if a package name is on the database blacklist * * @param string $name The package name to check - * @param \PDO $dbh An already established database connection * * @return bool True if the name is blacklisted, otherwise false */ @@ -435,7 +424,6 @@ function pkgname_is_blacklisted($name) { * Get the package details * * @param string $id The package ID to get description for - * @param \PDO $dbh An already established database connection * * @return array The package's details OR error message **/ @@ -473,7 +461,6 @@ function get_package_details($id=0) { * @param string $id The package ID to get details page for * @param array $row Package details retrieved by get_package_details * @param string $SID The session ID of the visitor - * @param \PDO $dbh An already established database connection * * @return void */ @@ -1137,7 +1124,6 @@ function pkg_vote ($atype, $ids, $action=true) { * Get all usernames and IDs that voted for a specific package * * @param string $pkgid The package ID to get all votes for - * @param \PDO $dbh An already established database connection * * @return array User IDs and usernames that voted for a specific package */ @@ -1169,7 +1155,6 @@ function getvotes($pkgid) { * * @param string $uid The user ID to check for an existing vote * @param string $pkgid The package ID to check for an existing vote - * @param \PDO $dbh An already established database connection * * @return bool True if the user has already voted, otherwise false */ @@ -1195,7 +1180,6 @@ function user_voted($uid, $pkgid) { * * @param string $uid User ID to check in the database * @param string $pkgid Package ID to check notifications for - * @param \PDO $dbh An already established database connection * * @return bool True if the user wants notifications, otherwise false */ @@ -1385,7 +1369,6 @@ function pkg_change_category($pid, $atype) { * Get all package information in the database for a specific package * * @param string $pkgname The name of the package to get details for - * @param \PDO $dbh An already established database connection * * @return array All package details for a specific package */ @@ -1411,7 +1394,6 @@ function pkgdetails_by_pkgname($pkgname) { * @param string $pkgdesc Description of the new package * @param string $pkgurl Upstream URL for the new package * @param int $uid User ID of the package uploader - * @param \PDO $dbh An already established database connection * * @return void */ @@ -1442,7 +1424,6 @@ function new_pkgdetails($pkgname, $license, $pkgver, $category_id, $pkgdesc, $pk * @param string $pkgurl The upstream URL for the package * @param int $uid The user ID of the updater * @param int $pkgid The package ID of the updated package - * @param \PDO $dbh An already established database connection * * @return void */ @@ -1469,7 +1450,6 @@ function update_pkgdetails($pkgname, $license, $pkgver, $pkgdesc, $pkgurl, $uid, * @param int $pkgid The package ID to add the dependency for * @param string $depname The name of the dependency to add * @param string $depcondition The type of dependency for the package - * @param \PDO $dbh An already established database connection * * @return void */ @@ -1490,7 +1470,6 @@ function add_pkg_dep($pkgid, $depname, $depcondition) { * * @param int $pkgid The package ID to add the source for * @param string $pkgsrc The package source to add to the database - * @param \PDO $dbh An already established database connection * * @return void */ @@ -1509,7 +1488,6 @@ function add_pkg_src($pkgid, $pkgsrc) { * * @param int $pkgid The package ID to change the category for * @param int $category_id The new category ID for the package - * @param \PDO $dbh An already established database connection * * @return void */ @@ -1528,7 +1506,6 @@ function update_pkg_category($pkgid, $category_id) { * Remove package dependencies from a specific package * * @param string $pkgid The package ID to remove package dependencies from - * @param \PDO $dbh An already established database connection * * @return void */ @@ -1545,7 +1522,6 @@ function remove_pkg_deps($pkgid) { * Remove package sources from a specific package * * @param string $pkgid The package ID to remove package sources from - * @param \PDO $dbh An already established database connection * * @return void */ diff --git a/web/lib/stats.inc.php b/web/lib/stats.inc.php index 3b7cb8f..e0e0b02 100644 --- a/web/lib/stats.inc.php +++ b/web/lib/stats.inc.php @@ -5,8 +5,6 @@ include_once('aur.inc.php'); /** * Display the most recent 10 packages * - * @param \PDO $dbh An already established database connection - * * @return void */ function updates_table() { @@ -29,7 +27,6 @@ function updates_table() { * Display a user's statistics table * * @param string $userid The user ID of the person to get package statistics for - * @param \PDO $dbh An already established database connection * * @return void */ @@ -49,8 +46,6 @@ function user_table($userid) { /** * Display the general package statistics table * - * @param \PDO $dbh An already established database connection - * * @return void */ function general_stats_table() { -- cgit v1.2.3-70-g09d2