EGroupware / egroupware

remote.php

Doc Comments +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
  * Create a session or if the user has no account return authenticate header and 401 Unauthorized
  *
  * @param array &$account
- * @return int session-id
+ * @return string session-id
  */
 function check_access(&$account)
 {

resources/inc/class.resources_ui.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -1053,7 +1053,7 @@
 	 * @param int &$success number of succeded actions
 	 * @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 timesheets '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
+	 * @param string $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
 	 */
 	function action($action,$checked,$use_all,&$success,&$failed,&$action_msg,$session_name,&$msg)

addressbook/inc/class.addressbook_activesync.inc.php

Doc Comments +5 added lines, -5 removed lines

@@ -114,10 +114,10 @@ 
 	 *
 	 * Takes addessbook-abs and addressbook-all-in-one preference into account.
 	 *
-	 * @param int $account=null account_id of addressbook or null to get array of all addressbooks
-	 * @param boolean $return_all_in_one=true if false and all-in-one pref is set, return all selected abs
+	 * @param int $account account_id of addressbook or null to get array of all addressbooks
+	 * @param boolean $return_all_in_one if false and all-in-one pref is set, return all selected abs
 	 * 	if true only the all-in-one ab is returned (with id of personal ab)
-	 * @param booelan $ab_prefix=false prefix personal, private and accounts addressbook with lang('Addressbook').' '
+	 * @param booelan $ab_prefix prefix personal, private and accounts addressbook with lang('Addressbook').' '
 	 * @return string|array addressbook name of array with int account_id => label pairs
 	 */
 	private function get_addressbooks($account=null,$return_all_in_one=true, $ab_prefix=false)
@@ -270,7 +270,7 @@ 
 	 *
 	 * @todo if AB supports an extra private addressbook and AS prefs want an all-in-one AB, the private AB is always included, even if not selected in the prefs
 	 * @param string $id folder id
-	 * @param int $cutoffdate=null
+	 * @param int $cutoffdate
 	 * @return array
   	 */
 	function GetMessageList($id, $cutoffdate=NULL)
@@ -319,7 +319,7 @@ 
 	 * @param string $id
 	 * @param int $truncsize
 	 * @param int $bodypreference
-	 * @param bool $mimesupport
+	 * @param integer $mimesupport
 	 * @return $messageobject|boolean false on error
 	 */
 	public function GetMessage($folderid, $id, $truncsize, $bodypreference=false, $optionbodypreference=false, $mimesupport = 0)

addressbook/inc/class.addressbook_ads.inc.php

Doc Comments +1 added lines, -4 removed lines

@@ -74,8 +74,7 @@ 
 	/**
 	 * constructor of the class
 	 *
-	 * @param array $ldap_config=null default use from $GLOBALS['egw_info']['server']
-	 * @param resource $ds=null ldap connection to use
+	 * @param array $ldap_config default use from $GLOBALS['egw_info']['server']
 	 */
 	function __construct(array $ldap_config=null, $ds=null)
 	{
@@ -130,7 +129,6 @@ 
 	/**
 	 * connect to LDAP server
 	 *
-	 * @param boolean $admin=false true (re-)connect with admin not user credentials, eg. to modify accounts
 	 */
 	function connect($admin=false)
 	{
@@ -204,7 +202,6 @@ 
 	/**
 	 * Remove attributes we are not allowed to update
 	 *
-	 * @param array $attributes
 	 */
 	function sanitize_update(array &$ldapContact)
 	{

addressbook/inc/class.addressbook_bo.inc.php

Doc Comments +16 added lines, -33 removed lines

@@ -158,8 +158,6 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param string $contact_app='addressbook' used for acl->get_grants()
-	 * @param egw_db $db=null
 	 */
 	function __construct($contact_app='addressbook',egw_db $db=null)
 	{
@@ -329,10 +327,8 @@ 
 	/**
 	 * Get the availible addressbooks of the user
 	 *
-	 * @param int $required=EGW_ACL_READ required rights on the addressbook or multiple rights or'ed together,
-	 * 	to return only addressbooks fullfilling all the given rights
 	 * @param string $extra_label first label if given (already translated)
-	 * @param int $user=null account_id or null for current user
+	 * @param integer $required
 	 * @return array with owner => label pairs
 	 */
 	function get_addressbooks($required=EGW_ACL_READ,$extra_label=null,$user=null)
@@ -402,8 +398,6 @@ 
 	 * calculate the file_as string from the contact and the file_as type
 	 *
 	 * @param array $contact
-	 * @param string $type=null file_as type, default null to read it from the contact, unknown/not set type default to the first one
-	 * @param boolean $update=false If true, reads the old record for any not set fields
 	 * @return string
 	 */
 	function fileas($contact,$type=null, $isUpdate=false)
@@ -459,7 +453,6 @@ 
 	 * determine the file_as type from the file_as string and the contact
 	 *
 	 * @param array $contact
-	 * @param string $type=null file_as type, default null to read it from the contact, unknown/not set type default to the first one
 	 * @return string
 	 */
 	function fileas_type($contact,$file_as=null)
@@ -482,7 +475,6 @@ 
 	/**
 	 * get selectbox options for the customfields
 	 *
-	 * @param array $field=null
 	 * @return array with options:
 	 */
 	public static function cf_options()
@@ -498,7 +490,7 @@ 
 	/**
 	 * get selectbox options for the fileas types with translated labels, or real content
 	 *
-	 * @param array $contact=null real content to use, default none
+	 * @param array $contact real content to use, default none
 	 * @return array with options: fileas type => label pairs
 	 */
 	function fileas_options($contact=null)
@@ -532,7 +524,6 @@ 
 	 * If $all all fileas fields will be set, if !$all only empty ones
 	 *
 	 * @param string $fileas_type '' or type of $this->fileas_types
-	 * @param int $all=false update all contacts or only ones with empty values
 	 * @param int &$errors=null on return number of errors
 	 * @return int|boolean number of contacts updated, false for wrong fileas type
 	 */
@@ -596,7 +587,7 @@ 
 	 * remove unneeded carriage returns or set empty fields to NULL
 	 *
 	 * @param int &$errors=null on return number of errors
-	 * @return int|boolean number of contacts updated
+	 * @return integer number of contacts updated
 	 */
 	function set_all_cleanup(&$errors=null,$ignore_acl=false)
 	{
@@ -744,9 +735,7 @@ 
 	/**
 	 * src for photo: returns array with linkparams if jpeg exists or the $default image-name if not
 	 * @param int $id contact_id
-	 * @param boolean $jpeg=false jpeg exists or not
 	 * @param string $default='' image-name to use if !$jpeg, eg. 'template'
-	 * @param string $etag=null etag to set in url to allow caching with Expires header
 	 * @return string/array
 	 */
 	function photo_src($id,$jpeg,$default='',$etag=null)
@@ -788,8 +777,8 @@ 
 	* deletes contact in db
 	*
 	* @param mixed &$contact contact array with key id or (array of) id(s)
-	* @param boolean $deny_account_delete=true if true never allow to delete accounts
-	* @param int $check_etag=null
+	* @param boolean $deny_account_delete if true never allow to delete accounts
+	* @param int $check_etag
 	* @return boolean|int true on success or false on failiure, 0 if etag does not match
 	*/
 	function delete($contact,$deny_account_delete=true,$check_etag=null)
@@ -847,7 +836,7 @@ 
 	* saves contact to db
 	*
 	* @param array &$contact contact array from etemplate::exec
-	* @param boolean $ignore_acl=false should the acl be checked or not
+	* @param boolean $ignore_acl should the acl be checked or not
 	* @return int/string/boolean id on success, false on failure, the error-message is in $this->error
 	*/
 	function save(&$contact,$ignore_acl=false)
@@ -1028,7 +1017,7 @@ 
 	 * Resizes photo to 60*80 pixel and returns it
 	 *
 	 * @param string|FILE $photo string with image or open filedescribtor
-	 * @param int $dst_w=240 max width to resize to
+	 * @param int $dst_w max width to resize to
 	 * @return string with resized jpeg photo, null on error
 	 */
 	public static function resize_photo($photo,$dst_w=240)
@@ -1121,9 +1110,8 @@ 
 	 *
 	 * @param int $needed necessary ACL right: EGW_ACL_{READ|EDIT|DELETE}
 	 * @param mixed $contact contact as array or the contact-id
-	 * @param boolean $deny_account_delete=false if true never allow to delete accounts
-	 * @param int $user=null for which user to check, default current user
-	 * @return boolean true permission granted, false for permission denied, null for contact does not exist
+	 * @param boolean $deny_account_delete if true never allow to delete accounts
+	 * @return null|boolean true permission granted, false for permission denied, null for contact does not exist
 	 */
 	function check_perms($needed,$contact,$deny_account_delete=false,$user=null)
 	{
@@ -1177,9 +1165,8 @@ 
 	 *
 	 * @param int|array $id id of entry or entry array
 	 * @param int $check EGW_ACL_READ for read and EGW_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
+	 * @param string $rel_path currently not used in InfoLog
+	 * @return null|boolean true if access is granted or false otherwise
 	 */
 	function file_access($id,$check,$rel_path=null,$user=null)
 	{
@@ -1333,7 +1320,7 @@ 
 	 *
 	 * @param array $from original/old version of the contact
 	 * @param array $to changed/new version of the contact
-	 * @param boolean $onld_org_fields=true check and return only org_fields, default true
+	 * @param boolean $only_org_fields check and return only org_fields, default true
 	 * @return array with field-name => value from $from
 	 */
 	function changed_fields($from,$to,$only_org_fields=true)
@@ -1368,7 +1355,7 @@ 
 	 * @param string $org_name
 	 * @param array $from original/old version of the contact
 	 * @param array $to changed/new version of the contact
-	 * @param array $members=null org-members to change, default null --> function queries them itself
+	 * @param array $members org-members to change, default null --> function queries them itself
 	 * @return array/boolean (changed-members,changed-fields,failed-members) or false if no org_fields changed or no (other) members matching that fields
 	 */
 	function change_org($org_name,$from,$to,$members=null)
@@ -1599,7 +1586,7 @@ 
 	 * Read the next and last event of given contacts
 	 *
 	 * @param array $ids contact_id's
-	 * @param boolean $extra_title=true if true, use a short date only title and put the full title as extra_title (tooltip)
+	 * @param boolean $extra_title if true, use a short date only title and put the full title as extra_title (tooltip)
 	 * @return array
 	 */
 	function read_calendar($ids,$extra_title=true)
@@ -1867,7 +1854,6 @@ 
 	 *
 	 * @param int $list
 	 * @param int $required
-	 * @param int $owner=null
 	 * @return boolean
 	 */
 	function check_list($list,$required,$owner=null)
@@ -1885,7 +1871,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
 	 */
@@ -1909,7 +1894,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)
@@ -2051,7 +2036,7 @@ 
 	 * currently used for vcard import
 	 *
 	 * @param array $catname_list names of the categories which should be found or added
-	 * @param int $contact_id=null match against existing contact and expand the returned category ids
+	 * @param int $contact_id match against existing contact and expand the returned category ids
 	 *  by the ones the user normally does not see due to category permissions - used to preserve categories
 	 * @return array category ids (found, added and preserved categories)
 	 */
@@ -2151,7 +2136,6 @@ 
 	 * Try to find a matching db entry
 	 *
 	 * @param array $contact   the contact data we try to find
-	 * @param boolean $relax=false if asked to relax, we only match against some key fields
 	 * @return array od matching contact_ids
 	 */
 	function find_contact($contact, $relax=false)
@@ -2386,7 +2370,6 @@ 
 	 * We have to include deleted entries, as otherwise the ctag will not change if an entry gets deleted!
 	 * (Only works if tracking of deleted entries / history is switched on!)
 	 *
-	 * @param int|array $owner=null 0=accounts, null=all addressbooks or integer account_id of user or group
 	 * @return string
 	 */
 	public function get_ctag($owner=null)

addressbook/inc/class.addressbook_groupdav.inc.php

Doc Comments +7 added lines, -14 removed lines

@@ -104,8 +104,7 @@ 
 	 * @param array &$options
 	 * @param array &$files
 	 * @param int $user account_id
-	 * @param string $id=''
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function propfind($path,&$options,&$files,$user,$id='')
 	{
@@ -186,7 +185,6 @@ 
 	 *
 	 * @param string $path
 	 * @param array& $filter
-	 * @param array|boolean $start=false false=return all or array(start,num)
 	 * @return array with "files" array with values for keys path and props
 	 */
 	function &propfind_callback($path,array &$filter,$start=false,$report_not_found_multiget_ids=true)
@@ -535,8 +533,7 @@ 
 	 *
 	 * @param array &$options
 	 * @param int $id
-	 * @param int $user=null account_id
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function get(&$options,$id,$user=null)
 	{
@@ -559,9 +556,8 @@ 
 	 *
 	 * @param array &$options
 	 * @param int $id
-	 * @param int $user=null account_id of owner, default null
-	 * @param string $prefix=null user prefix from path (eg. /ralf from /ralf/addressbook)
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @param string $prefix user prefix from path (eg. /ralf from /ralf/addressbook)
+	 * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function put(&$options,$id,$user=null,$prefix=null)
 	{
@@ -828,10 +824,8 @@ 
 	 * </D:supported-report-set>
 	 * @link http://www.mail-archive.com/calendarserver-users@lists.macosforge.org/msg01156.html
 	 *
-	 * @param array $props=array() regular props by the groupdav handler
 	 * @param string $displayname
-	 * @param string $base_uri=null base url of handler
-	 * @param int $user=null account_id of owner of collection
+	 * @param string $base_uri base url of handler
 	 * @return array
 	 */
 	public function extra_properties(array $props=array(), $displayname, $base_uri=null, $user=null)
@@ -944,7 +938,6 @@ 
 	 * the same UID and/or carddav_name as not deleted contacts and would block access to valid entries
 	 *
 	 * @param string|int $id
-	 * @param string $path=null
 	 * @return array|boolean array with entry, false if no read rights, null if $id does not exist
 	 */
 	function read($id, $path=null)
@@ -1013,7 +1006,7 @@ 
 	 *
 	 * @param int $acl EGW_ACL_READ, EGW_ACL_EDIT or EGW_ACL_DELETE
 	 * @param array|int $contact contact-array or id
-	 * @return boolean null if entry does not exist, false if no access, true if access permitted
+	 * @return null|boolean null if entry does not exist, false if no access, true if access permitted
 	 */
 	function check_access($acl,$contact)
 	{
@@ -1042,7 +1035,7 @@ 
 	/**
 	 * Return calendars/addressbooks shared from other users with the current one
 	 *
-	 * @param boolean $ignore_all_in_one=false if true, return selected addressbooks and not array() for all-in-one
+	 * @param boolean $ignore_all_in_one if true, return selected addressbooks and not array() for all-in-one
 	 * @return array account_id => account_lid pairs
 	 */
 	function get_shared($ignore_all_in_one=false)

addressbook/inc/class.addressbook_import_vcard.inc.php

Doc Comments +2 added lines, -3 removed lines

@@ -82,8 +82,7 @@ 
 	/**
 	 * imports entries according to given definition object.
 	 * @param resource $_stream
-	 * @param string $_charset
-	 * @param definition $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function import( $_stream, importexport_definition $_definition ) {
 		$this->definition = $_definition;
@@ -190,7 +189,7 @@ 
 	 * perform the required action
 	 *
 	 * @param int $_action one of $this->actions
-	 * @param array $_data contact data for the action
+	 * @param Horde_iCalendar $_data contact data for the action
 	 * @return bool success or not
 	 */
 	private function action ( $_action, $_data, $record_num = 0 ) {

addressbook/inc/class.addressbook_ldap.inc.php

Doc Comments +3 added lines, -4 removed lines

@@ -425,7 +425,6 @@ 
 	/**
 	 * Remove attributes we are not allowed to update
 	 *
-	 * @param array $attributes
 	 */
 	function sanitize_update(array &$ldapContact)
 	{
@@ -703,14 +702,14 @@ 
 	 *
 	 * '*' and '?' are replaced with sql-wildcards '%' and '_'
 	 *
-	 * @param array|string $criteria array of key and data cols, OR a SQL query (content for WHERE), fully quoted (!)
+	 * @param boolean $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!

addressbook/inc/class.addressbook_sif.inc.php

Doc Comments -3 removed lines

@@ -196,9 +196,6 @@
 	* import a vard into addressbook
 	*
 	* @return int contact id
-	* @param string	$_vcard		the vcard
-	* @param int/string	$_abID=null		the internal addressbook id or !$_abID for a new enty
-	* @param boolean $merge=false	merge data with existing entry
 	*/
 	function addSIF($_sifdata, $_abID=null, $merge=false)
 	{