stats.inc.php: Document all functions using PHPDoc format

Signed-off-by: canyonknight <canyonknight@gmail.com>
Signed-off-by: Lukas Fleischer <archlinux@cryptocrack.de>
This commit is contained in:
canyonknight 2012-09-23 15:12:01 -04:00 committed by Lukas Fleischer
parent 6fa2f99e71
commit 964ea083e6

View file

@ -2,6 +2,13 @@
include_once('aur.inc.php');
/**
* Display the most recent 10 packages
*
* @param \PDO $dbh An already established database connection
*
* @return void
*/
function updates_table($dbh) {
$key = 'recent_updates';
if(!($newest_packages = get_cache_value($key))) {
@ -17,6 +24,14 @@ function updates_table($dbh) {
include('stats/updates_table.php');
}
/**
* 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
*/
function user_table($userid, $dbh) {
$base_q = "SELECT count(*) FROM Packages WHERE Packages.MaintainerUID = " . $userid;
@ -34,6 +49,13 @@ function user_table($userid, $dbh) {
include('stats/user_table.php');
}
/**
* Display the general package statistics table
*
* @param \PDO $dbh An already established database connection
*
* @return void
*/
function general_stats_table($dbh) {
# AUR statistics
$q = "SELECT count(*) FROM Packages";