Enalean / tuleap

plugins/fusionforge_compat/include/arc/store/ARC2_RemoteStore.php

Doc Comments +3 added lines

@@ -58,6 +58,9 @@
   
   /*  */
   
+  /**
+   * @param string $q
+   */
   function query($q, $result_format = '', $src = '', $keep_bnode_ids = 0, $log_query = 0) {
     if ($log_query) $this->logQuery($q);
     ARC2::inc('SPARQLPlusParser');

plugins/fusionforge_compat/include/arc/store/ARC2_Store.php

Doc Comments +24 added lines

@@ -92,6 +92,9 @@ 
   
   /*  */
   
+  /**
+   * @return string
+   */
   function getCollation() {
     $rs = $this->queryDB('SHOW TABLE STATUS LIKE "' . $this->getTablePrefix(). 'setting"', $this->getDBCon());
     return ($rs && ($row = mysql_fetch_array($rs)) && isset($row['Collation'])) ? $row['Collation'] : '';
@@ -109,6 +112,9 @@ 
 
   /*  */
 
+  /**
+   * @param string $tbl
+   */
   function hasHashColumn($tbl) {
     $var_name = 'has_hash_column_' . $tbl;
     if (!isset($this->$var_name)) {
@@ -203,6 +209,9 @@ 
     return ($rs && ($row = mysql_fetch_array($rs))) ? 1 : 0;
   }
   
+  /**
+   * @param string $k
+   */
   function getSetting($k, $default = 0) {
     $tbl = $this->getTablePrefix() . 'setting';
     $sql = "SELECT val FROM " . $tbl . " WHERE k = '" .md5($k). "'";
@@ -213,6 +222,9 @@ 
     return $default;
   }
   
+  /**
+   * @param string $k
+   */
   function setSetting($k, $v) {
     $con = $this->getDBCon();
     $tbl = $this->getTablePrefix() . 'setting';
@@ -225,6 +237,9 @@ 
     return $this->queryDB($sql, $con);
   }
   
+  /**
+   * @param string $k
+   */
   function removeSetting($k) {
     $tbl = $this->getTablePrefix() . 'setting';
     return $this->queryDB("DELETE FROM " . $tbl . " WHERE k = '" . md5($k) . "'", $this->getDBCon());
@@ -376,6 +391,9 @@ 
   
   /*  */
   
+  /**
+   * @param string $q
+   */
   function query($q, $result_format = '', $src = '', $keep_bnode_ids = 0, $log_query = 0) {
     if ($log_query) $this->logQuery($q);
     $con = $this->getDBCon();
@@ -464,6 +482,9 @@ 
     return abs(crc32($val));
   }
 
+  /**
+   * @return resource|null
+   */
   function getTermID($val, $term = '') {
     $tbl = preg_match('/^(s|o)$/', $term) ? $term . '2val' : 'id2val';
     $con = $this->getDBCon();
@@ -605,6 +626,9 @@ 
     );
   }
   
+  /**
+   * @param string[] $ps
+   */
   function inferLabelProps($ps) {
     $this->query('DELETE FROM <label-properties>');
     $sub_q = '';

plugins/fusionforge_compat/include/arc/store/ARC2_StoreDumper.php

Doc Comments +6 added lines

@@ -82,6 +82,9 @@ 
 
   /*  */
 
+  /**
+   * @param string $q
+   */
   function saveCustomSPOG($path, $q) {
     if (!$fp = @fopen($path, 'w')) return $this->addError('Could not create backup file at ' . realpath($path));
     fwrite($fp, $this->getHeader());
@@ -95,6 +98,9 @@ 
   
   /*  */
 
+  /**
+   * @param integer $offset
+   */
   function getRecordset($offset) {
     $prefix = $this->store->getTablePrefix();
     $con = $this->store->getDBCon();

plugins/fusionforge_compat/include/arc/store/ARC2_StoreEndpoint.php

Doc Comments +13 added lines

@@ -33,6 +33,9 @@ 
 
   /*  */
   
+  /**
+   * @return string
+   */
   function getQueryString($mthd = '') {
     $r = '';
     if (!$mthd || ($mthd == 'post')) {
@@ -65,6 +68,10 @@ 
     return $this->v1('endpoint_features', array(), $this->a);
   }
 
+  /**
+   * @param string $k
+   * @param string $v
+   */
   function setHeader($k, $v) {
     $this->headers[$k] = $v;
   }
@@ -78,6 +85,9 @@ 
     }
   }
   
+  /**
+   * @return string
+   */
   function getResult() {
     return $this->result;
   }
@@ -289,6 +299,9 @@ 
   
   /*  */
 
+  /**
+   * @param string $default
+   */
   function getResultFormat($formats, $default) {
     $prefs = array();
     /* arg */

plugins/fusionforge_compat/include/arc/store/ARC2_StoreLoadQueryHandler.php

Doc Comments +7 added lines

@@ -179,6 +179,10 @@ 
     return 1;
   }
 
+  /**
+   * @param string $type_id
+   * @param string $tbl
+   */
   function getTermID($val, $type_id, $tbl) {
     $con = $this->store->getDBCon();
     /* buffered */
@@ -415,6 +419,9 @@ 
     return 1;
   }
 
+  /**
+   * @param string $er
+   */
   function autoRepairTable($er, $con, $sql = '') {
     $this->addError('MySQL error: ' . $er . ' (' . $sql . ')');
     if (preg_match('/Table \'[^\']+\/([a-z0-9\_\-]+)\' .*(crashed|repair)/i', $er, $m)) {

plugins/fusionforge_compat/include/arc/store/ARC2_StoreQueryHandler.php

Doc Comments +3 added lines

@@ -35,6 +35,9 @@
     return $this->store->getTermID($val, $term);
   }
 
+  /**
+   * @param string $tbl
+   */
   function hasHashColumn($tbl) {
     return $this->store->hasHashColumn($tbl);
   }

plugins/fusionforge_compat/include/arc/store/ARC2_StoreSelectQueryHandler.php

Doc Comments +15 added lines

@@ -141,6 +141,9 @@ 
     );
   }
 
+  /**
+   * @param string $tmp_tbl
+   */
   function getTempTableDef($tmp_tbl, $q_sql) {
     $col_part = preg_replace('/^SELECT\s*(DISTINCT)?(.*)FROM.*$/s', '\\2', $q_sql);
     $parts = explode(',', $col_part);
@@ -217,6 +220,9 @@ 
   
   /*  */
   
+  /**
+   * @param integer $id
+   */
   function buildIndex($pattern, $id) {
     $pattern['id'] = $id;
     $type = $this->v('type', '', $pattern);
@@ -407,6 +413,9 @@ 
     return $pn['id'];
   }
   
+  /**
+   * @param string $id
+   */
   function sameOptional($id, $id2) {
     return $this->getOptionalPattern($id) == $this->getOptionalPattern($id2);
   }
@@ -907,6 +916,9 @@ 
 
   /*  */
   
+  /**
+   * @param string $sql
+   */
   function addConstraintSQLEntry($id, $sql) {
     if (!isset($this->index['constraints'][$id])) {
       $this->index['constraints'][$id] = array();
@@ -1464,6 +1476,9 @@ 
     return $tbl_alias . ' IS NOT NULL';
   }
 
+  /**
+   * @param integer $type
+   */
   function getHasTypeCallSQL($pattern, $context, $type) {
     $r = '';
     $var = $pattern['args'][0]['value'];

plugins/fusionforge_compat/include/fusionforge/RBAC.php

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
         return new RBACEngine();
     }
     
+    /**
+     * @param PFUser|null $user_obj
+     */
     function getAvailableRolesForUser($user_obj) {
         return array();
     }

plugins/fusionforge_compat/include/fusionforge/user_get_object_by_name.php

Doc Comments +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
  *
  * @param	string	The unix username - required
  * @param	int	The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
- * @return	a user object or false on failure
+ * @return	PFUser|null user object or false on failure
  */
 function user_get_object_by_name($user_name, $res = false) {
     return UserManager::instance()->getUserByIdentifier($user_name);