EGroupware / egroupware

phpgwapi/inc/class.egw_csrf.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -27,7 +27,7 @@ 
 	/**
 	 * Get a CSRF token for an optional $purpose, which can be validated
 	 *
-	 * @param mixed $_purpose=true if given it need to be used in validate too! (It must NOT be NULL)
+	 * @param mixed $_purpose if given it need to be used in validate too! (It must NOT be NULL)
 	 * @return string CSRF token
 	 */
 	public static function token($_purpose=true)
@@ -51,8 +51,8 @@ 
 	 * Validate a CSRF token or teminate the request
 	 *
 	 * @param string $_token CSRF token generated with egw_csfr::token()
-	 * @param string $_purpose=true optional purpose string passed to token method
-	 * @param boolean $_delete_token=true true if token should be deleted after validation, it will validate no second time
+	 * @param string $_purpose optional purpose string passed to token method
+	 * @param boolean $_delete_token true if token should be deleted after validation, it will validate no second time
 	 */
 	public static function validate($_token, $_purpose=true, $_delete_token=true)
 	{

phpgwapi/inc/class.egw_customfields.inc.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)
 	{

phpgwapi/inc/class.egw_datetime.inc.php

Doc Comments +6 added lines

@@ -691,6 +691,9 @@ 
 			return (int)(($server_time - $this->gmtnow) / 3600);
 		}
 
+		/**
+		 * @param string $date_str
+		 */
 		function convert_rfc_to_epoch($date_str)
 		{
 			$comma_pos = strpos($date_str,',');
@@ -993,6 +996,9 @@ 
 			return $date;
 		}
 
