EGroupware / egroupware

phpgwapi/inc/class.egw_include_mgr.inc.php

Doc Comments +2 added lines, -7 removed lines

@@ -270,8 +270,6 @@ 
 	 *    --> /phpgwapi/inc/calendar-setup.js?lang=de
 	 *
 	 * @param string $package package or complete path (relative to EGW_SERVER_ROOT) to be included
-	 * @param string|array $file=null file to be included - no ".js" on the end or array with get params
-	 * @param string $app='phpgwapi' application directory to search - default = phpgwapi
 	 *
 	 * @returns the correct path on the server if the file is found or false, if the
 	 *  file is not found or no further processing is needed.
@@ -332,8 +330,6 @@ 
 	 *    --> /phpgwapi/inc/calendar-setup.js?lang=de
 	 *
 	 * @param string $package package or complete path (relative to EGW_SERVER_ROOT) to be included
-	 * @param string|array $file=null file to be included - no ".js" on the end or array with get params
-	 * @param string $app='phpgwapi' application directory to search - default = phpgwapi
 	 */
 	public function include_js_file($package, $file = null, $app = 'phpgwapi')
 	{
@@ -361,7 +357,7 @@ 
 	 * Include given files, optionally clear list of files to include
 	 *
 	 * @param array $files
-	 * @param boolean $clear_files=false if true clear list of files, before including given ones
+	 * @param boolean $clear_files if true clear list of files, before including given ones
 	 */
 	public function include_files(array $files, $clear_files=false)
 	{
@@ -376,7 +372,7 @@ 
 	/**
 	 * Return all files
 	 *
-	 * @param boolean $clear_files=false if true clear list of files after returning them
+	 * @param boolean $clear_files if true clear list of files after returning them
 	 * @return array
 	 */
 	public function get_included_files($clear_files=false)
@@ -389,7 +385,6 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param array $files=null optional files to include as for include_files method
 	 */
 	public function __construct(array $files = null)
 	{

phpgwapi/inc/class.egw_index.inc.php

Doc Comments +6 added lines, -16 removed lines

@@ -72,11 +72,7 @@ 
 	 * Constructor for the search iterator
 	 *
 	 * @param string $keyword
-	 * @param string $app=null
-	 * @param string $order='app' ordered by column: 'owner', 'id', 'app' (default)
-	 * @param string $sort='ASC' sorting 'ASC' (default) or 'DESC'
-	 * @param int $start=null if not null return limited resultset starting with row $start
-	 * @param int $num_rows=0 number of rows for a limited resultset, defaul maxmatches from the user prefs
+	 * @param int $num_rows number of rows for a limited resultset, defaul maxmatches from the user prefs
 	 */
 	function __construct($keyword,$app=null,$order='title',$sort='ASC',$start=null,$num_rows=0)
 	{
@@ -97,11 +93,7 @@ 
 	 * Search for keywords
 	 *
 	 * @param string $keyword
-	 * @param string $app=null
-	 * @param string $order='app' ordered by column: 'keyword', 'id', 'app' (default)
-	 * @param string $sort='ASC' sorting 'ASC' (default) or 'DESC'
-	 * @param int $start=null if not null return limited resultset starting with row $start
-	 * @param int $num_rows=null number of rows for a limited resultset, defaul maxmatches from the user prefs
+	 * @param int $num_rows number of rows for a limited resultset, defaul maxmatches from the user prefs
 	 * @return array with "$app:$id" or $id => $title pairs
 	 */
 	static function &search($keyword,$app=null,$order='title',$sort='ASC',$start=null,$num_rows=null)
@@ -168,7 +160,7 @@ 
 	 * @param string|int $id
 	 * @param string $owner eGW account_id of the owner of the entry, used to create a "private entry of ..." title
 	 * @param array $fields
-	 * @param array|int|string $cat_ids=null optional cat_id(s) either comma-separated or as array
+	 * @param array|int|string $cat_ids optional cat_id(s) either comma-separated or as array
 	 * @param array $ignore_fields=array() keys of fields NOT to index
 	 * @return int|boolean false on error, othwerwise number off added keywords
 	 */
@@ -219,7 +211,6 @@ 
 	 * Delete the keywords for an entry or an entire application
 	 *
 	 * @param string $app
-	 * @param string|int $id=null
 	 */
 	static function delete($app,$id=null)
 	{
@@ -282,7 +273,7 @@ 
 	 * @param string $app
 	 * @param string|int $id
 	 * @param string $keyword
-	 * @param int $owner=null
+	 * @param string $owner
 	 * @return boolean true if keyword added, false if it was rejected in future
 	 */
 	static private function add($app,$id,$keyword,$owner=null)
@@ -321,8 +312,8 @@ 
 	 *
 	 * @param string $app
 	 * @param string|int $id
-	 * @param array|int|string $cat_ids=null optional cat_id(s) either comma-separated or as array
-	 * @param int $owner=null
+	 * @param array|int|string $cat_ids optional cat_id(s) either comma-separated or as array
+	 * @param string $owner
 	 * @return boolean true on success, false on error
 	 */
 	static private function add_cats($app,$id,$cat_ids,$owner=null)
@@ -351,7 +342,6 @@ 
 	 * Delete the cat for an entry or an entire application
 	 *
 	 * @param string $app
-	 * @param string|int $id=null
 	 */
 	static private function delete_cats($app,$id=null)
 	{

phpgwapi/inc/class.egw_json.inc.php

Doc Comments +6 added lines, -5 removed lines

@@ -235,8 +235,7 @@ 
 	/**
 	 * Allows to call a global javascript function with given parameters: window[$func].call(window[, $param1[, ...]])
 	 *
-	 * @param string $func name of the global (window) javascript function to call
-	 * @param mixed $parameters variable number of parameters
+	 * @param string $function
 	 */
 	public function call($function)
 	{
@@ -261,7 +260,7 @@ 
 	 *
 	 * @param string $selector jquery selector
 	 * @param string $method name of the jquery to call
-	 * @param array $parameters =array()
+	 * @param string[] $parameters =array()
 	 */
 	public function jquery($selector,$method,array $parameters=array())
 	{
@@ -279,6 +278,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public function generic($type, array $parameters = array())
 	{
 		if (is_string($type))
@@ -544,7 +546,6 @@ 
 	/**
 	 * Init responseArray
 	 *
-	 * @param array $arr
 	 * @return array previous content
 	 */
 	public function initResponseArray()
@@ -628,7 +629,7 @@ 
 	 *
 	 * @param midex $var
 	 * @param string $prefix =''
-	 * @return mixed
+	 * @return midex|null
 	 */
 	public static function fix_content($var, $prefix='')
 	{

phpgwapi/inc/class.egw_link.inc.php

Doc Comments +3 added lines, -5 removed lines

@@ -433,7 +433,7 @@ 
 	 * generate temporary link_id used as array-key
 	 *
 	 * @param string $app app-name
-	 * @param mixed $id
+	 * @param string $id
 	 * @return string
 	 */
 	static function temp_link_id($app,$id)
@@ -579,7 +579,7 @@ 
 	 * @param string|array $id ='' id if $app_link_id is an appname or array with links, if 1. entry not yet created
 	 * @param string $app2 ='' second app
 	 * @param string $id2 ='' id in $app2
-	 * @return array with link-data or False
+	 * @return string with link-data or False
 	 */
 	static function get_link($app_link_id,$id='',$app2='',$id2='')
 	{
@@ -734,7 +734,6 @@ 
 	 *
 	 * @param string $app app to search
 	 * @param string $pattern pattern to search
-	 * @param string $type Search only a certain sub-type of records (optional)
 	 * @return array with $id => $title pairs of matching entries of app
 	 */
 	static function query($app,$pattern, &$options = array())
@@ -1232,7 +1231,6 @@ 
 	 * @param string $app appname to link the file to
 	 * @param string $id id in $app
 	 * @param string $file VFS path to link to
-	 * @param string $comment ='' comment to add to the link
 	 */
 	static function link_file($app,$id,$file)//,$comment='')
 	{
@@ -1259,7 +1257,7 @@ 
 	 * @param int|string $app > 0: file_id of an attchemnt or $app/$id entry which linked to
 	 * @param string $id ='' id in app
 	 * @param string $fname ='' filename
-	 * @return boolean|array false on error ($app or $id not found), array with path as key and boolean result of delete
+	 * @return boolean false on error ($app or $id not found), array with path as key and boolean result of delete
 	 */
 	static function delete_attached($app,$id='',$fname='')
 	{

phpgwapi/inc/class.egw_mailer.inc.php

Doc Comments +6 added lines, -4 removed lines

@@ -235,7 +235,7 @@ 
 	/**
 	 * Add one or multiple addresses to Cc
 	 *
-	 * @param string|array|Horde_Mail_Rfc822_List $address
+	 * @param string $address
 	 * @param string $personal ='' only used if $address is a string
 	 */
 	function addCc($address, $personal=null)
@@ -254,7 +254,7 @@ 
 	/**
 	 * Add one or multiple addresses to Bcc
 	 *
-	 * @param string|array|Horde_Mail_Rfc822_List $address
+	 * @param string $address
 	 * @param string $personal ='' only used if $address is a string
 	 */
 	function addBcc($address, $personal=null)
@@ -273,7 +273,7 @@ 
 	/**
 	 * Add one or multiple addresses to Reply-To
 	 *
-	 * @param string|array|Horde_Mail_Rfc822_List $address
+	 * @param false|string $address
 	 * @param string $personal ='' only used if $address is a string
 	 */
 	function addReplyTo($address, $personal=null)
@@ -365,7 +365,7 @@ 
 	/**
 	 * Adds an embedded image or other inline attachment
 	 *
-	 * @param string|resource $data Path to the attachment or open file-descriptor
+	 * @param string $data Path to the attachment or open file-descriptor
 	 * @param string $cid Content ID of the attachment.  Use this to identify
 	 *        the Id for accessing the image in an HTML form.
 	 * @param string $name Overrides the attachment name.
@@ -833,6 +833,7 @@ 
 
 	/**
 	 * @deprecated use AddHeader($header, $value)
+	 * @param string $str
 	 */
 	function AddCustomHeader($str)
 	{
@@ -851,6 +852,7 @@ 
 	}
 	/**
 	 * @deprecated done by Horde automatic
+	 * @return string
 	 */
 	function EncodeHeader($str/*, $position = 'text'*/)
 	{

phpgwapi/inc/class.egw_session.inc.php

Doc Comments +3 added lines, -2 removed lines

@@ -311,6 +311,7 @@ 
 	 * Encrypt the variables in the session
 	 *
 	 * Is called by self::__destruct().
+	 * @param string $kp3
 	 */
 	static function encrypt($kp3)
 	{
@@ -439,7 +440,7 @@ 
 	 * @param boolean $no_session =false dont create a real session, eg. for GroupDAV clients using only basic auth, no cookie support
 	 * @param boolean $auth_check =true if false, the user is loged in without checking his password (eg. for single sign on), default = true
 	 * @param boolean $fail_on_forced_password_change =false true: do NOT create session, if password change requested
-	 * @return string|boolean session id or false if session was not created, $this->(cd_)reason contains cause
+	 * @return false|string session id or false if session was not created, $this->(cd_)reason contains cause
 	 */
 	function create($login,$passwd = '',$passwd_type = '',$no_session=false,$auth_check=true,$fail_on_forced_password_change=false)
 	{
@@ -1021,7 +1022,7 @@ 
 	/**
 	 * Terminate a session
 	 *
-	 * @param int|string $sessionid nummeric or php session id of session to be terminated
+	 * @param string $sessionid nummeric or php session id of session to be terminated
 	 * @param string $kp3
 	 * @return boolean true on success, false on error
 	 */

phpgwapi/inc/class.egw_session_files.inc.php

Doc Comments +1 added lines, -3 removed lines

@@ -32,9 +32,7 @@
 	 * The data from the session-files get cached in $_SESSION['egw_files_session_cache']
 	 *
 	 * @param int $start
-	 * @param string $sort='session_dla' session_lid, session_id, session_started, session_logintime, session_action, or (default) session_dla
-	 * @param string $order='DESC' ASC or DESC
-	 * @param boolean $all_no_sort=False skip sorting and limiting to maxmatchs if set to true
+	 * @param boolean $all_no_sort skip sorting and limiting to maxmatchs if set to true
 	 * @return array with sessions (values for keys as in $sort) or array() if not supported by session-handler
 	 */
 	public static function session_list($start,$sort='DESC',$order='session_dla',$all_no_sort=False)

phpgwapi/inc/class.egw_session_memcache.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -109,7 +109,7 @@
 	 * with a fatal error!
 	 *
 	 * @param string $id
-	 * @return string|boolean false on error, '' for not found session otherwise session data
+	 * @return false|string false on error, '' for not found session otherwise session data
 	 */
 	public static function read($id)
 	{

phpgwapi/inc/class.egw_sharing.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,6 @@ 
 	/**
 	 * Protected constructor called via self::create_session
 	 *
-	 * @param string $token
 	 * @param array $share
 	 */
 	protected function __construct(array $share)
@@ -109,6 +108,7 @@ 
 
 	/**
 	 * Get token from url
+	 * @return string
 	 */
 	public static function get_token()
 	{