EGroupware / egroupware

api/src/CalDAV.php

Doc Comments +11 added lines, -9 removed lines

@@ -311,6 +311,8 @@ 
 	 * @param string $path
 	 * @param array &$dav
 	 * @param array &$allow
+	 * @param integer[] $dav
+	 * @param boolean $allow
 	 */
 	function OPTIONS($path, &$dav, &$allow)
 	{
@@ -606,7 +608,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)
 	{
@@ -738,7 +740,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)
 	{
@@ -1380,7 +1382,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)
 	{
@@ -1584,7 +1586,7 @@ 
 	 * @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)
 	{
@@ -1783,7 +1785,7 @@ 
 	 * MKCOL method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function MKCOL($options)
 	{
@@ -1796,7 +1798,7 @@ 
 	 * MOVE method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function MOVE($options)
 	{
@@ -1809,7 +1811,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)
 	{
@@ -1822,7 +1824,7 @@ 
 	 * LOCK method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string|boolean   true on success
 	 */
 	function LOCK(&$options)
 	{
@@ -1856,7 +1858,7 @@ 
 	 * UNLOCK method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function UNLOCK(&$options)
 	{

api/src/CalDAV/Handler.php

Doc Comments +3 added lines, -4 removed lines

@@ -151,7 +151,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
 	 */
@@ -193,7 +193,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*/);
@@ -238,7 +237,7 @@ 
 	 * Get the etag for an entry, can be reimplemented for other algorithm or field names
 	 *
 	 * @param array|int $entry 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)
 	{
@@ -423,7 +422,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()
 	{

api/src/CalDAV/Principals.php

Doc Comments +8 added lines, -11 removed lines

@@ -256,7 +256,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)
 	{
@@ -1191,7 +1191,7 @@ 
 	 * Check if resource is a location
 	 *
 	 * @param array|int $resource
-	 * @return boolean
+	 * @return null|boolean
 	 */
 	public static function resource_is_location($resource)
 	{
@@ -1470,7 +1470,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)
@@ -1608,8 +1607,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
 	 */
@@ -1640,7 +1637,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)
 	{
@@ -1655,7 +1652,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)
 	{
@@ -1669,7 +1666,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)
 	{
@@ -1681,7 +1678,7 @@ 
 	/**
 	 * Read an entry
 	 *
-	 * @param string|int $id
+	 * @param integer $id
 	 * @return array/boolean array with entry, false if no read rights, null if $id does not exist
 	 */
 	function read($id)
@@ -1696,7 +1693,7 @@ 
 	 *
 	 * @param int $acl Api\Acl::READ, Api\Acl::EDIT or Api\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)
 	{
@@ -1739,7 +1736,7 @@ 
 	 *
 	 * @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)
 	{

api/src/CalDAV/PropfindIterator.php

Doc Comments +1 added lines

@@ -94,6 +94,7 @@
 	 * @param 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(Handler $handler, $path, array $filter,array &$files=array())
 	{

api/src/Categories.php

Doc Comments +6 added lines, -6 removed lines

@@ -322,13 +322,13 @@ 
 	 * return a sorted array populated with categories (main sorting criteria is hierachy!)
 	 *
 	 * @param int $start =0 see $limit
-	 * @param boolean|int $limit if true limited query to maxmatches rows (starting with $start)
+	 * @param boolean $limit if true limited query to maxmatches rows (starting with $start)
 	 * @param string $query ='' query-pattern
 	 * @param string $sort ='ASC' sort order, either defaults to 'ASC'
 	 * @param string $order ='cat_name' order by
 	 * @param boolean|string $globals includes the global egroupware categories or not,
 	 * 	'all_no_acl' to return global and all non-private user categories independent of ACL
-	 * @param array|int $parent_id =0 return only subcats of $parent_id(s)
+	 * @param integer $parent_id =0 return only subcats of $parent_id(s)
 	 * @param boolean $unserialize_data =true return $cat['data'] as array (not serialized array)
 	 * @return array with cats
 	 */
@@ -507,7 +507,7 @@ 
 	 * @param mixed $category category as array or the category_id
 	 * @param boolean $no_acl_check =false if true, grants are NOT checked, gives access to all non-private categories of all users
 	 * @param boolean $allow_global_read if true, global cats are allowed (independent of app) for reading
-	 * @return boolean true permission granted, false for permission denied, null for category does not exist
+	 * @return null|boolean true permission granted, false for permission denied, null for category does not exist
 	 */
 	public function check_perms($needed, $category, $no_acl_check=false, $allow_global_read=false)
 	{
@@ -675,7 +675,7 @@ 
 	 * check_consistency4update - for edit
 	 *
 	 * @param array $values array with cat-data (it need to be complete, as everything get's written)
-	 * @return mixed string/boolean errorstring if consitency check failed / true if the consistency check did not fail
+	 * @return string|boolean string/boolean errorstring if consitency check failed / true if the consistency check did not fail
 	 */
 	function check_consistency4update($values)
 	{
@@ -822,7 +822,7 @@ 
 	 *
 	 * @param int|array $cat
 	 * @param boolean $application_global =false true check for application global categories only (appname == 'phpgw')
-	 * @return boolean
+	 * @return null|boolean
 	 */
 	static function is_global($cat,$application_global=false)
 	{
@@ -1030,7 +1030,7 @@ 
 	 *
 	 * @param string appname
 	 *
-	 * @return Returns the URL, but you do not need to do anything with it.
+	 * @return string the URL, but you do not need to do anything with it.
 	 */
 	public static function css($appname)
 	{

api/src/Config.php

Doc Comments +1 added lines, -1 removed lines

@@ -194,7 +194,7 @@
 	/**
 	 * sets a single value in the repositry, you need to call save_repository after
 	 *
-	 * @param $variable_name string name of the config
+	 * @param string $variable_name string name of the config
 	 * @param $variable_data mixed the content
 	 */
 	function value($variable_name,$variable_data)

api/src/Contacts.php

Doc Comments +7 added lines, -5 removed lines

@@ -484,7 +484,6 @@ 
 	/**
 	 * get selectbox options for the customfields
 	 *
-	 * @param array $field =null
 	 * @return array with options:
 	 */
 	public static function cf_options()
@@ -536,7 +535,7 @@ 
 	 * @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
+	 * @return string|null number of contacts updated, false for wrong fileas type
 	 */
 	function set_all_fileas($fileas_type,$all=false,&$errors=null,$ignore_acl=false)
 	{
@@ -597,7 +596,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)
 	{
@@ -1122,7 +1121,7 @@ 
 	 * @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
+	 * @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)
 	{
@@ -1179,7 +1178,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)
 	{
@@ -2094,6 +2093,9 @@ 
 		return $cat_id_list;
 	}
 
+	/**
+	 * @param string $cat_id_list
+	 */
 	function get_categories($cat_id_list)
 	{
 		if (!is_object($this->categories))

api/src/Contacts/Ads.php

Doc Comments -1 removed lines

@@ -213,7 +213,6 @@
 	/**
 	 * Remove attributes we are not allowed to update
 	 *
-	 * @param array $attributes
 	 */
 	function sanitize_update(array &$ldapContact)
 	{

api/src/Contacts/Ldap.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!