BOINC / boinc

html/inc/boinc_db.inc

Doc Comments +117 added lines

@@ -40,6 +40,10 @@ 
     // 2: only use replica_db_user, only try replica_db_host
     // can be set projectwide using <replica_fallback_mode>
     //
+
+    /**
+     * @param boolean $readonly
+     */
     static function get_aux($readonly, $fallback_mode = 0) {
         $config = get_config();
         $user = parse_config($config, '<db_user>');
@@ -204,6 +208,10 @@ 
         $db = BoincDb::get();
         return $db->count('user', $clause);
     }
+
+    /**
+     * @param string $field
+     */
     static function max($field) {
         $db = BoincDb::get();
         return $db->max('user', $field);
@@ -216,6 +224,10 @@ 
         $db = BoincDb::get();
         return $db->enum('user', 'BoincUser', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -233,10 +245,19 @@ 
         $db->delete_aux('profile', "userid=$this->id");
         return $db->delete($this, 'user');
     }
+
+    /**
+     * @param string $field
+     */
     static function sum($field) {
         $db = BoincDb::get();
         return $db->sum('user', $field);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function percentile($field, $clause, $pct) {
         $db = BoincDb::get();
         return $db->percentile('user', $field, $clause, $pct);
@@ -245,6 +266,10 @@ 
 
 class BoincTeam {
     static $cache;
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         $ret = $db->insert('team', $clause);
@@ -282,14 +307,27 @@ 
         $db = BoincDb::get();
         return $db->delete($this, 'team');
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function percentile($field, $clause, $pct) {
         $db = BoincDb::get();
         return $db->percentile('team', $field, $clause, $pct);
     }
+
+    /**
+     * @param string $field
+     */
     static function max($field) {
         $db = BoincDb::get();
         return $db->max('team', $field);
     }
+
+    /**
+     * @param string $fields
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -326,6 +364,12 @@ 
         $db = BoincDb::get();
         return $db->enum('host', 'BoincHost', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -358,6 +402,10 @@ 
         $db = BoincDb::get();
         return $db->enum('result', 'BoincResult', $where_clause);
     }
+
+	/**
+	 * @param string $fields
+	 */
 	static function enum_fields($fields, $where_clause, $order_clause) {
         $db = BoincDb::get();
 		return $db->enum_fields('result', 'BoincResult', $fields, $where_clause, $order_clause);
@@ -412,6 +460,10 @@ 
         $db = BoincDb::get();
         return $db->update_aux('workunit', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function count($clause) {
         $db = BoincDb::get();
         return $db->count('workunit', $clause);
@@ -427,6 +479,10 @@ 
         $db = BoincDb::get();
         return $db->lookup('app', 'BoincApp', $clause);
     }
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('app', 'BoincApp', $where_clause);
@@ -441,6 +497,11 @@ 
         $db = BoincDb::get();
         return $db->update($this, 'app', $clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause=null) {
         $db = BoincDb::get();
         return $db->sum('app', $field, $clause);
@@ -473,6 +534,10 @@ 
 }
 
 class BoincProfile {
+
+    /**
+     * @param string $fields
+     */
     static function lookup_fields($fields, $clause) {
         $db = BoincDb::get();
         return $db->lookup_fields('profile', 'BoincProfile', $fields, $clause);
@@ -489,18 +554,37 @@ 
         $db = BoincDb::get();
         return $db->update_aux('profile', $clause.' where userid='.$this->userid);
     }
+
+    /**
+     * @param string $clause
+     */
     static function update_aux($clause) {
         $db = BoincDb::get();
         return $db->update_aux('profile', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         return $db->insert('profile', $clause);
     }
+
+    /**
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum($where_clause=null, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum('profile', 'BoincProfile', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum_fields($fields, $where_clause=null, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields('profile', 'BoincProfile', $fields, $where_clause, $order_clause);
@@ -568,6 +652,10 @@ 
 }
 
 class BoincPlatform {
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('platform', 'BoincPlatform', $where_clause);
@@ -648,6 +736,10 @@ 
 }
 
 class BoincBadge {
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('badge', 'BoincBadge', $where_clause);
@@ -743,6 +835,11 @@ 
         $db = BoincDb::get();
         return $db->enum('credit_user', 'BoincCreditUser', $where_clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause) {
         $db = BoincDb::get();
         return $db->sum('credit_user', $field, $clause);
@@ -755,6 +852,11 @@ 
         $db = BoincDb::get();
         $db->delete_aux('credit_user', "userid=$user->id");
     }
+
+    /**
+     * @param string $order_clause
+     * @param string $limit
+     */
     static function get_list($where_clause, $order_clause, $limit) {
         $db = BoincDB::get();
         return $db->get_list('user', 'credit_user', 'id', 'userid', 'BoincCreditUser', '*', $where_clause, $order_clause, $limit);
@@ -770,6 +872,11 @@ 
         $db = BoincDb::get();
         return $db->enum('credit_team', 'BoincCreditTeam', $where_clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause) {
         $db = BoincDb::get();
         return $db->sum('credit_team', $field, $clause);
@@ -778,6 +885,11 @@ 
         $db = BoincDb::get();
         return $db->update_aux('credit_team', $clause);
     }
+
+    /**
+     * @param string $order_clause
+     * @param string $limit
+     */
     static function get_list($where_clause, $order_clause, $limit) {
         $db = BoincDB::get();
         return $db->get_list('team', 'credit_team', 'id', 'teamid', 'BoincCreditTeam', '*', $where_clause, $order_clause, $limit);
@@ -788,6 +900,11 @@ 
 // 
 // apply this to any user-supplied strings used in queries
 // 
+/**
+ * @param string $x
+ *
+ * @return string
+ */
 function boinc_real_escape_string($x) {
     if (version_compare(phpversion(),"4.3.0")>=0) {
         return BoincDb::escape_string($x);

html/inc/db_conn.inc

Doc Comments +58 added lines

@@ -26,6 +26,9 @@ 
     var $db_name;
     var $readonly;
 
+    /**
+     * @param boolean $readonly
+     */
     function init_conn($user, $passwd, $host, $name, $readonly) {
         if (MYSQLI) {
             $x = explode(":", $host);
@@ -92,6 +95,14 @@ 
         }
     }
 
+    /**
+     * @param string $table1
+     * @param string $table2
+     * @param string $joinfield1
+     * @param string $joinfield2
+     * @param string $classname
+     * @param string $fields
+     */
     function get_list($table1, $table2, $joinfield1, $joinfield2, $classname, $fields, $where_clause, $order_clause, $limit) {
         $query = "select $fields from DBNAME.$table1 a join DBNAME.$table2 b on a.$joinfield1=b.$joinfield2 where $where_clause order by $order_clause desc limit $limit";
         $result = $this->do_query($query);
@@ -131,6 +142,10 @@ 
         return $this->lookup_fields($table, $classname, "*", $clause);
     }
 
+    /**
+     * @param string $table
+     * @param string $classname
+     */
     function lookup_id($id, $table, $classname) {
         $id = (int)$id;
         return $this->lookup($table, $classname, "id=$id");
@@ -165,28 +180,51 @@ 
         return $this->enum_general($classname,$query);
     }
 
+    /**
+     * @param string $table
+     * @param string $classname
+     */
     function enum($table, $classname, $where_clause=null, $order_clause=null) {
         return self::enum_fields(
             $table, $classname, '*', $where_clause, $order_clause
         );
     }
 
+    /**
+     * @param string $table
+     */
     function update($obj, $table, $clause) {
         $query = "update DBNAME.$table set $clause where id=$obj->id";
         return $this->do_query($query);
     }
+
+    /**
+     * @param string $table
+     */
     function update_aux($table, $clause) {
         $query = "update DBNAME.$table set $clause";
         return $this->do_query($query);
     }
+
+    /**
+     * @param string $table
+     */
     function insert($table, $clause) {
         $query = "insert into DBNAME.$table $clause";
         return $this->do_query($query);
     }
+
+    /**
+     * @param string $table
+     */
     function delete($obj, $table) {
         $query = "delete from DBNAME.$table where id=$obj->id";
         return $this->do_query($query);
     }
+
+    /**
+     * @param string $table
+     */
     function delete_aux($table, $clause) {
         $query = "delete from DBNAME.$table where $clause";
         return $this->do_query($query);
@@ -198,6 +236,10 @@ 
             return mysql_insert_id($this->db_conn);
         }
     }
+
+    /**
+     * @param string $field
+     */
     function get_int($query, $field) {
         $result = $this->do_query($query);
         if (!$result) error_page("database error on query $query");
@@ -228,14 +270,26 @@ 
         $query = "select count(*) as total from DBNAME.$table where $clause";
         return $this->get_int($query, 'total');
     }
+
+    /**
+     * @param string $table
+     */
     function sum($table, $field, $clause="") {
         $query = "select sum($field) as total from DBNAME.$table $clause";
         return $this->get_double($query, 'total');
     }
+
+    /**
+     * @param string $table
+     */
     function max($table, $field, $clause="") {
         $query = "select max($field) as total from DBNAME.$table $clause";
         return $this->get_double($query, 'total');
     }
+
+    /**
+     * @param string $table
+     */
     function percentile($table, $field, $clause, $pct) {
         $n = $this->count($table, $clause);
         if (!$n) return false;
@@ -243,6 +297,10 @@ 
         $query = "select $field from DBNAME.$table where $clause order by $field limit $m,1";
         return $this->get_double($query, $field);
     }
+
+    /**
+     * @param string $table
+     */
     function replace($table, $clause) {
         $query = "replace into DBNAME.$table set $clause";
         return $this->do_query($query);

html/user/per_app_list.php

Doc Comments +3 added lines

@@ -38,6 +38,9 @@
 // return a column title (Average or Total),
 // hyperlinked if this is not the current sort column
 //
+/**
+ * @param integer $i
+ */
 function col_title($is_team, $app, $appid, $is_total, $i) {
     $x = $i ? tra("Total") : tra("Average");
     if ($app->id == $appid && ($is_total ? $i : !$i)) {