EGroupware / egroupware

etemplate/inc/class.db_tools.inc.php

Doc Comments +4 added lines, -4 removed lines

@@ -110,8 +110,7 @@ 
 	/**
 	 * table editor (and the callback/submit-method too)
 	 *
-	 * @param array $content=null
-	 * @param string $msg=''
+	 * @param array $content
 	 */
 	function edit(array $content=null,$msg = '')
 	{
@@ -390,7 +389,7 @@ 
 	 * @param string $col column name
 	 * @param array $index ix or uc array of table-defintion
 	 * @param string &$options db specific options
-	 * @return True if $col has a single index
+	 * @return boolean if $col has a single index
 	 */
 	function has_single_index($col,$index,&$options)
 	{
@@ -942,7 +941,7 @@ 
 	 * unsets all keys in an array which have a given value
 	 *
 	 * @param array &$arr
-	 * @param mixed $val value to check against
+	 * @param mixed $value value to check against
 	 */
 	function remove_from_array(&$arr,$value)
 	{
@@ -1138,6 +1137,7 @@ 
 	/**
 	 * creates file header
 	 *
+	 * @param string $app
 	 */
 	function setup_header($app)
 	{

etemplate/inc/class.editor.inc.php

Doc Comments +2 added lines, -3 removed lines

@@ -1039,7 +1039,7 @@ 
 	 *
 	 * @param array &$widget reference into the widget-tree
 	 * @param array &$cell_content cell array in content
-	 * @param boolean $widget2content=true copy from widget to content or other direction
+	 * @param boolean $widget2content copy from widget to content or other direction
 	 */
 	function fix_set_onclick(&$widget,&$cell_content,$widget2content=true)
 	{
@@ -1116,7 +1116,7 @@ 
 	 *
 	 * @param array &$widget reference into the widget-tree
 	 * @param array &$cell_content cell array in content
-	 * @param boolean $widget2content=true copy from widget to content or other direction
+	 * @param boolean $widget2content copy from widget to content or other direction
 	 */
 	function fix_set_onchange(&$widget,&$cell_content,$widget2content=true)
 	{
@@ -1586,7 +1586,6 @@ 
 	 * extensions are class-files in $app/inc/class.${name}_widget.inc.php
 	 * the extensions found will be saved in a class-var and in the session
 	 *
-	 * @param string $app='etemplate' app to scan
 	 * @return string comma delimited list of new found extensions
 	 */
 	function scan_for_extensions($app='etemplate')

etemplate/inc/class.etemplate.inc.php

Doc Comments +7 added lines, -16 removed lines

@@ -357,8 +357,6 @@ 
 	* Check if we have not ignored validation errors
 	*
 	* @param string $ignore_validation='' if not empty regular expression for validation-errors to ignore
-	* @param string $cname=null name-prefix, which need to be ignored, default self::$name_vars
-	* @return boolean true if there are not ignored validation errors, false otherwise
 	*/
 	static function validation_errors($ignore_validation='',$cname=null)
 	{
@@ -382,7 +380,6 @@ 
 	 * Check if given form-name matches ai ignore-validation rule
 	 *
 	 * @param string $ignore_validation='' if not empty regular expression for validation-errors to ignore
-	 * @param string $cname=null name-prefix, which need to be ignored, default self::$name_vars
 	 * @param string $cname
 	 * @return boolean
 	 */
@@ -651,8 +648,8 @@ 
 	* 		This is to facilitate complex ACL's which denies access on field-level !!!
 	* @param string $cname basename of names for form-elements, means index in $_POST
 	* 		eg. $cname='cont', element-name = 'name' returned content in $_POST['cont']['name']
-	* @param string $show_c name/index for name expansion
-	* @param string $show_row name/index for name expansion
+	* @param integer $show_c name/index for name expansion
+	* @param integer $show_row name/index for name expansion
 	* @return string the generated HTML
 	*/
 	function show($content,$sel_options='',$readonlys='',$cname='',$show_c=0,$show_row=0)
@@ -755,8 +752,8 @@ 
 	* 		This is to facilitate complex ACL's which denies access on field-level !!!
 	* @param string $cname basename of names for form-elements, means index in $_POST
 	*		eg. $cname='cont', element-name = 'name' returned content in $_POST['cont']['name']
-	* @param string $show_c name/index for name expansion
-	* @param string $show_row name/index for name expansion
+	* @param integer $show_c name/index for name expansion
+	* @param integer $show_row name/index for name expansion
 	* @param string $path path in the widget tree
 	* @return string the generated HTML
 	*/
@@ -2009,8 +2006,6 @@ 
 	 * (If no id is directly supplied internally.)
 	 *
 	 * @param string $form_name
-	 * @param string $name=null
-	 * @param string $id=null
 	 * @return string ' id="..."' or '' if no id found
 	 */
 	static public function get_id($form_name,$name=null,$id=null)
@@ -2038,8 +2033,8 @@ 
 	 * --> use . as decimal separator for browser supporting html5 input type=number
 	 *
 	 * @param int|float|string $number
-	 * @param int $num_decimal_places=2
-	 * @param boolean $readonly=true
+	 * @param int $num_decimal_places
+	 * @param boolean $readonly
 	 * @return string
 	 */
 	static public function number_format($number,$num_decimal_places=2,$readonly=true)
@@ -2067,8 +2062,6 @@ 
 	*
 	* @param array $cell
 	* @param string $name
-	* @param array $content=array();
-	* @return array
 	*/
 	function _sel_options($cell,$name,$content=array())
 	{
@@ -2236,8 +2229,6 @@ 
 	* @param array $content $_POST[$cname], on return the adjusted content
 	* @param array $to_process list of widgets/form-fields to process
 	* @param string $cname='' basename of our returnt content (same as in call to show)
-	* @param string $_type='regular' type of request
-	* @return array with validation errors
 	*/
 	function process_show(&$content,$to_process,$cname='',$_type='regular')
 	{
@@ -2484,7 +2475,7 @@ 
 	*
 	* @param string $name (complete) name of the widget causing the error
 	* @param string|boolean $error error-message already translated or false to reset all existing error for given name
-	* @param string $cname=null set it to '', if the name is already a form-name, defaults to self::$name_vars
+	* @param string $cname
 	*/
 	static function set_validation_error($name,$error,$cname=null)
 	{

etemplate/inc/class.etemplate_new.inc.php

Doc Comments +6 added lines, -6 removed lines

@@ -493,7 +493,7 @@ 
 	 * Reads an eTemplate from filesystem or DB (not yet supported)
 	 *
 	 * @param string $name name of the eTemplate or array with the values for all keys
-	 * @param string $template_set=null default try template-set from user and if not found "default"
+	 * @param string $template_set default try template-set from user and if not found "default"
 	 * @param string $lang language, '' loads the pref. lang of the user, 'default' loads the default one '' in the db
 	 * @param int $group id of the (primary) group of the user or 0 for none, not used at the moment !!!
 	 * @param string $version version of the eTemplate
@@ -572,7 +572,7 @@ 
 	 *  disables all cells with name == $name
 	 *
 	 * @param sting $name cell-name
-	 * @param boolean $disabled=true disable or enable a cell, default true=disable
+	 * @param boolean $disabled disable or enable a cell, default true=disable
 	 * @return reference to attribute
 	 * @deprecated use disableElement($name, $disabled=true)
 	 */
@@ -590,7 +590,7 @@ 
 	 *
 	 * @param array $old
 	 * @param array $new
-	 * @return array the merged array
+	 * @return string the merged array
 	 */
 	public static function complete_array_merge($old,$new)
 	{
@@ -618,7 +618,7 @@ 
 	/**
 	 * Debug callback just outputting content
 	 *
-	 * @param array $content=null
+	 * @param array $content
 	 */
 	public function debug(array $content=null)
 	{
@@ -650,8 +650,8 @@ 
 	 * Format a number according to user prefs with decimal and thousands separator (later only for readonly)
 	 *
 	 * @param int|float|string $number
-	 * @param int $num_decimal_places=2
-	 * @param boolean $readonly=true
+	 * @param int $num_decimal_places
+	 * @param boolean $readonly
 	 * @return string
 	 */
 	static public function number_format($number,$num_decimal_places=2,$readonly=true)

etemplate/inc/class.etemplate_request.inc.php

Doc Comments +2 added lines, -7 removed lines

@@ -131,7 +131,6 @@ 
 	 * over etemplate_request_session, which stores the data in the session (and causing
 	 * the sesison to constantly grow).
 	 *
-	 * @param string $id=null
 	 * @return etemplate_request
 	 */
 	public static function read($id=null)
@@ -211,7 +210,6 @@ 
 	/**
 	 * Private constructor to force the instancation of this class only via it's static factory method read
 	 *
-	 * @param string $id=null
 	 */
 	private function __construct($id=null)
 	{
@@ -254,7 +252,6 @@ 
 	 *
 	 * @param string $form_name form-name
 	 * @param string $type etemplate type
-	 * @param array $data=array() optional extra data
 	 */
 	public function set_to_process($form_name,$type,$data=array())
 	{
@@ -276,7 +273,7 @@ 
 	 * @param string $form_name form-name
 	 * @param string $attribute etemplate type
 	 * @param array $value
-	 * @param boolean $add_to_array=false should $value be added to the attribute array
+	 * @param boolean $add_to_array should $value be added to the attribute array
 	 */
 	public function set_to_process_attribute($form_name,$attribute,$value,$add_to_array=false)
 	{
@@ -312,7 +309,7 @@ 
 	/**
 	 * return the data of a form-var to process or the whole array
 	 *
-	 * @param string $form_name=null
+	 * @param string $form_name
 	 * @return array
 	 */
 	public function get_to_process($form_name=null)
@@ -417,8 +414,6 @@ 
 	/**
 	 * Check if session encryption is configured, possible and initialise it
 	 *
-	 * @param string $algo='tripledes'
-	 * @param string $mode='ecb'
 	 * @return boolean true if encryption is used, false otherwise
 	 */
 	static public function init_crypt($algo='tripledes',$mode='ecb')

etemplate/inc/class.etemplate_request_session.inc.php

Doc Comments -1 removed lines

@@ -77,7 +77,6 @@
 	/**
 	 * Factory method to get a new request object or the one for an existing request
 	 *
-	 * @param string $id=null
 	 * @return etemplate_request|boolean the object or false if $id is not found
 	 */
 	static function read($id=null)

etemplate/inc/class.etemplate_widget_button.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 * @param array $content
 	 * @param array &$validated=array() validated content
-	 * @return boolean true if no validation error, false otherwise
+	 * @return boolean|null true if no validation error, false otherwise
 	 */
 	public function validate($cname, array $expand, array $content, &$validated=array())
 	{

etemplate/inc/class.etemplate_widget_checkbox.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 * @param array $content
 	 * @param array &$validated=array() validated content
-	 * @return boolean true if no validation error, false otherwise
+	 * @return boolean|null true if no validation error, false otherwise
 	 */
 	public function validate($cname, array $expand, array $content, &$validated=array())
 	{

etemplate/inc/class.etemplate_widget_date.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -101,7 +101,6 @@ 
 	/**
 	 * Put date in the proper format for sending to client
 	 * @param string|int $value
-	 * @param string $format
 	 */
 	public function format_date($value)
 	{
@@ -139,7 +138,7 @@ 
 	 * @param array $expand values for keys 'c', 'row', 'c_', 'row_', 'cont'
 	 * @param array $content
 	 * @param array &$validated=array() validated content
-	 * @return boolean true if no validation error, false otherwise
+	 * @return boolean|null true if no validation error, false otherwise
 	 */
 	public function validate($cname, array $expand, array $content, &$validated=array())
 	{