EGroupware / egroupware

api/src/Db.php

Doc Comments +4 added lines, -12 removed lines

@@ -371,7 +371,7 @@ 
 	 * require_once(EGW_INCLUDE_ROOT.'/api/src/Db.php');
 	 * EGroupware\Api\Db::$health_check = array('EGroupware\Api\Db', 'galera_cluster_health');
 	 *
-	 * @param Api\Db $db already connected Api\Db instance to check
+	 * @param Db $db already connected Api\Db instance to check
 	 * @throws Db\Exception\Connection if node should NOT be used
 	 */
 	static function galera_cluster_health(Db $db)
@@ -1077,7 +1077,6 @@ 
 	 *
 	 * Example: $db->concat($db->quote('Hallo '),'username') would return
 	 *	for mysql "concat('Hallo ',username)" or "'Hallo ' || username" for postgres
-	 * @param string $str1 already quoted stringliteral or column-name, variable number of arguments
 	 * @return string to be used in a query
 	 */
 	function concat(/*$str1, ...*/)
@@ -1097,7 +1096,7 @@ 
 	 * @param string $expr column-name or expression optional prefixed with "DISTINCT"
 	 * @param string $order_by ='' optional order
 	 * @param string $separator =',' optional separator, default is comma
-	 * @return string|boolean false if not supported by dbms
+	 * @return false|string false if not supported by dbms
 	 */
 	function group_concat($expr, $order_by='', $separator=',')
 	{
@@ -1430,7 +1429,7 @@ 
 	*	array('visits=visits+1') gives just "visits=visits+1" (no quoting at all !!!)
 	* @param boolean|string $use_key If $use_key===True a "$key=" prefix each value (default), typically set to False
 	*	or 'VALUES' for insert querys, on 'VALUES' "(key1,key2,...) VALUES (val1,val2,...)" is returned
-	* @param array|boolean $only if set to an array only colums which are set (as data !!!) are written
+	* @param boolean $only if set to an array only colums which are set (as data !!!) are written
 	*	typicaly used to form a WHERE-clause from the primary keys.
 	*	If set to True, only columns from the colum_definitons are written.
 	* @param array|boolean $column_definitions this can be set to the column-definitions-array
@@ -1910,13 +1909,6 @@ 
 	 * gives "(name='test\'ed' AND lang='en') OR 'owner' IN (0,4,5,6,10)" if name,lang are strings and owner is an integer
 	 *
 	 * @param string|array $table_def table-name or definition array
-	 * @param mixed $args variable number of arguments of the following types:
-	 *	string: get's as is into the result
-	 *	array:	column-name / value pairs: the value gets quoted according to the type of the column and prefixed
-	 *		with column-name=, multiple pairs are AND'ed together, see db::column_data_implode
-	 *	bool: If False or is_null($arg): the next 2 (!) arguments gets ignored
-	 *
-	 * Please note: As the function has a variable number of arguments, you CAN NOT add further parameters !!!
 	 *
 	 * @return string the expression generated from the arguments
 	 */
@@ -2054,7 +2046,7 @@ 
 	 * Strip eg. a prefix from the keys of an array
 	 *
 	 * @param array $arr
-	 * @param string|array $strip
+	 * @param string $strip
 	 * @return array
 	 */
 	static function strip_array_keys($arr,$strip)

api/src/Db/Backup.php

Doc Comments +3 added lines, -2 removed lines

@@ -496,7 +496,7 @@ 
 	 * Restore data from a (compressed) csv file
 	 *
 	 * @param resource $f file opened with fopen for reading
-	 * @param int|string $insert_n_rows =10 how many rows to insert in one sql statement, or string with column-name used as unique key for insert
+	 * @param integer $insert_n_rows =10 how many rows to insert in one sql statement, or string with column-name used as unique key for insert
 	 * @returns int number of rows read from csv file
 	 */
 	function db_restore($f, $insert_n_rows=10)
@@ -1044,7 +1044,7 @@ 
 	/**
 	 * Backup all schemas in the form of a setup/tables_current.inc.php file
 	 *
-	 * @param resource|boolean $f
+	 * @param resource $f
 	 */
 	function schema_backup($f=False)
 	{
@@ -1089,6 +1089,7 @@ 
 	 * Dump an array as php source
 	 *
 	 * copied from etemplate/inc/class.db_tools.inc.php
+	 * @param integer $depth
 	 */
 	private static function write_array($arr,$depth,$parent='')
 	{

api/src/Db/CallbackIterator.php

Doc Comments +2 added lines, -2 removed lines

@@ -94,10 +94,10 @@
 	/**
 	 * Constructor
 	 *
-	 * @param Traversable $rs
+	 * @param \Traversable $rs
 	 * @param callback $callback
 	 * @param array $params =array() additional parameters, row is always first parameter
-	 * @param $key_callback =null optional callback, if you want different keys
+	 * @param \Closure $key_callback =null optional callback, if you want different keys
 	 */
 	public function __construct(\Traversable $rs, $callback, $params=array(), $key_callback=null)
 	{

api/src/Db/Deprecated.php

Doc Comments +2 added lines, -2 removed lines

@@ -185,7 +185,7 @@ 
 	* @deprecated not used anymore as it costs to much performance, use transactions if needed
 	* @param string $table name of table to lock
 	* @param string $mode type of lock required (optional), default write
-	* @return bool True if sucessful, False if fails
+	* @return boolean|null True if sucessful, False if fails
 	*/
 	function lock($table, $mode='write')
 	{
@@ -196,7 +196,7 @@ 
 	* Unlock a table
 	*
 	* @deprecated not used anymore as it costs to much performance, use transactions if needed
-	* @return bool True if sucessful, False if fails
+	* @return boolean|null True if sucessful, False if fails
 	*/
 	function unlock()
 	{}

api/src/Db/Schema.php

Doc Comments +7 added lines, -14 removed lines

@@ -96,7 +96,7 @@ 
 	 * Constructor of schema-processor
 	 *
 	 * @param string $dbms type of the database: 'mysql','pgsql','mssql','maxdb'
-	 * @param Db $db =null database class, if null we use $GLOBALS['egw']->db
+	 * @param  $db =null database class, if null we use $GLOBALS['egw']->db
 	 * @return schema_proc
 	 */
 	function __construct($dbms=False, Api\Db $db=null)
@@ -396,7 +396,7 @@ 
 	 *
 	 * @param string $sTableName
 	 * @param bool $preserveValue
-	 * @return boolean|string sequence-name or false
+	 * @return false|string sequence-name or false
 	 */
 	function _PostgresHasOldSequence($sTableName,$preserveValue=False)
 	{
@@ -422,7 +422,7 @@ 
 	/**
 	 * Check if we have an old, not automaticaly droped sequence and drop it
 	 *
-	 * @param $sTableName
+	 * @param string $sTableName
 	 */
 	function _PostgresTestDropOldSequence($sTableName)
 	{
@@ -877,12 +877,7 @@ 
 	/**
 	* Execute a query
 	*
-	* @param string $Query_String the query to be executed
-	* @param mixed $line the line method was called from - use __LINE__
-	* @param string $file the file method was called from - use __FILE__
-	* @param int $offset row to start from
-	* @param int $num_rows number of rows to return (optional), if unset will use $GLOBALS['phpgw_info']['user']['preferences']['common']['maxmatchs']
-	* @return ADORecordSet or false, if the query fails
+	* @param integer $line
 	*/
 	function query($sQuery, $line='', $file='')
 	{
@@ -898,8 +893,6 @@ 
 	*	if the row exists db::update is called else a new row with $date merged with $where gets inserted (data has precedence)
 	* @param int $line line-number to pass to query
 	* @param string $file file-name to pass to query
-	* @param string $app=false string with name of app, this need to be set in setup anyway!!!
-	* @return ADORecordSet or false, if the query fails
 	*/
 	function insert($table,$data,$where,$line,$file,$app=False,$use_prepared_statement=false)
 	{
@@ -910,7 +903,6 @@ 
 	 * Execute the Sql statements in an array and give diagnostics, if any error occures
 	 *
 	 * @param array $aSql array of SQL strings to execute
-	 * @param int $debug_level for which debug_level (and higher) should the diagnostics always been printed
 	 * @param string $debug variable number of arguments for the debug_message functions in case of an error
 	 * @return int 2: no error, 1: errors, but continued, 0: errors aborted
 	 */
@@ -953,7 +945,7 @@ 
 	 * b) we use the table-names plus all column-names and remove dublicate parts
 	 *
 	 * @internal
-	 * @param $sTableName string name of the table
+	 * @param string $sTableName string name of the table
 	 * @param $aColumnNames array of column-names or string with a single column-name
 	 * @return string the index-name
 	 */
@@ -1010,6 +1002,7 @@ 
 
 	/**
 	 * Giving a non-fatal error-message
+	 * @param string $str
 	 */
 	function error($str)
 	{
@@ -1038,7 +1031,7 @@ 
 	 *
 	 * The parameters get formated depending on their type.
 	 *
-	 * @param $msg string message with parameters/variables like lang(), eg. '%1'
+	 * @param string $msg string message with parameters/variables like lang(), eg. '%1'
 	 * @param $backtrace include a function-backtrace, default True=On
 	 *	should only be set to False=Off, if your code ensures a call with backtrace=On was made before !!!
 	 * @param $param mixed a variable number of parameters, to be inserted in $msg

api/src/Etemplate/Widget.php

Doc Comments +1 added lines, -1 removed lines

@@ -155,7 +155,7 @@
 	 *
 	 * @param string|XMLReader $xml
 	 * @param boolean $cloned =true true: object does NOT need to be cloned, false: to set attribute, set them in cloned object
-	 * @return Template current object or clone, if any attribute was set
+	 * @return Widget current object or clone, if any attribute was set
 	 */
 	public function set_attrs($xml, $cloned=true)
 	{

api/src/Etemplate/Widget/Checkbox.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 * @param array $content
 	 * @param array &$validated=array() validated content
-	 * @return boolean true if no validation error, false otherwise
+	 * @return boolean|null true if no validation error, false otherwise
 	 */
 	public function validate($cname, array $expand, array $content, &$validated=array())
 	{

api/src/Etemplate/Widget/Date.php

Doc Comments +1 added lines, -2 removed lines

@@ -101,7 +101,6 @@ 
 	/**
 	 * Put date in the proper format for sending to client
 	 * @param string|int $value
-	 * @param string $format
 	 */
 	public function format_date($value)
 	{
@@ -139,7 +138,7 @@ 
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 * @param array $content
 	 * @param array &$validated=array() validated content
-	 * @return boolean true if no validation error, false otherwise
+	 * @return boolean|null true if no validation error, false otherwise
 	 */
 	public function validate($cname, array $expand, array $content, &$validated=array())
 	{

api/src/Etemplate/Widget/Tabbox.php

Doc Comments -1 removed lines

@@ -102,7 +102,6 @@
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 * @param array $content
 	 * @param array &$validated=array() validated content
-	 * @param array $expand=array values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 */
 	public function validate($cname, array $expand, array $content, &$validated=array())
 	{