EGroupware / egroupware

api/src/Mailer.php

Doc Comments +3 added lines, -3 removed lines

@@ -251,7 +251,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)
@@ -270,7 +270,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)
@@ -381,7 +381,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.

api/src/Session.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
 	 */

api/src/Storage.php

Doc Comments +2 added lines, -2 removed lines

@@ -366,7 +366,7 @@ 
 	 * @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 mixed $only_keys =false, see search
+	 * @param boolean $only_keys =false, see search
 	 * @param string|array $extra_cols =array()
 	 * @return int total number of rows
 	 */
@@ -734,7 +734,7 @@ 
 	 * Check if cf is stored as 1:N relation in DB and array in memory
 	 *
 	 * @param string $name
-	 * @return string
+	 * @return boolean
 	 */
 	function is_multiple($name)
 	{

api/src/Storage/Base.php

Doc Comments +2 added lines, -2 removed lines

@@ -704,7 +704,7 @@ 
 	 *
 	 * @param array $_fields
 	 * @param boolean $merge =true if true $fields will be merged with $this->data (after update!), otherwise $this->data will be just $fields
-	 * @return int|boolean 0 on success, or errno != 0 on error, or true if $extra_where is given and no rows affected
+	 * @return integer 0 on success, or errno != 0 on error, or true if $extra_where is given and no rows affected
 	 */
 	function update($_fields,$merge=true)
 	{
@@ -1194,7 +1194,7 @@ 
 	 * @param string &$wildcard ='' on return wildcard char to use, if pattern does not already contain wildcards!
 	 * @param string &$op ='AND' on return boolean operation to use, if pattern does not start with ! we use OR else AND
 	 * @param string $extra_col =null extra column to search
-	 * @param array $search_cols =array() List of columns to search.  If not provided, all columns in $this->db_cols will be considered
+	 * @param string[] $search_cols =array() List of columns to search.  If not provided, all columns in $this->db_cols will be considered
 	 * @return array or column => value pairs
 	 */
 	public function search2criteria($_pattern,&$wildcard='',&$op='AND',$extra_col=null, $search_cols = array())

api/src/Storage/Customfields.php

Doc Comments +1 added lines, -1 removed lines

@@ -159,7 +159,7 @@
 	 * @param string $app
 	 * @param boolean $all_private_too =false should all the private fields be returned too, default no
 	 * @param string $only_type2 =null if given only return fields of type2 == $only_type2
-	 * @return boolen true: if there is a custom field useing html, false if not
+	 * @return boolean true: if there is a custom field useing html, false if not
 	 */
 	public static function use_html($app, $all_private_too=false, $only_type2=null)
 	{

api/src/Storage/History.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 = '')
 	{

api/src/Storage/Merge.php

Doc Comments +14 added lines, -7 removed lines

@@ -368,9 +368,9 @@ 
 	 *
 	 * Calls get_links() repeatedly to get all the combinations for the content.
 	 *
-	 * @param $app String appname
+	 * @param string $app String appname
 	 * @param $id String ID of record
-	 * @param $prefix
+	 * @param string $prefix
 	 * @param $content String document content
 	 */
 	protected function get_all_links($app, $id, $prefix, &$content)
@@ -530,7 +530,7 @@ 
 	 * @param mixed $app_limit app_limit, if not set checks the global limit
 	 * @param string $checkas [AND|ISALLOWED], AND default; if set to ISALLOWED it is checked if Export is allowed
 	 *
-	 * @return bool - true if no export is allowed or a limit is set, false if there is no restriction
+	 * @return boolean|null - true if no export is allowed or a limit is set, false if there is no restriction
 	 */
 	public static function hasExportLimit($app_limit,$checkas='AND')
 	{
@@ -579,6 +579,9 @@ 
 		return $content;
 	}
 
+	/**
+	 * @param string $mimetype
+	 */
 	protected function apply_styles (&$content, $mimetype, $mso_application_progid=null)
 	{
 		if (!isset($mso_application_progid))
@@ -1169,6 +1172,8 @@ 
 
 	/**
 	 * Convert numeric values in spreadsheets into actual numeric values
+	 * @param string $content
+	 * @param string $mimetype
 	 */
 	protected function format_spreadsheet_numbers(&$content, $names, $mimetype)
 	{
@@ -1238,6 +1243,7 @@ 
 
 	/**
 	 * Convert date / timestamp values in spreadsheets into actual date / timestamp values
+	 * @param string $mimetype
 	 */
 	protected function format_spreadsheet_dates(&$content, $names, &$values, $mimetype)
 	{
@@ -1342,6 +1348,7 @@ 
 	/**
 	 * Expand link_to custom fields with the merge replacements from the app
 	 * but only if the template uses them.
+	 * @param string $app
 	 */
 	public function cf_link_to_expand($values, $content, &$replacements, $app = null)
 	{
@@ -1407,7 +1414,7 @@ 
 	/**
 	 * Process special flags, such as IF or NELF
 	 *
-	 * @param content Text to be examined and changed
+	 * @param content string to be examined and changed
 	 * @param replacements array of markers => replacement
 	 *
 	 * @return changed content
@@ -1720,8 +1727,7 @@ 
 	 * Get a list of document actions / files from the given directory
 	 *
 	 * @param string $dirs Directory(s comma or space separated) to search
-	 * @param string $prefix='document_' prefix for array keys
-	 * @param array|string $mime_filter=null allowed mime type(s), default all, negative filter if $mime_filter[0] === '!'
+	 * @param array|string $mime_filter allowed mime type(s), default all, negative filter if $mime_filter[0] === '!'
 	 * @return array List of documents, suitable for a selectbox.  The key is document_<filename>.
 	 */
 	public static function get_documents($dirs, $prefix='document_', $mime_filter=null, $app='')
@@ -1988,7 +1994,8 @@ 
 	 *
 	 * @param string &$document maybe relative path of document, on return true absolute path to existing document
 	 * @param string $dirs comma or whitespace separated directories
-	 * @return string|boolean false if document exists, otherwise string with error-message
+	 * @param string $document
+	 * @return false|string false if document exists, otherwise string with error-message
 	 */
 	public static function check_document(&$document, $dirs)
 	{

api/src/Storage/Tracking.php

Doc Comments +1 added lines, -2 removed lines

@@ -528,7 +528,7 @@ 
 	 * @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 $email_notified=null if present will return the emails notified, if given emails in that list will not be notified
+	 * @param array $email_notified if present will return the emails notified, if given emails in that list will not be notified
 	 * @return boolean true on success, false on error (error messages are in $this->errors)
 	 */
 	public function do_notifications($data,$old,$deleted=null,&$email_notified=null)
@@ -824,7 +824,6 @@ 
 	 * The default implementation prefers depending on the prefer_user_as_sender class-var the user over
 	 * what is returned by get_config('sender').
 	 *
-	 * @param int $user account_lid of user
 	 * @param array $data
 	 * @param array $old
 	 * @param bool $prefer_id returns the userid rather than email

api/src/Translation.php

Doc Comments +1 added lines, -1 removed lines

@@ -742,7 +742,7 @@
 	 *
 	 * @param string $app application name
 	 * @param string $lang language code
-	 * @return the full path of the filename for the requested app and language
+	 * @return string full path of the filename for the requested app and language
 	 */
 	static function get_lang_file($app,$lang)
 	{