+		/**
+		 * @param integer $localtime
+		 */
 		function gmtdate($localtime)
 		{
 			return $this->localdates($localtime - $this->tz_offset);

phpgwapi/inc/class.egw_db.inc.php

Doc Comments +9 added lines, -16 removed lines

@@ -286,7 +286,7 @@ 
 	}
 
 	/**
-	* @return int current connection id
+	* @return ADOConnection current connection id
 	*/
 	function link_id()
 	{
@@ -692,6 +692,7 @@ 
 	* Convert a unix timestamp to a rdms specific timestamp
 	*
 	* @param int unix timestamp
+	* @param string $epoch
 	* @return string rdms specific timestamp
 	*/
 	function to_timestamp($epoch)
@@ -945,7 +946,7 @@ 
 	/**
 	* Rollback the current transaction
 	*
-	* @return bool True if sucessful, False if fails
+	* @return false|null True if sucessful, False if fails
 	*/
 	function transaction_abort()
 	{
@@ -991,7 +992,7 @@ 
 	* @deprecated not used anymore as it costs to much performance, use transactions if needed
 	* @param string $table name of table to lock
 	* @param string $mode type of lock required (optional), default write
-	* @return bool True if sucessful, False if fails
+	* @return boolean|null True if sucessful, False if fails
 	*/
 	function lock($table, $mode='write')
 	{
@@ -1002,7 +1003,7 @@ 
 	* Unlock a table
 	*
 	* @deprecated not used anymore as it costs to much performance, use transactions if needed
-	* @return bool True if sucessful, False if fails
+	* @return boolean|null True if sucessful, False if fails
 	*/
 	function unlock()
 	{}
@@ -1306,7 +1307,6 @@ 
 	 *
 	 * Example: $db->concat($db->quote('Hallo '),'username') would return
 	 *	for mysql "concat('Hallo ',username)" or "'Hallo ' || username" for postgres
-	 * @param string $str1 already quoted stringliteral or column-name, variable number of arguments
 	 * @return string to be used in a query
 	 */
 	function concat(/*$str1, ...*/)
@@ -1326,7 +1326,7 @@ 
 	 * @param string $expr column-name or expression optional prefixed with "DISTINCT"
 	 * @param string $order_by ='' optional order
 	 * @param string $separator =',' optional separator, default is comma
-	 * @return string|boolean false if not supported by dbms
+	 * @return false|string false if not supported by dbms
 	 */
 	function group_concat($expr, $order_by='', $separator=',')
 	{
@@ -1658,7 +1658,7 @@ 
 	*	array('visits=visits+1') gives just "visits=visits+1" (no quoting at all !!!)
 	* @param boolean|string $use_key If $use_key===True a "$key=" prefix each value (default), typically set to False
 	*	or 'VALUES' for insert querys, on 'VALUES' "(key1,key2,...) VALUES (val1,val2,...)" is returned
-	* @param array|boolean $only if set to an array only colums which are set (as data !!!) are written
+	* @param boolean $only if set to an array only colums which are set (as data !!!) are written
 	*	typicaly used to form a WHERE-clause from the primary keys.
 	*	If set to True, only columns from the colum_definitons are written.
 	* @param array|boolean $column_definitions this can be set to the column-definitions-array
@@ -2133,13 +2133,6 @@ 
 	 * gives "(name='test\'ed' AND lang='en') OR 'owner' IN (0,4,5,6,10)" if name,lang are strings and owner is an integer
 	 *
 	 * @param string|array $table_def table-name or definition array
-	 * @param mixed $args variable number of arguments of the following types:
-	 *	string: get's as is into the result
-	 *	array:	column-name / value pairs: the value gets quoted according to the type of the column and prefixed
-	 *		with column-name=, multiple pairs are AND'ed together, see db::column_data_implode
-	 *	bool: If False or is_null($arg): the next 2 (!) arguments gets ignored
-	 *
-	 * Please note: As the function has a variable number of arguments, you CAN NOT add further parameters !!!
 	 *
 	 * @return string the expression generated from the arguments
 	 */
@@ -2277,7 +2270,7 @@ 
 	 * Strip eg. a prefix from the keys of an array
 	 *
 	 * @param array $arr
-	 * @param string|array $strip
+	 * @param string $strip
 	 * @return array
 	 */
 	static function strip_array_keys($arr,$strip)
@@ -2373,7 +2366,7 @@ 
 	 * @param Traversable $rs
 	 * @param callback $callback
 	 * @param array $params =array() additional parameters, row is always first parameter
-	 * @param $key_callback =null optional callback, if you want different keys
+	 * @param Closure $key_callback =null optional callback, if you want different keys
 	 */
 	public function __construct(Traversable $rs, $callback, $params=array(), $key_callback=null)
 	{

phpgwapi/inc/class.egw_digest_auth.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -234,7 +234,7 @@
 	 * @param string $realm
 	 * @param string $username
 	 * @param string &$password=null password to use or if null, on return stored password
-	 * @return string|boolean false if $password not given and can NOT be read
+	 * @return false|string false if $password not given and can NOT be read
 	 */
 	static private function get_digest_A1($realm,$username,&$password=null)
 	{

phpgwapi/inc/class.egw_exception.inc.php

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
  */
 class Admin extends App
 {
+	/**
+	 * @param string $msg
+	 */
 	function __construct($msg=null,$code=102)
 	{
 		if (is_null($msg)) $msg = 'admin';

phpgwapi/inc/class.egw_favorites.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -187,7 +187,7 @@
 	 * @param string $action "add" or "delete"
 	 * @param boolean|int|String $group ID of the group to create the favorite for, or 'all' for all users
 	 * @param array $filters key => value pairs for the filter
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function set_favorite($app, $_name, $action, $group, $filters = array())
 	{

phpgwapi/inc/class.egw_find_iterator.inc.php

Doc Comments +15 added lines

@@ -18,6 +18,9 @@ 
 define("FILTER_DISPLAY", -1); //The element filtered should not be returned to the caller of find, it should not be displayed
 define("FILTER_ALL", -2); //The element didn't pass the filter
 
+/**
+ * @param boolean $isurl
+ */
 function translate_path($path, $isurl) {
 	return $isurl ? $path : egw_vfs::PREFIX.parse_url($path, PHP_URL_PATH);
 }
@@ -39,6 +42,11 @@ 
 	public $isdot = false;
 	public $filterstate = FILTER_ALL;
 
+	/**
+	 * @param string $path
+	 * @param boolean $isurl
+	 * @param boolean $need_mime
+	 */
 	public function __construct($path, $isurl, $need_mime)
 	{
 		//Copy the given parameters
@@ -372,6 +380,13 @@ 
 		}
 	}
 
+	/**
+	 * @param RecursiveDirectoryIterator $iterator
+	 * @param boolean $follow
+	 * @param boolean $url
+	 * @param boolean $needmime
+	 * @param boolean $sort
+	 */
 	public function __construct($iterator, &$filter, $follow, $url, $needmime, 
 		$sort, $sortfunc)
 	{

phpgwapi/inc/class.egw_framework.inc.php

Doc Comments +5 added lines, -17 removed lines

@@ -987,7 +987,7 @@ 
 	/**
 	 * Returns html with user and time
 	 *
-	 * @return void
+	 * @return string
 	 */
 	protected static function _user_time_info()
 	{
@@ -1115,7 +1115,7 @@ 
 	 *
 	 * @param string $username =null username for regular basic auth
 	 * @param string $password =null password --------- " ----------
-	 * @return resource|null context to use with file_get_context/fopen or null if no proxy configured
+	 * @return resource context to use with file_get_context/fopen or null if no proxy configured
 	 */
 	public static function proxy_context($username=null, $password=null)
 	{
@@ -1460,7 +1460,7 @@ 
 	 * Parse beginning of given CSS file for /*@import url("...") statements
 	 *
 	 * @param string $path EGroupware relative path eg. /phpgwapi/templates/default/some.css
-	 * @return array parsed pathes (EGroupware relative) including $path itself
+	 * @return string[] parsed pathes (EGroupware relative) including $path itself
 	 */
 	protected static function resolve_css_includes($path, &$pathes=array())
 	{
@@ -1577,7 +1577,6 @@ 
 	 *
 	 * Themes are css file in the template directory
 	 *
-	 * @param string $themes_dir ='css'
 	 */
 	function list_themes()
 	{
@@ -1761,11 +1760,6 @@ 
 	/**
 	* Add menu items to the topmenu template class to be displayed
 	*
-	* @param array $app application data
-	* @param mixed $alt_label string with alternative menu item label default value = null
-	* @param string $urlextra string with alternate additional code inside <a>-tag
-	* @access protected
-	* @return void
 	*/
 	abstract function _add_topmenu_item(array $app_data,$alt_label=null);
 
@@ -1974,12 +1968,6 @@ 
 	* @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
-	* @param boolean $append =true should the file be added
-	*
-	* @discuss The browser specific option loads the file which is in the correct
-	*          browser folder. Supported folder are those supported by class.browser.inc.php
-	*
-	* @returns bool was the file found?
 	*/
 	static function validate_file($package, $file=null, $app='phpgwapi')
 	{
@@ -2090,7 +2078,7 @@ 
 	 * Generate bundle url(s) for given js files
 	 *
 	 * @param array $js_includes
-	 * @param int& $max_modified =null on return maximum modification time of bundle
+	 * @param integer $max_modified =null on return maximum modification time of bundle
 	 * @return array js-files (can be more then one, if one of given files can not be bundeled)
 	 */
 	protected static function bundle_urls(array $js_includes, &$max_modified=null)
@@ -2382,7 +2370,7 @@ 
 	 * @param string $action "add" or "delete"
 	 * @param boolean|int|string $group ID of the group to create the favorite for, or 'all' for all users
 	 * @param array $filters =array() key => value pairs for the filter
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function ajax_set_favorite($app, $name, $action, $group, $filters = array())
 	{