EGroupware / egroupware

setup/check_install.php

Doc Comments +1 added lines

@@ -316,6 +316,7 @@
  * Check if given package is installed via composer in EGroupware's vendor directory
  *
  * @param string $package package-name in composer notation eg. "pear-pear.horde.org/Horde_Imap_Client" or "pear-pear.php.net/Net_Sieve"
+ * @return string|null
  */
 function composer_check($package)
 {

setup/inc/class.setup.inc.php

Doc Comments +5 added lines, -5 removed lines

@@ -741,8 +741,8 @@ 
 	/**
 	 * egw version checking, is param 1 < param 2 in phpgw versionspeak?
 	 * @param	$a	phpgw version number to check if less than $b
-	 * @param	$b	phpgw version number to check $a against
-	 * @return	True if $a < $b
+	 * @param	string $b	phpgw version number to check $a against
+	 * @return	boolean if $a < $b
 	 */
 	function alessthanb($a,$b,$DEBUG=False)
 	{
@@ -829,7 +829,7 @@ 
 	 *
 	 * @param	$a	phpgw version number to check if more than $b
 	 * @param	$b	phpgw version number to check $a against
-	 * @return	True if $a < $b
+	 * @return	boolean if $a < $b
 	 */
 	function amorethanb($a,$b,$DEBUG=False)
 	{
@@ -1101,7 +1101,7 @@ 
 	 *
 	 * Dont use it to set group-membership, use set_memberships instead!
 	 *
-	 * @param string|array $apps app-names
+	 * @param string $apps app-names
 	 * @param string $location eg. "run"
 	 * @param int|string $account accountid or account_lid
 	 * @param int $rights rights to set, default 1
@@ -1147,7 +1147,7 @@ 
 	/**
 	 * checks if one of the given tables exist, returns the first match
 	 *
-	 * @param array $tables array with possible table-names
+	 * @param string[] $tables array with possible table-names
 	 * @return string/boolean tablename or false
 	 */
 	function table_exist($tables,$force_refresh=False)

setup/inc/class.setup_cmd_header.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
 	/**
 	 * Constructor
 	 *
-	 * @param string|array $sub_command ='create' 'create','edit','delete'(-domain) or array with all arguments
+	 * @param string $sub_command ='create' 'create','edit','delete'(-domain) or array with all arguments
 	 * @param array $arguments =null comand line arguments
 	 */
 	function __construct($sub_command='create',$arguments=null)

setup/inc/class.setup_cmd_hooks.inc.php

Doc Comments +2 added lines, -3 removed lines

@@ -19,9 +19,8 @@
 	 * Constructor
 	 *
 	 * @param string $domain string with domain-name or array with all arguments
-	 * @param string $config_user=null user to config the domain (or header_admin_user)
-	 * @param string $config_passwd=null pw of above user
-	 * @param boolean $verbose=false if true, echos out some status information during the run
+	 * @param string $config_user user to config the domain (or header_admin_user)
+	 * @param string $config_passwd pw of above user
 	 */
 	function __construct($domain,$config_user=null,$config_passwd=null)
 	{

setup/inc/class.setup_cmd_ldap.inc.php

Doc Comments -3 removed lines

@@ -936,9 +936,6 @@
 	 *
 	 * Uses $this->ldap_host, $this->ldap_admin and $this->ldap_admin_pw to connect.
 	 *
-	 * @param string $this->object_class ='qmailUser'
-	 * @param string $this->mbox_attr ='mailmessagestore' lowercase!!!
-	 * @param string $this->mail_login_type ='email' 'email', 'vmailmgr', 'standard' or 'uidNumber'
 	 * @return string with success message N entries modified
 	 * @throws Api\Exception if dn not found, not listable or delete fails
 	 */

setup/inc/class.setup_cmd_showheader.inc.php

Doc Comments -3 removed lines

@@ -28,9 +28,6 @@
 	/**
 	 * Constructor
 	 *
-	 * @param boolean $data=true true: send only the remote_hash, domain and webserver_url,
-	 *                           false: the complete header vars, plus install_id and webserver_url from the config table,
-	 *                           null:  only the header vars
 	 */
 	function __construct($data=true,$header_admin_user=null,$header_admin_password=null)
 	{

setup/inc/class.setup_detection.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -252,7 +252,7 @@
 	/**
 	 * Check if header exists and is up to date
 	 *
-	 * @return int 1=no header.inc.php, 2=no header admin pw, 3=no instances, 4=need upgrade, 10=ok
+	 * @return string 1=no header.inc.php, 2=no header admin pw, 3=no instances, 4=need upgrade, 10=ok
 	 */
 	function check_header()
 	{

setup/inc/class.setup_process.inc.php

Doc Comments +1 added lines, -4 removed lines

@@ -53,10 +53,7 @@
 	 * the mother of all multipass upgrade parental loop functions
 	 *
 	 * @param array $setup_info array of application info from setup.inc.php files
-	 * @param string $type='new' defaults to new(install), could also be 'upgrade'
-	 * @param boolean $DEBUG=false print debugging info
-	 * @param boolean $force_en=false install english language files, not used anymore
-	 * @param string $system_charset=null charset to use
+	 * @param boolean $force_en install english language files, not used anymore
 	 * @param array $preset_config=array()
 	 */
 	function pass(array $setup_info,$method='new',$DEBUG=False,$force_en=False,$preset_config=array())

timesheet/inc/class.timesheet_bo.inc.php

Doc Comments +7 added lines, -9 removed lines

@@ -261,7 +261,7 @@ 
 	 *
 	 * @param statuses List of statuses to process, with sub-statuses in a 'substatus' array
 	 * @param labels Array of labels, pass array() and labels will be built in it
-	 * @param depth Current depth
+	 * @param depth integer depth
 	 *
 	 * @return None, labels are built in labels parameter
 	 */
@@ -305,7 +305,7 @@ 
 	 *
 	 * @param array|int $data =null use $this->data or $this->data['ts_id'] (to fetch the data)
 	 * @param int $user =null for which user to check, default current user
-	 * @return boolean true if the rights are ok, false if no rights
+	 * @return null|boolean true if the rights are ok, false if no rights
 	 */
 	function check_statusForEditRights($data=null,$user=null)
 	{
@@ -340,7 +340,7 @@ 
 	 * @param int $required Acl::READ, EGW_ACL_WRITE, Acl::ADD, Acl::DELETE, EGW_ACL_BUDGET, EGW_ACL_EDIT_BUDGET
 	 * @param array|int $data =null project or project-id to use, default the project in $this->data
 	 * @param int $user =null for which user to check, default current user
-	 * @return boolean true if the rights are ok, null if not found, false if no rights
+	 * @return null|boolean true if the rights are ok, null if not found, false if no rights
 	 */
 	function check_acl($required,$data=null,$user=null)
 	{
@@ -397,11 +397,11 @@ 
 	 * @param array|string $criteria array of key and data cols, OR a SQL query (content for WHERE), fully quoted (!)
 	 * @param boolean|string $only_keys =true True returns only keys, False returns all cols. comma seperated list of keys to return
 	 * @param string $order_by ='' fieldnames + {ASC|DESC} separated by colons ',', can also contain a GROUP BY (if it contains ORDER BY)
-	 * @param string|array $extra_cols ='' string or array of strings to be added to the SELECT, eg. "count(*) as num"
+	 * @param string $extra_cols ='' string or array of strings to be added to the SELECT, eg. "count(*) as num"
 	 * @param string $wildcard ='' appended befor and after each criteria
 	 * @param boolean $empty =false False=empty criteria are ignored in query, True=empty have to be empty in row
 	 * @param string $op ='AND' defaults to 'AND', can be set to 'OR' too, then criteria's are OR'ed together
-	 * @param mixed $start =false if != false, return only maxmatch rows begining with start, or array($start,$num)
+	 * @param boolean $start =false if != false, return only maxmatch rows begining with start, or array($start,$num)
 	 * @param array $filter =null if set (!=null) col-data pairs, to be and-ed (!) into the query without wildcards
 	 * @param string $join ='' sql to do a join, added as is after the table-name, eg. ", table2 WHERE x=y" or
 	 *	"LEFT JOIN table2 ON (x=y)", Note: there's no quoting done on $join!
@@ -658,8 +658,6 @@ 
 	 * delete / move all timesheets of a given user
 	 *
 	 * @param array $data
-	 * @param int $data['account_id'] owner to change
-	 * @param int $data['new_owner']  new owner or 0 for delete
 	 */
 	function deleteaccount($data)
 	{
@@ -686,7 +684,7 @@ 
 	 *
 	 * @param array $keys =null if given array with col => value pairs to characterise single timesheet or null for $this->data
 	 * @param int $status =0
-	 * @return int affected rows, should be 1 if ok, 0 if an error
+	 * @return boolean affected rows, should be 1 if ok, 0 if an error
 	 */
 	function set_status($keys=null, $status=0)
 	{
@@ -816,7 +814,7 @@ 
 	 * @param int $check Acl::READ for read and Acl::EDIT for write or delete access
 	 * @param string $rel_path =null currently not used in InfoLog
 	 * @param int $user =null for which user to check, default current user
-	 * @return boolean true if access is granted or false otherwise
+	 * @return null|boolean true if access is granted or false otherwise
 	 */
 	function file_access($id,$check,$rel_path=null,$user=null)
 	{