EGroupware / egroupware

addressbook/inc/class.addressbook_sql.inc.php

Doc Comments +8 added lines, -16 removed lines

@@ -60,7 +60,6 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param egw_db $db=null
 	 */
 	function __construct(egw_db $db=null)
 	{
@@ -244,18 +243,15 @@ 
 	 * For a union-query you call search for each query with $start=='UNION' and one more with only $order_by and $start set to run the union-query.
 	 *
 	 * @param array/string $criteria array of key and data cols, OR a SQL query (content for WHERE), fully quoted (!)
-	 * @param boolean/string/array $only_keys=true True returns only keys, False returns all cols. or
+	 * @param boolean/string/array $only_keys True returns only keys, False returns all cols. or
 	 *	comma seperated list or array of columns 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 $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), or 'UNION' for a part of a union query
-	 * @param array $filter=null if set (!=null) col-data pairs, to be and-ed (!) into the query without wildcards
+	 * @param array $filter 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!
-	 * @param boolean $need_full_no_count=false If true an unlimited query is run to determine the total number of rows, default false
+	 * @param boolean $need_full_no_count If true an unlimited query is run to determine the total number of rows, default false
 	 * @return boolean/array of matching rows (the row is an array of the cols) or False
 	 */
 	function &search($criteria,$only_keys=True,$order_by='',$extra_cols='',$wildcard='',$empty=False,$op='AND',$start=false,$filter=null,$join='',$need_full_no_count=false)
@@ -496,9 +492,8 @@ 
 	 *
 	 * @param array $uids array of user or group id's for $uid_column='list_owners', or values for $uid_column,
 	 * 	or whole where array: column-name => value(s) pairs
-	 * @param string $uid_column='list_owner' column-name or null to use $uids as where array
-	 * @param string $member_attr=null null: no members, 'contact_uid', 'contact_id', 'caldav_name' return members as that attribute
-	 * @param boolean|int|array $limit_in_ab=false if true only return members from the same owners addressbook,
+	 * @param string $member_attr null: no members, 'contact_uid', 'contact_id', 'caldav_name' return members as that attribute
+	 * @param boolean|int|array $limit_in_ab if true only return members from the same owners addressbook,
 	 * 	if int|array only return members from the given owners addressbook(s)
 	 * @return array with list_id => array(list_id,list_name,list_owner,...) pairs
 	 */
@@ -547,7 +542,6 @@ 
 	 *
 	 * @param string|array $keys list-name or array with column-name => value pairs to specify the list
 	 * @param int $owner user- or group-id
-	 * @param array $contacts=array() contacts to add (only for not yet existing lists!)
 	 * @param array &$data=array() values for keys 'list_uid', 'list_carddav_name', 'list_name'
 	 * @return int|boolean integer list_id or false on error
 	 */
@@ -606,7 +600,7 @@ 
 	 *
 	 * @param int|array $contact contact_id(s)
 	 * @param int $list list-id
-	 * @param array $existing=null array of existing contact-id(s) of list, to not reread it, eg. array()
+	 * @param array $existing array of existing contact-id(s) of list, to not reread it, eg. array()
 	 * @return false on error
 	 */
 	function add2list($contact,$list,array $existing=null)
@@ -648,7 +642,6 @@ 
 	 * Removes one contact from distribution list(s)
 	 *
 	 * @param int|array $contact contact_id(s)
-	 * @param int $list=null list-id or null to remove from all lists
 	 * @return false on error
 	 */
 	function remove_from_list($contact,$list=null)
@@ -705,7 +698,6 @@ 
 	/**
 	 * Get ctag (max list_modified as timestamp) for lists
 	 *
-	 * @param int|array $owner=null null for all lists user has access too
 	 * @return int
 	 */
 	function lists_ctag($owner=null)
@@ -762,7 +754,7 @@ 
 	 * Saves a contact, reimplemented to check a given etag and set a uid
 	 *
 	 * @param array $keys if given $keys are copied to data before saveing => allows a save as
