EGroupware / egroupware

phpgwapi/inc/adodb/adodb-datadict.inc.php

Doc Comments +35 added lines, -1 removed lines

@@ -196,18 +196,27 @@ 
 		return $this->connection->MetaTables();
 	}
 
+	/**
+	 * @return string
+	 */
 	function MetaColumns($tab, $upper=true, $schema=false)
 	{
 		if (!$this->connection->IsConnected()) return array();
 		return $this->connection->MetaColumns($this->TableName($tab), $upper, $schema);
 	}
 
+	/**
+	 * @param string $tab
+	 */
 	function MetaPrimaryKeys($tab,$owner=false,$intkey=false)
 	{
 		if (!$this->connection->IsConnected()) return array();
 		return $this->connection->MetaPrimaryKeys($this->TableName($tab), $owner, $intkey);
 	}
 
+	/**
+	 * @param string $table
+	 */
 	function MetaIndexes($table, $primary = false, $owner = false)
 	{
 		if (!$this->connection->IsConnected()) return array();
@@ -304,6 +313,11 @@ 
 		N:  Numeric or decimal number
 	*/
 
+	/**
+	 * @param string $meta
+	 *
+	 * @return string
+	 */
 	function ActualType($meta)
 	{
 		return $meta;
@@ -325,6 +339,10 @@ 
 	/*
 	 Generates the SQL to create index. Returns an array of sql strings.
 	*/
+
+	/**
+	 * @param string $tabname
+	 */
 	function CreateIndexSQL($idxname, $tabname, $flds, $idxoptions = false)
 	{
 		if (!is_array($flds)) {
@@ -339,6 +357,9 @@ 
 		return $this->_IndexSQL($this->NameQuote($idxname), $this->TableName($tabname), $flds, $this->_Options($idxoptions));
 	}
 
+	/**
+	 * @param string $tabname
+	 */
 	function DropIndexSQL ($idxname, $tabname = NULL)
 	{
 		return array(sprintf($this->dropIndex, $this->NameQuote($idxname), $this->TableName($tabname)));
@@ -349,6 +370,10 @@ 
 		$this->schema = $schema;
 	}
 
+	/**
+	 * @param string $tabname
+	 * @param string $flds
+	 */
 	function AddColumnSQL($tabname, $flds)
 	{
 		$tabname = $this->TableName ($tabname);
@@ -392,7 +417,7 @@ 
 	 * @param string $oldcolumn column-name to be renamed
 	 * @param string $newcolumn new column-name
 	 * @param string $flds='' complete column-defintion-string like for AddColumnSQL, only used by mysql atm., default=''
-	 * @return array with SQL strings
+	 * @return string[] with SQL strings
 	 */
 	function RenameColumnSQL($tabname,$oldcolumn,$newcolumn,$flds='')
 	{
@@ -433,6 +458,10 @@ 
 		return array (sprintf($this->dropTable, $this->TableName($tabname)));
 	}
 
+	/**
+	 * @param string $tabname
+	 * @param string $newname
+	 */
 	function RenameTableSQL($tabname,$newname)
 	{
 		return array (sprintf($this->renameTable, $this->TableName($tabname),$this->TableName($newname)));
@@ -613,6 +642,11 @@ 
 
 
 	// return string must begin with space
+
+	/**
+	 * @param boolean $fautoinc
+	 * @param boolean $funsigned
+	 */
 	function _CreateSuffix($fname,$ftype,$fnotnull,$fdefault,$fautoinc,$fconstraint,$funsigned)
 	{
 		$suffix = '';

phpgwapi/inc/adodb/adodb-error.inc.php

Doc Comments +4 added lines

@@ -55,6 +55,10 @@
 	return isset($ADODB_LANG_ARRAY[$value]) ? $ADODB_LANG_ARRAY[$value] : $ADODB_LANG_ARRAY[DB_ERROR];
 }
 
+/**
+ * @param string $provider
+ * @param string $dbType
+ */
 function adodb_error($provider,$dbType,$errno)
 {
 	//var_dump($errno);

phpgwapi/inc/adodb/adodb-iterator.inc.php

Doc Comments +3 added lines

@@ -25,6 +25,9 @@
 
     private $rs;
 
+    /**
+     * @param ADODB_BASE_RS $rs
+     */
     function __construct($rs) 
 	{
         $this->rs = $rs;

phpgwapi/inc/adodb/adodb-lib.inc.php

Doc Comments +28 added lines

@@ -32,6 +32,11 @@ 
 	return $an_array;
 }
 
+/**
+ * @param ADOConnection $zthis
+ * @param boolean $autoQuote
+ * @param boolean $has_autoinc
+ */
 function _adodb_replace(&$zthis, $table, $fieldArray, $keyCol, $autoQuote, $has_autoinc)
 {
 		if (count($fieldArray) == 0) return 0;
@@ -107,6 +112,9 @@ 
 }
 
 // Requires $ADODB_FETCH_MODE = ADODB_FETCH_NUM
+/**
+ * @param ADORecordSet $zthis
+ */
 function _adodb_getmenu(&$zthis, $name,$defstr='',$blank1stItem=true,$multiple=false,
 			$size=0, $selectAttr='',$compareFields0=true)
 {
@@ -193,6 +201,9 @@ 
 }
 
 // Requires $ADODB_FETCH_MODE = ADODB_FETCH_NUM
+/**
+ * @param ADORecordSet $zthis
+ */
 function _adodb_getmenu_gp(&$zthis, $name,$defstr='',$blank1stItem=true,$multiple=false,
 			$size=0, $selectAttr='',$compareFields0=true)
 {
@@ -376,6 +387,9 @@ 
 	data will get out of synch. use CachePageExecute() only with tables that
 	rarely change.
 */
+/**
+ * @param ADOConnection $zthis
+ */
 function &_adodb_pageexecute_all_rows(&$zthis, $sql, $nrows, $page, 
 						$inputarr=false, $secs2cache=0) 
 {
@@ -430,6 +444,9 @@ 
 }
 
 // Iván Oliva version
+/**
+ * @param ADOConnection $zthis
+ */
 function &_adodb_pageexecute_no_last_page(&$zthis, $sql, $nrows, $page, $inputarr=false, $secs2cache=0) 
 {
 
@@ -480,6 +497,9 @@ 
 	return $rsreturn;
 }
 
+/**
+ * @param ADOConnection $zthis
+ */
 function _adodb_getupdatesql(&$zthis,&$rs, $arrFields,$forceUpdate=false,$magicq=false,$force=2)
 {
 		if (!$rs) {
@@ -615,6 +635,9 @@ 
 	}
 }
 
+/**
+ * @param string $key
+ */
 function adodb_key_exists($key, &$arr,$force=2)
 {
 	if ($force<=0) {
@@ -634,6 +657,7 @@ 
  * a returning clause with bind variables and a descriptor blob.
  * 
  * 
+ * @param ADOConnection $zthis
  */
 function _adodb_getinsertsql(&$zthis,&$rs,$arrFields,$magicq=false,$force=2)
 {
@@ -898,6 +922,10 @@ 
 
 
 
+/**
+ * @param ADOConnection $zthis
+ * @param boolean $inputarr
+ */
 function _adodb_debug_execute(&$zthis, $sql, $inputarr)
 {
 	$ss = '';

phpgwapi/inc/adodb/adodb-pager.inc.php

Doc Comments +6 added lines

@@ -273,6 +273,12 @@
 	
 	//------------------------------------------------------
 	// override this to control overall layout and formating
+
+	/**
+	 * @param string $header
+	 * @param string $grid
+	 * @param string $footer
+	 */
 	function RenderLayout($header,$grid,$footer,$attributes='border=1 bgcolor=beige')
 	{
 		echo "<table ".$attributes."><tr><td>",

phpgwapi/inc/adodb/adodb-perf.inc.php

Doc Comments +13 added lines, -3 removed lines

@@ -48,6 +48,9 @@ 
 }
 
 // avoids localization problems where , is used instead of .
+/**
+ * @param integer $prec
+ */
 function adodb_round($n,$prec)
 {
 	return number_format($n, $prec, '.', '');
@@ -547,6 +550,10 @@ 
 	/*
 		Raw function to return parameter value from $settings.
 	*/
+
+	/**
+	 * @param string $param
+	 */
 	function DBParameter($param)
 	{
 		if (empty($this->settings[$param])) return false;
@@ -949,6 +956,9 @@ 
 		return $arr;
 	}
 	
+	/**
+	 * @param string $m
+	 */
 	function undomq(&$m) 
 	{
 	if (get_magic_quotes_gpc()) {
@@ -984,7 +994,7 @@ 
      *      <code>ADODB_OPT_LOW</code> for CPU-less optimization
      *      Default is LOW <code>ADODB_OPT_LOW</code> 
      * @author Markus Staab
-     * @return Returns <code>true</code> on success and <code>false</code> on error
+     * @return false|null <code>true</code> on success and <code>false</code> on error
      */
     function OptimizeTables()
     {
@@ -1015,7 +1025,7 @@ 
      *      <code>ADODB_OPT_LOW</code> for CPU-less optimization
      *      Default is LOW <code>ADODB_OPT_LOW</code> 
      * @author Markus Staab
-     * @return Returns <code>true</code> on success and <code>false</code> on error
+     * @return boolean <code>true</code> on success and <code>false</code> on error
      */
     function OptimizeTable( $table, $mode = ADODB_OPT_LOW) 
     {
@@ -1029,7 +1039,7 @@ 
      * optimize each using <code>optmizeTable()</code>
      * 
      * @author Markus Staab
-     * @return Returns <code>true</code> on success and <code>false</code> on error
+     * @return boolean <code>true</code> on success and <code>false</code> on error
      */
     function optimizeDatabase() 
     {

phpgwapi/inc/adodb/adodb-time.inc.php

Doc Comments +7 added lines

@@ -376,6 +376,10 @@ 
 
 if (!defined('ADODB_ALLOW_NEGATIVE_TS')) define('ADODB_NO_NEGATIVE_TS',1);
 
+/**
+ * @param integer $y1
+ * @param integer $m
+ */
 function adodb_date_test_date($y1,$m,$d=13)
 {
 	$t = adodb_mktime(0,0,0,$m,$d,$y1);
@@ -387,6 +391,9 @@ 
 	return true;
 }
 
+/**
+ * @param string $fmt
+ */
 function adodb_date_test_strftime($fmt)
 {
 	$s1 = strftime($fmt);

phpgwapi/inc/adodb/adodb-xmlschema.inc.php

Doc Comments +13 added lines, -28 removed lines

@@ -231,8 +231,7 @@ 
 	/**
 	* Iniitializes a new table object.
 	*
-	* @param string $prefix DB Object prefix
-	* @param array $attributes Array of table attributes.
+	* @param adoSchema $parent
 	*/
 	function dbTable( &$parent, $attributes = NULL ) {
 		$this->parent =& $parent;
@@ -346,7 +345,7 @@ 
 	* Adds an index to a table object
 	*
 	* @param array $attributes Index attributes
-	* @return object dbIndex object
+	* @return dbIndex dbIndex object
 	*/
 	function &addIndex( $attributes ) {
 		$name = strtoupper( $attributes['NAME'] );
@@ -446,7 +445,7 @@ 
 	* and appends them to the table object.
 	*
 	* @param string $opt Table option
-	* @return array Options
+	* @return string[] Options
 	*/
 	function addTableOpt( $opt ) {
 		$this->opts[] = $opt;
@@ -621,7 +620,7 @@ 
 	/**
 	* Initializes the new dbIndex object.
 	*
-	* @param object $parent Parent object
+	* @param dbTable $parent Parent object
 	* @param array $attributes Attributes
 	*
 	* @internal
@@ -710,7 +709,7 @@ 
 	* Adds options to the index
 	*
 	* @param string $opt Comma-separated list of index options.
-	* @return string Option list
+	* @return string[] Option list
 	*/
 	function addIndexOpt( $opt ) {
 		$this->opts[] = $opt;
@@ -765,7 +764,7 @@ 
 	/**
 	* Initializes the new dbIndex object.
 	*
-	* @param object $parent Parent object
+	* @param dbTable $parent Parent object
 	* @param array $attributes Attributes
 	*
 	* @internal
@@ -833,8 +832,6 @@ 
 	/**
 	* Adds a field to the index
 	*
-	* @param string $name Field name
-	* @return string Field list
 	*/
 	function addField( $attributes ) {
 		if( isset( $attributes['NAME'] ) ) {
@@ -850,8 +847,6 @@ 
 	/**
 	* Adds options to the index
 	*
-	* @param string $opt Comma-separated list of index options.
-	* @return string Option list
 	*/
 	function addData( $cdata ) {
 		if( !isset( $this->data[$this->row] ) ) {
@@ -966,7 +961,7 @@ 
 	/**
 	* Initializes the query set.
 	*
-	* @param object $parent Parent object
+	* @param adoSchema $parent Parent object
 	* @param array $attributes Attributes
 	*/
 	function dbQuerySet( &$parent, $attributes = NULL ) {
@@ -1080,8 +1075,6 @@ 
 	/** 
 	* Appends a line to a query that is being built line by line
 	*
-	* @param string $data Line of SQL data or NULL to initialize a new query
-	* @return string SQL query string.
 	*/
 	function buildQuery( $sql = NULL ) {
 		if( !isset( $this->query ) OR empty( $sql ) ) {
@@ -1394,9 +1387,6 @@ 
 	* the filesystem and generate the SQL necessary to create the database described. 
 	* @see ParseSchemaString()
 	*
-	* @param string $file Name of XML schema file.
-	* @param bool $returnSchema Return schema rather than parsing.
-	* @return array Array of SQL queries, ready to execute
 	*/
 	function ParseSchema( $filename, $returnSchema = FALSE ) {
 		return $this->ParseSchemaString( $this->ConvertSchemaFile( $filename ), $returnSchema );
@@ -1408,12 +1398,6 @@ 
 	* Call this method to load the specified schema from a file (see the DTD for the proper format) 
 	* and generate the SQL necessary to create the database described by the schema.
 	*
-	* @param string $file Name of XML schema file.
-	* @param bool $returnSchema Return schema rather than parsing.
-	* @return array Array of SQL queries, ready to execute.
-	*
-	* @deprecated Replaced by adoSchema::ParseSchema() and adoSchema::ParseSchemaString()
-	* @see ParseSchema(), ParseSchemaString()
 	*/
 	function ParseSchemaFile( $filename, $returnSchema = FALSE ) {
 		// Open the file
@@ -1502,9 +1486,6 @@ 
 	* the filesystem and generate the SQL necessary to remove the database described.
 	* @see RemoveSchemaString()
 	*
-	* @param string $file Name of XML schema file.
-	* @param bool $returnSchema Return schema rather than parsing.
-	* @return array Array of SQL queries, ready to execute
 	*/
 	function RemoveSchema( $filename, $returnSchema = FALSE ) {
 		return $this->RemoveSchemaString( $this->ConvertSchemaFile( $filename ), $returnSchema );
@@ -1582,7 +1563,7 @@ 
 	* parsed XML schema) to the filesystem.
 	*
 	* @param string $filename Path and name where the file should be saved.
-	* @return boolean TRUE if save is successful, else FALSE. 
+	* @return false|null TRUE if save is successful, else FALSE. 
 	*/
 	function SaveSQL( $filename = './schema.sql' ) {
 		
@@ -1604,7 +1585,7 @@ 
 	/**
 	* Create an xml parser
 	*
-	* @return object PHP XML parser object
+	* @return resource PHP XML parser object
 	*
 	* @access private
 	*/
@@ -1748,6 +1729,10 @@ 
 		return $result;
 	}
 	
+	/**
+	 * @param string $schema
+	 * @param string $xsl
+	 */
 	function TransformSchema( $schema, $xsl, $schematype='string' )
 	{
 		// Fail if XSLT extension is not available

phpgwapi/inc/adodb/datadict/datadict-postgres.inc.php

Doc Comments +6 added lines

@@ -86,6 +86,9 @@ 
 		}
 	}
 
+ 	/**
+ 	 * @param string $meta
+ 	 */
  	function ActualType($meta)
 	{
 		switch($meta) {
@@ -261,6 +264,9 @@ 
 		return $aSql;
 	}
 
+	/**
+	 * @param string $tabname
+	 */
 	function DropTableSQL($tabname)
 	{
 		$sql = ADODB_DataDict::DropTableSQL($tabname);