EGroupware / egroupware

phpgwapi/inc/class.egw_time.inc.php

Doc Comments +6 added lines, -10 removed lines

@@ -76,10 +76,8 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param int|string|array|DateTime $time='now' integer timestamp, string with date+time, DateTime object or
-	 * 	array with values for keys('year','month','day') or 'full' plus 'hour','minute' and optional 'second'
-	 * @param DateTimeZone $tz=null timezone, default user time (PHP DateTime default to server time!)
 	 * @param string &$type=null on return type of $time (optional)
+	 * @param string $type
 	 * @throws Exception if $time can NOT be parsed
 	 * @return egw_time
 	 */
@@ -164,7 +162,7 @@ 
 	/**
 	 * Like DateTime::add, but additional allow to use a string run through DateInterval::createFromDateString
 	 *
-	 * @param DateInterval|string $interval eg. '1 day', '-2 weeks'
+	 * @param string $interval eg. '1 day', '-2 weeks'
 	 */
 	public function add($interval)
 	{
@@ -384,7 +382,7 @@ 
 	 * Convert a server time into a user time
 	 *
 	 * @param int|string|array|DateTime $time
-	 * @param string $type=null type or return-value, default (null) same as $time
+	 * @param string $type
 	 * @return int|string|array|datetime null if time could not be parsed
 	 */
 	public static function server2user($time,$type=null)
@@ -413,8 +411,8 @@ 
 	 * Convert a user time into a server time
 	 *
 	 * @param int|string|array|datetime $time
-	 * @param string $type=null type or return-value, default (null) same as $time
-	 * @return int|string|array|datetime null if time could not be parsed
+	 * @param string $type
+	 * @return integer|null null if time could not be parsed
 	 */
 	public static function user2server($time,$type=null)
 	{
@@ -441,7 +439,6 @@ 
 	/**
 	 * Convert time to a specific format or string, static version of egw_time::format()
 	 *
-	 * @param int|string|array|DateTime $time='now' see constructor
 	 * @param string $type='' 'integer'|'ts'=timestamp, 'server'=timestamp in servertime, 'string'='Y-m-d H:i:s', 'object'=DateTime,
 	 * 		'array'=array with values for keys ('year','month','day','hour','minute','second','full','raw') or string with format
 	 * 		true = date only, false = time only as in user prefs, '' = date+time as in user prefs
@@ -507,7 +504,6 @@ 
 	 *
 	 * Compatibility method for old code. It is only valid for the given time, because of possible daylight saving changes!
 	 *
-	 * @param int|string|DateTime $time='now'
 	 * @return int difference in seconds between user and server time (for the given time!)
 	 */
 	public static function tz_offset_s($time='now')
@@ -558,7 +554,7 @@ 
 	 * - return UTC and oceans at the end
 	 * - if (user lang is a european language), move Europe to top
 	 *
-	 * @return array continent|ocean => array(tz-name => tz-label incl. current time)
+	 * @return string continent|ocean => array(tz-name => tz-label incl. current time)
 	 */
 	public static function getTimezones()
 	{

phpgwapi/inc/class.groupdav.inc.php

Doc Comments +18 added lines, -26 removed lines

@@ -307,6 +307,8 @@ 
 	 * @param string $path
 	 * @param array &$dav
 	 * @param array &$allow
+	 * @param integer[] $dav
+	 * @param boolean $allow
 	 */
 	function OPTIONS($path, &$dav, &$allow)
 	{
@@ -440,9 +442,7 @@ 
 	 * Add a collection to a PROPFIND request
 	 *
 	 * @param string $path
-	 * @param array $props=array() extra properties 'resourcetype' is added anyway, name => value pairs or name => HTTP_WebDAV_Server([namespace,]name,value)
-	 * @param array $privileges=array('read') values for current-user-privilege-set
-	 * @param array $supported_privileges=null default $this->supported_privileges
+	 * @param array $supported_privileges default $this->supported_privileges
 	 * @return array with values for keys 'path' and 'props'
 	 */
 	public function add_collection($path, array $props = array(), array $privileges=array('read','read-acl','read-current-user-privilege-set'), array $supported_privileges=null)
@@ -459,9 +459,7 @@ 
 	 * Add a resource to a PROPFIND request
 	 *
 	 * @param string $path
-	 * @param array $props=array() extra properties 'resourcetype' is added anyway, name => value pairs or name => HTTP_WebDAV_Server([namespace,]name,value)
-	 * @param array $privileges=array('read') values for current-user-privilege-set
-	 * @param array $supported_privileges=null default $this->supported_privileges
+	 * @param array $supported_privileges default $this->supported_privileges
 	 * @return array with values for keys 'path' and 'props'
 	 */
 	public function add_resource($path, array $props = array(), array $privileges=array('read','read-current-user-privilege-set'), array $supported_privileges=null)
@@ -534,7 +532,7 @@ 
 	 *
 	 * @param string $name name of privilege
 	 * @param string|array $data string with describtion or array with agregated privileges plus value for key '*description*', '*ns*', '*only*'
-	 * @param string $path=null path to match with $data['*only*']
+	 * @param string $path
 	 * @return array of self::mkprop() arrays
 	 */
 	protected function supported_privilege($name, $data, $path=null)
@@ -562,8 +560,7 @@ 
 	 * Checks if a given property was requested in propfind request
 	 *
 	 * @param string $name property name
-	 * @param string $ns=null namespace, if that is to be checked too
-	 * @param boolean $return_prop=false if true return the property array with values for 'name', 'xmlns', 'attrs', 'children'
+	 * @param boolean $return_prop if true return the property array with values for 'name', 'xmlns', 'attrs', 'children'
 	 * @return boolean|string|array true: $name explicitly requested (or autoindex), "all": allprop or "names": propname requested, false: $name was not requested
 	 */
 	function prop_requested($name, $ns=null, $return_prop=false)
@@ -599,7 +596,7 @@ 
 	 * @param string $path / or /<username>/
 	 * @param int $user
 	 * @param int $depth
-	 * @return string|boolean http status or true|false
+	 * @return boolean http status or true|false
 	 */
 	protected function add_home(array &$files, $path, $user, $depth)
 	{
@@ -691,7 +688,7 @@ 
 	 *
 	 * @param array &$files
 	 * @param string $path / or /<username>/
-	 * @param int $depth=0
+	 * @param int $depth
 	 * @return string|boolean http status or true|false
 	 */
 	protected function add_resources_collection(array &$files, $path, $depth=0)
@@ -731,7 +728,7 @@ 
 	 * @param string $path /<username>/
 	 * @param int $app
 	 * @param int $user
-	 * @return string|boolean http status or true|false
+	 * @return boolean http status or true|false
 	 */
 	protected function add_shared(array &$files, $path, $app, $user)
 	{
@@ -793,9 +790,7 @@ 
 	 * Add an application collection to a user home or the root
 	 *
 	 * @param string $app
-	 * @param boolean $no_extra_types=false should the GroupDAV and CalDAV types be added (KAddressbook has problems with it in self URL)
-	 * @param int $user=null owner of the collection, default current user
-	 * @param string $path='/'
+	 * @param boolean $no_extra_types should the GroupDAV and CalDAV types be added (KAddressbook has problems with it in self URL)
 	 * @return array with values for keys 'path' and 'props'
 	 */
 	protected function add_app($app,$no_extra_types=false,$user=null,$path='/')
@@ -1364,7 +1359,7 @@ 
 	 * @param int|string $id
 	 * @param array $attach array of array with values for keys 'name', 'params', 'value'
 	 * @param boolean $delete_via_put
-	 * @return boolean false on error, eg. invalid managed id, for false an xml-error body has been send
+	 * @return null|false false on error, eg. invalid managed id, for false an xml-error body has been send
 	 */
 	public static function handle_attach($app, $id, $attach, $delete_via_put=false)
 	{
@@ -1452,7 +1447,6 @@ 
 	 * @param string $app
 	 * @param int|string $id
 	 * @param string $filename defaults to 'attachment'
-	 * @param string $mime=null mime-type to generate extension
 	 * @param string &$path=null on return path opened
 	 * @return resource
 	 */
@@ -1565,9 +1559,7 @@ 
 	 * Return vfs-path of a managed-id
 	 *
 	 * @param string $managed_id
-	 * @param string $app=null app-name to check against path
-	 * @param string|int $id=null id to check agains path
-	 * @return string|boolean "/apps/$app/$id/something" or false if not found or not belonging to given $app/$id
+	 * @return false|string "/apps/$app/$id/something" or false if not found or not belonging to given $app/$id
 	 */
 	static public function managed_id2path($managed_id, $app=null, $id=null)
 	{
@@ -1757,7 +1749,7 @@ 
 	 * MKCOL method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function MKCOL($options)
 	{
@@ -1770,7 +1762,7 @@ 
 	 * MOVE method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function MOVE($options)
 	{
@@ -1783,7 +1775,7 @@ 
 	 * COPY method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function COPY($options, $del=false)
 	{
@@ -1796,7 +1788,7 @@ 
 	 * LOCK method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string|boolean   true on success
 	 */
 	function LOCK(&$options)
 	{
@@ -1829,7 +1821,7 @@ 
 	 * UNLOCK method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function UNLOCK(&$options)
 	{
@@ -2098,7 +2090,7 @@ 
 	 * Output xml error element
 	 *
 	 * @param string|array $xml_error string with name for empty element in DAV NS or array with props
-	 * @param string $human_readable=null human readable error message
+	 * @param string $human_readable human readable error message
 	 */
 	public static function xml_error($xml_error, $human_readable=null)
 	{

phpgwapi/inc/class.groupdav_handler.inc.php

Doc Comments +9 added lines, -18 removed lines

@@ -147,7 +147,7 @@ 
 	 *
 	 * @param string $path
 	 * @param array $filter
-	 * @param array|boolean $start false=return all or array(start,num)
+	 * @param integer[] $start false=return all or array(start,num)
 	 * @param int &$total
 	 * @return array with "files" array with values for keys path and props
 	 */
@@ -158,7 +158,6 @@ 
 	 *
 	 * @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')
 	 */
 	abstract function get(&$options,$id,$user=null);
@@ -168,7 +167,6 @@ 
 	 *
 	 * @param array &$options
 	 * @param int $id
-	 * @param int $user=null account_id of owner, default null
 	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	abstract function put(&$options,$id,$user=null);
@@ -186,7 +184,6 @@ 
 	 * Read an entry
 	 *
 	 * @param string|int $id
-	 * @param string $path=null implementation can use it, used in call from _common_get_put_delete
 	 * @return array|boolean array with entry, false if no read rights, null if $id does not exist
 	 */
 	abstract function read($id /*,$path=null*/);
@@ -214,10 +211,8 @@ 
 	/**
 	 * Add extra properties for collections
 	 *
-	 * @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)
@@ -228,8 +223,7 @@ 
 	/**
 	 * Get the etag for an entry, can be reimplemented for other algorithm or field names
 	 *
-	 * @param array|int $event array with event or cal_id
-	 * @return string|boolean string with etag or false
+	 * @return false|string string with etag or false
 	 */
 	function get_etag($entry)
 	{
@@ -268,7 +262,7 @@ 
 	 * @param array &$options
 	 * @param int|string &$id on return self::$path_extension got removed
 	 * @param boolean &$return_no_access=false if set to true on call, instead of '403 Forbidden' the entry is returned and $return_no_access===false
-	 * @param boolean $ignore_if_match=false if true, ignore If-Match precondition
+	 * @param boolean $ignore_if_match if true, ignore If-Match precondition
 	 * @return array|string entry on success, string with http-error-code on failure, null for PUT on an unknown id
 	 */
 	function _common_get_put_delete($method,&$options,&$id,&$return_no_access=false,$ignore_if_match=false)
@@ -343,7 +337,6 @@ 
 	 *
 	 * @param array $options
 	 * @param int $id
-	 * @param int $user=null account_id
 	 * @return string|boolean http status of get or null if no representation was requested
 	 */
 	public function check_return_representation($options, $id, $user=null)
@@ -416,7 +409,7 @@ 
 	/**
 	 * Identify know GroupDAV agents by HTTP_USER_AGENT header
 	 *
-	 * @return string|boolean agent name or false
+	 * @return string|false agent name or false
 	 */
 	static function get_agent()
 	{
@@ -503,7 +496,6 @@ 
 	 * Priviledges are for the collection, not the resources / entries!
 	 *
 	 * @param string $path path of collection
-	 * @param int $user=null owner of the collection, default current user
 	 * @return array with privileges
 	 */
 	public function current_user_privileges($path, $user=null)
@@ -556,8 +548,8 @@ 
 	 * @param int|array $entry id or array of new created entry
 	 * @param string $path
 	 * @param int|string $retval
-	 * @param boolean $path_attr_is_name=true true: path_attr is ca(l|rd)dav_name, false: id (GroupDAV needs Location header)
-	 * @param string $etag=null etag, to not calculate it again (if != null)
+	 * @param boolean $path_attr_is_name true: path_attr is ca(l|rd)dav_name, false: id (GroupDAV needs Location header)
+	 * @param string $etag
 	 */
 	function put_response_headers($entry, $path, $retval, $path_attr_is_name=true, $etag=null)
 	{
@@ -655,7 +647,7 @@ 
 	 *
 	 * base_uri of WebDAV class can be both, depending on EGroupware config
 	 *
-	 * @param boolean $full_uri=true
+	 * @param boolean $full_uri
 	 * @return string eg. https://domain.com/egroupware/groupdav.php
 	 */
 	public function base_uri($full_uri=true)
@@ -726,7 +718,6 @@ 
 	 *
 	 * @param string $path
 	 * @param int $user parameter necessary to call getctag, if no $token specified
-	 * @param int $token=null modification time, default call getctag($path, $user) to fetch it
 	 * @return string
 	 */
 	public function get_sync_token($path, $user, $token=null)
@@ -822,7 +813,7 @@ 
 	 *
 	 * @param groupdav_handler $handler
 	 * @param array $filter filter for propfind call
-	 * @param array $files=array() extra files/responses to return too
+	 * @param string $path
 	 */
 	public function __construct(groupdav_handler $handler, $path, array $filter,array &$files=array())
 	{

phpgwapi/inc/class.groupdav_principals.inc.php

Doc Comments +14 added lines, -29 removed lines

@@ -78,7 +78,7 @@ 
 	 * Currently we return all reports independed of path
 	 *
 	 * @param string $path eg. '/principals/'
-	 * @param array $reports=null
+	 * @param array $reports
 	 * @return array HTTP_WebDAV_Server::mkprop('supported-report-set', ...)
 	 */
 	protected function supported_report_set($path, array $reports=null)
@@ -246,7 +246,7 @@ 
 	 * @param array &$options
 	 * @param array &$files
 	 * @param int $user account_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 expand_property_report($path,&$options,&$files,$user)
 	{
@@ -559,7 +559,6 @@ 
 	 *
 	 * @param string $value value to test
 	 * @param string $match criteria/sub-string
-	 * @param string $match_type='contains' 'starts-with', 'ends-with' or 'equals'
 	 */
 	private static function match($value, $match, $match_type='contains')
 	{
@@ -972,8 +971,7 @@ 
 	 * Convert CalDAV principal URL to a calendar uid
 	 *
 	 * @param string $url
-	 * @param string|array $only_type=null allowed types, return false for other (valid) types, eg. "users", "groups" or "resources", default all
-	 * @param string $cn=null common name to be stored in case of an "e" uid
+	 * @param string|array $only_type allowed types, return false for other (valid) types, eg. "users", "groups" or "resources", default all
 	 * @return int|string|boolean integer account_id, string calendar uid or false if not a supported uid
 	 */
 	static public function url2uid($url, $only_type=null, $cn=null)
@@ -1118,7 +1116,7 @@ 
 	 * Add collection of a single resource to a collection
 	 *
 	 * @param array $resource
-	 * @param boolean $is_location=null
+	 * @param boolean $is_location
 	 * @return array with values for keys 'path' and 'props'
 	 */
 	protected function add_principal_resource(array $resource, $is_location=null)
@@ -1169,7 +1167,7 @@ 
 	 * Check if resource is a location
 	 *
 	 * @param array|int $resource
-	 * @return boolean
+	 * @return null|boolean
 	 */
 	public static function resource_is_location($resource)
 	{
@@ -1233,7 +1231,6 @@ 
 	/**
 	 * Get all resources (we cache the resources here, to only query them once per request)
 	 *
-	 * @param int $user=null account_if of user, or null for current user
 	 * @return array of array with values for res_id, cat_id and name (no other values1)
 	 */
 	public static function get_resources($user=null)
@@ -1283,7 +1280,6 @@ 
 	 * Add a collection
 	 *
 	 * @param string $path
-	 * @param array $props=array() extra properties 'resourcetype' is added anyway, name => value pairs or name => HTTP_WebDAV_Server([namespace,]name,value)
 	 * @return array with values for keys 'path' and 'props'
 	 */
 	protected function add_collection($path, array $props = array())
@@ -1299,8 +1295,7 @@ 
 	 * Add a principal collection
 	 *
 	 * @param string $principal relative to principal-collection-set, eg. "users/username"
-	 * @param array $props=array() extra properties 'resourcetype' is added anyway
-	 * @param string $principal_url=null include given principal url, relative to principal-collection-set, default $principal
+	 * @param string $principal_url include given principal url, relative to principal-collection-set, default $principal
 	 * @return array with values for keys 'path' and 'props'
 	 */
 	protected function add_principal($principal, array $props = array(), $principal_url=null)
@@ -1327,8 +1322,7 @@ 
 	 *
 	 * @param string $principal relative to principal-collection-set, eg. "users/username"
 	 * @param string $type eg. 'calendar-proxy-read' or 'calendar-proxy-write'
-	 * @param array $proxys=array()
-	 * @param array $resource=null resource to use (to not query it multiple times from the database)
+	 * @param array $resource resource to use (to not query it multiple times from the database)
 	 * @return array with values for 'path' and 'props'
 	 */
 	protected function add_proxys($principal, $type, array $proxys=array(), array $resource=null)
@@ -1405,9 +1399,8 @@ 
 	 * Create a named property with set or principal-urls
 	 *
 	 * @param string $prop egw. 'group-member-set' or 'membership'
-	 * @param array $accounts=array() account_id => account_lid pairs
-	 * @param string|array $app_proxys=null applications for which proxys should be added
 	 * @param int $account who is the proxy
+	 * @param string[] $add_proxys
 	 * @return array with href props
 	 */
 	protected function principal_set($prop, array $accounts=array(), $add_proxys=null, $account=null)
@@ -1445,7 +1438,6 @@ 
 	 * Get proxy-groups for given user $account: users or groups who GRANT proxy rights to $account
 	 *
 	 * @param int $account who is the proxy
-	 * @param string|array $app_proxys=null applications for which proxys should be added
 	 * @return array with href props
 	 */
 	protected function get_resource_proxy_groups($account)
@@ -1489,7 +1481,6 @@ 
 	 * Get proxy-groups for given user $account: users or groups who GRANT proxy rights to $account
 	 *
 	 * @param int $account who is the proxy
-	 * @param string|array $app_proxys=null applications for which proxys should be added
 	 * @return array with href props
 	 */
 	protected function get_calendar_proxy_groups($account, $app='calendar')
@@ -1515,7 +1506,7 @@ 
 	 * @param string $name name of group or empty
 	 * @param string $rest rest of path behind account-name
 	 * @param array $options
-	 * @param boolean $do_locations=false false: /principal/resources, true: /principals/locations
+	 * @param boolean $do_locations false: /principal/resources, true: /principals/locations
 	 * @return array|string array with files or HTTP error code
 	 */
 	protected function propfind_resources($name,$rest,array $options,$do_locations=false)
@@ -1583,8 +1574,6 @@ 
 	/**
 	 * Do propfind of /principals/
 	 *
-	 * @param string $name name of group or empty
-	 * @param string $rest name of rest of path behind group-name
 	 * @param array $options
 	 * @return array|string array with files or HTTP error code
 	 */
@@ -1614,8 +1603,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 boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function get(&$options,$id,$user=null)
 	{
@@ -1627,8 +1615,7 @@ 
 	 *
 	 * @param array &$options
 	 * @param int $id
-	 * @param int $user=null account_id of owner, default null
-	 * @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 put(&$options,$id,$user=null)
 	{
@@ -1640,7 +1627,7 @@ 
 	 *
 	 * @param array &$options
 	 * @param int $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 delete(&$options,$id)
 	{
@@ -1663,7 +1650,7 @@ 
 	 *
 	 * @param int $acl EGW_ACL_READ, EGW_ACL_EDIT or EGW_ACL_DELETE
 	 * @param array/int $entry entry-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,$entry)
 	{
@@ -1681,7 +1668,6 @@ 
 	/**
 	 * Get the etag for an entry, can be reimplemented for other algorithm or field names
 	 *
-	 * @param array/int $event array with event or cal_id
 	 * @return string/boolean string with etag or false
 	 */
 	function get_etag($account)
@@ -1705,8 +1691,7 @@ 
 	 * Privileges are for the collection, not the resources / entries!
 	 *
 	 * @param string $path path of collection
-	 * @param int $user=null owner of the collection, default current user
-	 * @return array with privileges
+	 * @return string[] with privileges
 	 */
 	public function current_user_privileges($path, $user=null)
 	{

phpgwapi/inc/class.historylog.inc.php

Doc Comments +2 added lines

@@ -112,6 +112,8 @@
 
 	/**
 	 * Static function to add a history record
+	 * @param string $field_code
+	 * @param string $new_value
 	 */
 	public static function static_add($appname, $id, $user, $field_code, $new_value, $old_value = '')
 	{

phpgwapi/inc/class.hooks.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -270,7 +270,7 @@
 	 *
 	 * @param string $appname Application 'name'
 	 * @param string $location is required, the hook itself
-	 * @return boolean|int false on error, true if new hooks are supplied and registed or number of removed hooks
+	 * @return boolean false on error, true if new hooks are supplied and registed or number of removed hooks
 	 */
 	function register_single_app_hook($appname, $location)
 	{

phpgwapi/inc/class.html.inc.php

Doc Comments +5 added lines, -7 removed lines

@@ -308,7 +308,7 @@ 
 	 *
 	 * @param string $name	string with name of the submitted var which holds the key of the selected item form array
 	 * @param string|array $key key(s) of already selected item(s) from $arr, eg. '1' or '1,2' or array with keys
-	 * @param array $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
+	 * @param integer $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
 	 * @param boolean $no_lang NOT run the labels of the options through lang(), default false=use lang()
 	 * @param string $options additional options (e.g. 'width')
 	 * @param int $multiple number of lines for a multiselect, default 0 = no multiselect, < 0 sets size without multiple
@@ -396,7 +396,7 @@ 
 	 *
 	 * @param string $name	string with name of the submitted var which holds the key of the selected item form array
 	 * @param string|array $key key(s) of already selected item(s) from $arr, eg. '1' or '1,2' or array with keys
-	 * @param array $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
+	 * @param integer $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
 	 * @param boolean $no_lang NOT run the labels of the options through lang(), default false=use lang()
 	 * @param string $options additional options (e.g. 'width')
 	 * @param int $multiple number of lines for a multiselect, default 3
@@ -482,7 +482,7 @@ 
 	 * @param string $value value
 	 * @param string $label label
 	 * @param mixed $selected value or array of values of options to mark as selected
-	 * @param boolean $no_lang NOT running the label through lang(), default false=use lang()
+	 * @param integer $no_lang NOT running the label through lang(), default false=use lang()
 	 * @param string $extra extra text, e.g.: style="", default: ''
 	 * @return string html
 	 */
@@ -555,7 +555,6 @@ 
 	 *
 	 * @param string $name name attr. of the tag
 	 * @param string $value default
-	 * @param boolean $ignore_empty if true all empty, zero (!) or unset values, plus filer=none
 	 * @param boolean $double_encoding =false do we want double encoding or not, default no
 	 * @param string html
 	 */
@@ -913,7 +912,6 @@ 
 	 * @param array $hidden_vars array with name-value pairs for hidden input fields
 	 * @param string $url eGW relative URL, will be run through the link function
 	 * @param string|array $url_vars parameters for the URL, send to link static function too
-	 * @param string $options attributes for the tag, default ''=none
 	 * @param string $form_name name of the form, defaul ''=none
 	 * @param string $method method of the form, default 'POST'
 	 * @return string html
@@ -1209,7 +1207,7 @@ 
 	 * Example: formatOptions('100%,,1','width,height,border') = ' width="100%" border="1"'
 	 *
 	 * @param mixed $options String (or Array) with option-values eg. '100%,,1'
-	 * @param mixed $names String (or Array) with the option-names eg. 'WIDTH,HEIGHT,BORDER'
+	 * @param string $names String (or Array) with the option-names eg. 'WIDTH,HEIGHT,BORDER'
 	 * @return string with options/attributes
 	 */
 	static function formatOptions($options,$names)
@@ -1312,7 +1310,7 @@ 
 	 * @author Lars Kneschke <lars-AT-kneschke.de> original code in felamimail
 	 * @param array $_folders array of folders: pairs path => node (string label or array with keys: label, (optional) image, (optional) title, (optional) checked)
 	 * @param string $_selected path of selected folder
-	 * @param mixed $_topFolder =false node of topFolder or false for none
+	 * @param boolean $_topFolder =false node of topFolder or false for none
 	 * @param string $_onNodeSelect ='alert' js static function to call if node gets selected
 	 * @param string $tree ='foldertree' id of the div and name of the variable containing the tree object
 	 * @param string $_divClass ='' css class of the div

phpgwapi/inc/class.ischedule_client.inc.php

Doc Comments +4 added lines, -11 removed lines

@@ -68,8 +68,7 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param string|array $recipients=null recipient email-address(es)
-	 * @param string $url=null ischedule url, if it should NOT be discovered
+	 * @param string|array $recipients recipient email-address(es)
 	 * @throws Exception in case of an error or discovery failure
 	 */
 	public function __construct($recipients, $url=null)
@@ -121,8 +120,7 @@ 
 	 * @param string|array $recipients (array of) mailto urls (from same domain!)
 	 * @param int $start starttime
 	 * @param int $end endtime
-	 * @param string $uid=null
-	 * @param string $originator=null default current user's email
+	 * @param string $originator default current user's email
 	 * @return array with values for keys 'schedule-response' or 'error'
 	 * @throws Exception if discovery of recipient(s) fails
 	 */
@@ -190,7 +188,7 @@ 
 	 * Set originator and (optional) DKIM private key
 	 *
 	 * @param string $originator
-	 * @param string $dkim_private_key=null
+	 * @param string $dkim_private_key
 	 * @throws Exception for invalid / not an email originator
 	 */
 	public function setOriginator($originator, $dkim_private_key=null)
@@ -279,8 +277,7 @@ 
 	 *
 	 * @param string $content
 	 * @param string $content_type
-	 * @param boolean $debug=false true echo request before posting
-	 * @param int $max_redirect=3 maximum number of redirect before failing
+	 * @param int $max_redirect maximum number of redirect before failing
 	 * @return string
 	 * @throws Exception with http status code and message, if server responds other then 2xx
 	 */
@@ -366,10 +363,7 @@ 
 	 *
 	 * @param array $headers name => value pairs, names as in $sign_headers
 	 * @param string $body
-	 * @param string $selector='calendar'
-	 * @param string $sign_headers='iSchedule-Version:Content-Type:Originator:Recipient'
 	 * @param int $expires seconds the signature is valid, default 300
-	 * @param boolean $fold=false true: return folded signature, false: return a single line
 	 * @return string DKIM-Signature: ...
 	 */
 	public function dkim_sign(array $headers, $body, $selector='calendar',$sign_headers=self::DKIM_HEADERS,$expires=300,$fold=false)
@@ -418,7 +412,6 @@ 
 	/**
 	 * Query capabilities of iSchedule server
 	 *
-	 * @param string $name=null name of capability to return, default null to return internal array with all capabilities
 	 * @return mixed
 	 * @throws Exception in case of an error or discovery failure
 	 */

phpgwapi/inc/class.ischedule_server.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -320,7 +320,7 @@ 
 	 *
 	 * @param array $event
 	 * @param calendar_ical $handler
-	 * @param string $component
+	 * @param Horde_iCalendar_vevent $component
 	 * @param XMLWriter $xml
 	 */
 	function vevent(array $event, calendar_ical $handler, Horde_iCalendar_vevent $component, XMLWriter $xml)
@@ -636,7 +636,7 @@ 
 	 *
 	 * @param string $d domain
 	 * @param string $s selector
-	 * @return string|boolean string with (full) public key or false if not found or other error retrieving it
+	 * @return false|string string with (full) public key or false if not found or other error retrieving it
 	 */
 	public static function well_known_pubkey($d, $s)
 	{
@@ -653,7 +653,7 @@ 
 	 *
 	 * @param string $d domain
 	 * @param string $s selector
-	 * @return string|boolean string with (full) public key or false if not found or other error retrieving it
+	 * @return false|string string with (full) public key or false if not found or other error retrieving it
 	 */
 	public function dns_txt_pubkey($d, $s)
 	{