-	 * @param string|array $extra_where=null extra where clause, eg. to check the etag, returns 'nothing_affected' if not affected rows
+	 * @param string|array $extra_where extra where clause, eg. to check the etag, returns 'nothing_affected' if not affected rows
 	 * @return int 0 on success and errno != 0 else
 	 */
 	function save($keys = NULL, $extra_where = NULL)
@@ -823,7 +815,7 @@ 
 	 * Read data of a distribution list
 	 *
 	 * @param int $list list_id
-	 * @return array of data or false if list does not exist
+	 * @return boolean of data or false if list does not exist
 	 */
 	function read_list($list)
 	{

addressbook/inc/class.addressbook_tracking.inc.php

Doc Comments +3 added lines, -9 removed lines

@@ -93,12 +93,7 @@ 
 	/**
 	 * Get a notification-config value
 	 *
-	 * @param string $what
-	 * 	- 'copy' array of email addresses notifications should be copied too, can depend on $data
-	 *  - 'lang' string lang code for copy mail
-	 *  - 'sender' string send email address
 	 * @param array $data current entry
-	 * @param array $old=null old/last state of the entry or null for a new entry
 	 * @return mixed
 	 */
 	function get_config($name,$data,$old=null)
@@ -134,9 +129,8 @@ 
 	 *
 	 * @internal use only track($data,$old)
 	 * @param array $data current entry
-	 * @param array $old=null old/last state of the entry or null for a new entry
-	 * @param boolean $deleted=null can be set to true to let the tracking know the item got deleted or undelted
-	 * @param array $changed_fields=null changed fields from ealier call to $this->changed_fields($data,$old), to not compute it again
+	 * @param boolean $deleted can be set to true to let the tracking know the item got deleted or undelted
+	 * @param array $changed_fields changed fields from ealier call to $this->changed_fields($data,$old), to not compute it again
 	 * @return int number of log-entries made
 	 */
 	protected function save_history(array $data,array $old=null,$deleted=null,array $changed_fields=null)
@@ -196,7 +190,7 @@ 
 	 *
 	 * @param array $data
 	 * @param array $old
-	 * @param boolean $deleted=null can be set to true to let the tracking know the item got deleted or undelted
+	 * @param boolean $deleted can be set to true to let the tracking know the item got deleted or undelted
 	 * @param int|string $receiver nummeric account_id or email address
 	 * @return string
 	 */

addressbook/inc/class.addressbook_ui.inc.php

Doc Comments +9 added lines, -13 removed lines

@@ -112,9 +112,8 @@ 
 	/**
 	 * List contacts of an addressbook
 	 *
-	 * @param array $content=null submitted content
-	 * @param string $msg=null	message to show
-	 * @param boolean $do_email=false do an email-selection popup or the regular index-page
+	 * @param array $content submitted content
+	 * @param boolean $do_email do an email-selection popup or the regular index-page
 	 */
 	function index($content=null,$msg=null,$do_email=false)
 	{
@@ -353,8 +352,8 @@ 
 	/**
 	 * Get actions / context menu items
 	 *
-	 * @param string $tid_filter=null
-	 * @param string $org_view=null
+	 * @param string $tid_filter
+	 * @param string $org_view
 	 * @return array see nextmatch_widget::get_actions()
 	 */
 	public function get_actions($tid_filter=null, $org_view=null)
@@ -762,8 +761,7 @@ 
 	/**
 	 * Email address-selection popup
 	 *
-	 * @param array $content=null submitted content
-	 * @param string $msg=null	message to show
+	 * @param array $content submitted content
 	 */
 	function emailpopup($content=null,$msg=null)
 	{
@@ -952,7 +950,7 @@ 
 	 * @param int &$failed number of failed actions (not enought permissions)
 	 * @param string &$action_msg translated verb for the actions, to be used in a message like %1 contacts 'deleted'
 	 * @param string/array $session_name 'index' or 'email', or array with session-data depending if we are in the main list or the popup
-	 * @return boolean true if all actions succeded, false otherwise
+	 * @return null|boolean true if all actions succeded, false otherwise
 	 */
 	function action($action,$checked,$use_all,&$success,&$failed,&$action_msg,$session_name,&$msg, $checkboxes = NULL)
 	{
@@ -1303,7 +1301,7 @@ 
 	 * @param array &$query
 	 * @param array &$rows returned rows/cups
 	 * @param array &$readonlys eg. to disable buttons based on acl
-	 * @param boolean $id_only=false if true only return (via $rows) an array of contact-ids, dont save state to session
+	 * @param boolean $id_only if true only return (via $rows) an array of contact-ids, dont save state to session
 	 * @return int total number of contacts matching the selection
 	 */
 	function get_rows(&$query,&$rows,&$readonlys,$id_only=false)
@@ -1798,9 +1796,7 @@ 
 	/**
 	* Edit a contact
 	*
-	* @param array $content=null submitted content
-	* @param int $_GET['contact_id'] contact_id mainly for popup use
-	* @param bool $_GET['makecp'] true if you want to copy the contact given by $_GET['contact_id']
+	* @param array $content submitted content
 	*/
 	function edit($content=null)
 	{
@@ -2375,7 +2371,7 @@ 
 	 *
 	 * @param array $values contact values from form
 	 * @param string $name name of changed value, eg. "email"
-	 * @param int $own_id=0 own contact id, to not check against it
+	 * @param int $own_id own contact id, to not check against it
 	 * @return array with keys 'msg' => "EMail address exists, do you want to open contact?" (or null if not existing)
 	 * 	'data' => array of id => "full name (addressbook)" pairs
 	 *  'fileas_options'

admin/admin-cli.php

Doc Comments +5 added lines, -6 removed lines

@@ -299,8 +299,8 @@ 
 /**
  * Give a usage message and exit
  *
- * @param string $action=null
- * @param int $ret=0 exit-code
+ * @param string $action
+ * @param int $ret exit-code
  */
 function usage($action=null,$ret=0)
 {
@@ -404,7 +404,7 @@ 
  * Edit or add a user to EGroupware. If you specify groups, they *replace* the exiting memberships!
  *                    1:                     2:             3:                         4:         5:        6:       7:    8:                                         9:                                 10:                            11:                                  12
  * @param array $args admin-account[@domain],admin-password,account[=new-account-name],first-name,last-name,password,email,expires{never(default)|YYYY-MM-DD|already},can-change-pw{true(default)|false},anon-user{true|false(default)},primary-group{Default(default)|...}[,groups,...][,homedirectory,loginshell]
- * @param boolean $run_addaccount_hook=null default run hook depending on account existence, true=allways run addaccount hook
+ * @param boolean $run_addaccount_hook default run hook depending on account existence, true=allways run addaccount hook
  */
 function do_edit_user($args,$run_addaccount_hook=null)
 {
@@ -453,8 +453,8 @@ 
  * Delete a given acount from eGW
  *
  * @param int/string $account account-name of -id
- * @param int/string $new_user=0 for users only: account to move the entries too
- * @param boolean $is_user=true are we called for a user or group
+ * @param int/string $new_user for users only: account to move the entries too
+ * @param boolean $is_user are we called for a user or group
  * @return int 0 on success, 2-4 otherwise (see source)
  */
 function do_delete_account($account,$new_user=0,$is_user=true)
@@ -523,7 +523,6 @@ 
 /**
  * Read the IMAP ACLs
  *
- * @param array $args admin-account[@domain],admin-password,accout_lid[,pw]
  * @return int 0 on success
  */
 function do_subscribe_other($account_lid,$pw=null)

admin/inc/class.admin_acl.inc.php

Doc Comments +2 added lines, -3 removed lines

@@ -283,8 +283,7 @@ 
 	 * Check if current user has access to ACL setting of a given location
 	 *
 	 * @param int $account_id numeric account-id
-	 * @param int|string $location=null numeric account-id or "run"
-	 * @param boolean $throw=true if true, throw an exception if no access, instead of just returning false
+	 * @param int|string $location numeric account-id or "run"
 	 * @return boolean true if access is granted, false if notification_bo
 	 * @throws egw_exception_no_permission
 	 */
@@ -330,7 +329,7 @@ 
 	 * Checks access and throws an exception, if a change is attempted without proper access
 	 *
 	 * @param string|array $ids "$app:$account:$location" string used as row-id in list
-	 * @param int $rights=null null to delete, or new rights
+	 * @param int $rights null to delete, or new rights
 	 * @throws egw_exception_no_permission
 	 */
 	public static function ajax_change_acl($ids, $rights=null)

admin/inc/class.admin_applications.inc.php

Doc Comments +4 added lines

@@ -185,6 +185,10 @@
 		$order[$next_app] = $old_pos;
 	}
 
+	/**
+	 * @param integer $old_key
+	 * @param boolean $reverse
+	 */
 	function find_next_key($array,$old_key,$reverse)
 	{
 		//error_log("find_next_key($old_key ".$GLOBALS['egw']->applications->id2name($old_key)." position:".$array[$old_key].",".var_dump($reverse).")");

admin/inc/class.admin_cmd.inc.php

Doc Comments +16 added lines, -20 removed lines

@@ -100,7 +100,7 @@ 
 	/**
 	 * Executes the command
 	 *
-	 * @param boolean $check_only=false only run the checks (and throw the exceptions), but not the command itself
+	 * @param boolean $check_only only run the checks (and throw the exceptions), but not the command itself
 	 * @return string success message
 	 * @throws Exception()
 	 */
@@ -141,10 +141,10 @@ 
 	 *
 	 * The command will be written to the database queue, incl. its scheduled start time or execution status
 	 *
-	 * @param int $time=null timestamp to run the command or null to run it immediatly
-	 * @param boolean $set_modifier=null should the current user be set as modifier, default true
-	 * @param booelan $skip_checks=false do not yet run the checks for a scheduled command
-	 * @param boolean $dry_run=false only run checks, NOT command itself
+	 * @param boolean $set_modifier should the current user be set as modifier, default true
+	 * @param booelan $skip_checks do not yet run the checks for a scheduled command
+	 * @param boolean $dry_run only run checks, NOT command itself
+	 * @param integer $time
 	 * @return mixed return value of the command
 	 * @throws Exceptions on error
 	 */
@@ -282,7 +282,7 @@ 
 	/**
 	 * Saving the object to the database
 	 *
-	 * @param boolean $set_modifier=true set the current user as modifier or 0 (= run by the system)
+	 * @param boolean $set_modifier set the current user as modifier or 0 (= run by the system)
 	 * @return boolean true on success, false otherwise
 	 */
 	function save($set_modifier=true)
@@ -438,15 +438,12 @@ 
 	 *
 	 * @static
 	 * @param array/string $criteria array of key and data cols, OR a SQL query (content for WHERE), fully quoted (!)
-	 * @param boolean/string/array $only_keys=true True returns only keys, False returns all cols. or
+	 * @param boolean/string/array $only_keys True returns only keys, False returns all cols. or
 	 *	comma seperated list or array of columns 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 $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), or 'UNION' for a part of a union query
-	 * @param array $filter=null if set (!=null) col-data pairs, to be and-ed (!) into the query without wildcards
+	 * @param array $filter if set (!=null) col-data pairs, to be and-ed (!) into the query without wildcards
 	 * @return array
 	 */
 	static function &search($criteria,$only_keys=True,$order_by='',$extra_cols='',$wildcard='',$empty=False,$op='AND',$start=false,$filter=null)
@@ -567,8 +564,8 @@ 
 	/**
 	 * Check if the creator is still admin and has the neccessary admin rights
 	 *
-	 * @param string $extra_acl=null further admin rights to check, eg. 'account_access'
-	 * @param int $extra_deny=null further admin rights to check, eg. 16 = deny edit accounts
+	 * @param string $extra_acl further admin rights to check, eg. 'account_access'
+	 * @param integer $extra_deny further admin rights to check, eg. 16 = deny edit accounts
 	 * @throws egw_exception_no_admin
 	 */
 	protected function _check_admin($extra_acl=null,$extra_deny=null)
@@ -619,7 +616,7 @@ 
 	 * parse account name or id
 	 *
 	 * @param string/int $account account_id or account_lid
-	 * @param boolean $allow_only_user=null true=only user, false=only groups, default both
+	 * @param boolean $allow_only_user true=only user, false=only groups, default both
 	 * @return int/array account_id
 	 * @throws egw_exception_wrong_userinput(lang("Unknown account: %1 !!!",$account),15);
 	 * @throws egw_exception_wrong_userinput(lang("Wrong account type: %1 is NO %2 !!!",$account,$allow_only_user?lang('user'):lang('group')),15);
@@ -646,7 +643,7 @@ 
 	 * parse account names or ids
 	 *
 	 * @param string/int/array $accounts array or comma-separated account_id's or account_lid's
-	 * @param boolean $allow_only_user=null true=only user, false=only groups, default both
+	 * @param boolean $allow_only_user true=only user, false=only groups, default both
 	 * @return array of account_id's or null if none specified
 	 * @throws egw_exception_wrong_userinput(lang("Unknown account: %1 !!!",$account),15);
 	 * @throws egw_exception_wrong_userinput(lang("Wrong account type: %1 is NO %2 !!!",$account,$allow_only?lang('user'):lang('group')),15);
@@ -690,7 +687,7 @@ 
 	 * Parse a boolean value
 	 *
 	 * @param string|boolean|int $value
-	 * @param boolean $default=null
+	 * @param boolean $default
 	 * @return boolean
 	 * @throws egw_exception_wrong_userinput(lang('Invalid value "%1" use yes or no!',$value),998);
 	 */
@@ -759,7 +756,7 @@ 
 	 * Instanciated acl class
 	 *
 	 * @todo acl class instanciation for setup
-	 * @param int $account=null account_id the class needs to be instanciated for, default need only account-independent methods
+	 * @param int $account account_id the class needs to be instanciated for, default need only account-independent methods
 	 * @throws egw_exception_assertion_failed(lang('%1 class not instanciated','acl'),999);
 	 */
 	protected function _instanciate_acl($account=null)
@@ -920,7 +917,7 @@ 
 	 * Read data of a remote instance
 	 *
 	 * @param array/int $keys
-	 * @return array
+	 * @return string
 	 */
 	static function read_remote($keys)
 	{
@@ -1000,7 +997,7 @@ 
 	 * Check if string is a md5 hash (32 chars of 0-9 or a-f)
 	 *
 	 * @param string $str
-	 * @return boolean
+	 * @return integer
 	 */
 	static function is_md5($str)
 	{
@@ -1046,7 +1043,6 @@ 
 	/**
 	 * Return a rand string, eg. to generate passwords
 	 *
-	 * @param int $len=16
 	 * @return string
 	 */
 	static function randomstring($len=16)

admin/inc/class.admin_cmd_account_app.inc.php

Doc Comments +3 added lines, -4 removed lines

@@ -18,9 +18,8 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param boolean/array $allow true=give rights, false=remove rights, or array with all 3 params
-	 * @param string/int $account=null account name or id
-	 * @param array/string $apps=null app-names
+	 * @param boolean $allow true=give rights, false=remove rights, or array with all 3 params
+	 * @param string/int $account account name or id
 	 */
 	function __construct($allow,$account=null,$apps=null)
 	{
@@ -42,7 +41,7 @@ 
 	/**
 	 * give or remove run rights from a given account and application
 	 * 
-	 * @param boolean $check_only=false only run the checks (and throw the exceptions), but not the command itself
+	 * @param boolean $check_only only run the checks (and throw the exceptions), but not the command itself
 	 * @return string success message
 	 * @throws egw_exception_no_admin
 	 * @throws egw_exception_wrong_userinput(lang("Unknown account: %1 !!!",$this->account),15);

admin/inc/class.admin_cmd_change_pw.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,7 +19,7 @@ 
 	 * Constructor
 	 *
 	 * @param string/int/array $account account name or id, or array with all parameters
-	 * @param string $password=null password
+	 * @param string $password password
 	 */
 	function __construct($account,$password=null)
 	{
@@ -36,7 +36,7 @@ 
 	/**
 	 * change the password of a given user
 	 *
-	 * @param boolean $check_only=false only run the checks (and throw the exceptions), but not the command itself
+	 * @param boolean $check_only only run the checks (and throw the exceptions), but not the command itself
 	 * @return string success message
 	 * @throws egw_exception_no_admin
 	 * @throws egw_exception_wrong_userinput(lang("Unknown account: %1 !!!",$this->account),15);