/setup/tables_current.inc.php
+ *
+ * Does NOT set a different internal-data-name. If you want this, you have to do so
+ * in a derifed class !!!
+ */
function setup_table($app,$table)
{
include(PHPGW_SERVER_ROOT . "/$app/setup/tables_current.inc.php");
@@ -120,13 +137,11 @@ class so_sql
}
}
- /*!
- @function so_data_merge
- @syntax so_data_merge( $new )
- @author ralfbecker
- @abstract merges in new values from the given new data-array
- @param $new array in form col => new_value with values to set
- */
+ /**
+ * merges in new values from the given new data-array
+ *
+ * @param $new array in form col => new_value with values to set
+ */
function data_merge($new)
{
if (!is_array($new) || !count($new))
@@ -149,56 +164,49 @@ class so_sql
}
}
- /*!
- @function db2data
- @abstract changes the data from the db-format to your work-format
- @discussion it gets called everytime when data is read from the db
- @discussion This function needs to be reimplemented in the derived class
- @param $data if given works on that array and returns result, else works on internal data-array
- */
- function db2data($data=0)
+ /**
+ * changes the data from the db-format to your work-format
+ *
+ * it gets called everytime when data is read from the db
+ * This function needs to be reimplemented in the derived class
+ *
+ * @param array $data if given works on that array and returns result, else works on internal data-array
+ */
+ function db2data($data=null)
{
- if ($intern = !is_array($data))
+ if (!is_array($data))
{
- $data = $this->data;
+ $data = &$this->data;
}
// do the necessare changes here
- if ($intern)
- {
- $this->data = $data;
- }
return $data;
}
- /*!
- @function data2db
- @abstract changes the data from your work-format to the db-format
- @discussion It gets called everytime when data gets writen into db or on keys for db-searches
- @discussion this needs to be reimplemented in the derived class
- @param $data if given works on that array and returns result, else works on internal data-array
- */
- function data2db($data=0)
+ /**
+ * changes the data from your work-format to the db-format
+ *
+ * It gets called everytime when data gets writen into db or on keys for db-searches
+ * this needs to be reimplemented in the derived class
+ *
+ * @param array $data if given works on that array and returns result, else works on internal data-array
+ */
+ function data2db($data=null)
{
if ($intern = !is_array($data))
{
- $data = $this->data;
+ $data = &$this->data;
}
// do the necessary changes here
- if ($intern)
- {
- $this->data = $data;
- }
return $data;
}
- /*!
- @function init
- @abstract initializes data with the content of key
- @param $keys array with keys in form internalName => value
- @result void
- */
+ /**
+ * initializes data with the content of key
+ *
+ * @param array $keys array with keys in form internalName => value
+ */
function init($keys=array())
{
$this->data = array();
@@ -208,11 +216,11 @@ class so_sql
$this->data_merge($keys);
}
- /*!
- @function read
- @abstract reads row matched by key and puts all cols in the data array
- @param $keys array with keys in form internalName => value, may be a scalar value if only one key
- @result data array if row could be retrived else False and data = array()
+ /**
+ * reads row matched by key and puts all cols in the data array
+ *
+ * @param array $keys array with keys in form internalName => value, may be a scalar value if only one key
+ * @return array/boolean data if row could be retrived else False
*/
function read($keys)
{
@@ -279,15 +287,15 @@ class so_sql
return $this->data;
}
- /*!
- @function save
- @abstracts saves the content of data to the db
- @param $keys if given $keys are copied to data before saveing => allows a save as
- @result 0 on success and errno != 0 else
- */
- function save($keys='')
+ /**
+ * saves the content of data to the db
+ *
+ * @param array $keys if given $keys are copied to data before saveing => allows a save as
+ * @return int 0 on success and errno != 0 else
+ */
+ function save($keys=null)
{
- $this->data_merge($keys);
+ if (is_array($keys) && count($keys)) $this->data_merge($keys);
if (!$this->autoinc_id) // no autoincrement id, so we need to find out with read if key already in db
{
@@ -342,13 +350,13 @@ class so_sql
return $this->db->errno;
}
- /*!
- @function delete
- @abstract deletes row representing keys in internal data or the supplied $keys if != ''
- @param $keys if not '', array with col => value pairs to characterise the rows to delete
- @result affected rows, should be 1 if ok, 0 if an error
+ /**
+ * deletes row representing keys in internal data or the supplied $keys if != null
+ *
+ * @param array $keys if given array with col => value pairs to characterise the rows to delete
+ * @return affected rows, should be 1 if ok, 0 if an error
*/
- function delete($keys='')
+ function delete($keys=null)
{
if (!is_array($keys) || !count($keys)) // use internal data
{
@@ -381,19 +389,20 @@ class so_sql
return $this->db->affected_rows();
}
- /*!
- @function search
- @abstract searches db for rows matching searchcriteria
- @discussion '*' and '?' are replaced with sql-wildcards '%' and '_'
- @param $criteria array of key and data cols, OR a SQL query (content for WHERE), fully quoted (!)
- @param $only_keys True returns only keys, False returns all cols
- @param $order_by fieldnames + {ASC|DESC} separated by colons ','
- @param $extra_cols string to be added to the SELECT, eg. (count(*) as num)
- @param $wildcard string appended befor and after each criteria
- @param $empty False=empty criteria are ignored in query, True=empty have to be empty in row
- @param $op defaults to 'AND', can be set to 'OR' too, then criteria's are OR'ed together
- @result array of matching rows (the row is an array of the cols) or False
- */
+ /**
+ * searches db for rows matching searchcriteria
+ *
+ * '*' 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 $only_keys True returns only keys, False returns all cols
+ * @param string $order_by fieldnames + {ASC|DESC} separated by colons ','
+ * @param string $extra_cols string to be added to the SELECT, eg. (count(*) as num)
+ * @param string $wildcard appended befor and after each criteria
+ * @param boolean $empty False=empty criteria are ignored in query, True=empty have to be empty in row
+ * @param string $op defaults to 'AND', can be set to 'OR' too, then criteria's are OR'ed together
+ * @return array of matching rows (the row is an array of the cols) or False
+ */
function search($criteria,$only_keys=True,$order_by='',$extra_cols='',$wildcard='',$empty=False,$op='AND')
{
if (!is_array($criteria))
@@ -444,15 +453,13 @@ class so_sql
return $n ? $arr : False;
}
- /*!
- @function not_unique
- @syntax not_unique( $data='' )
- @author ralfbecker
- @abstract Check if values for unique keys are unique
- @param $data data-set to check, defaults to $this->data
- @result 0: all keys are unique, 1: first key not unique, 2: ...
- */
- function not_unique($data='')
+ /**
+ * Check if values for unique keys are unique
+ *
+ * @param array $data data-set to check, defaults to $this->data
+ * @return int 0: all keys are unique, 1: first key not unique, 2: ...
+ */
+ function not_unique($data=null)
{
if (!is_array($data))
{
@@ -479,4 +486,4 @@ class so_sql
}
return 0;
}
-};
+}
diff --git a/etemplate/inc/class.uietemplate.inc.php b/etemplate/inc/class.uietemplate.inc.php
index 354f943ddd..915b4197bd 100644
--- a/etemplate/inc/class.uietemplate.inc.php
+++ b/etemplate/inc/class.uietemplate.inc.php
@@ -45,8 +45,8 @@
/**
* constructor of etemplate class, reads an eTemplate if $name is given
*
- * @param $name name of etemplate or array with name and other keys
- * @param $load_via name/array with keys of other etemplate to load in order to get $name
+ * @param string $name of etemplate or array with name and other keys
+ * @param string/array $load_via with keys of other etemplate to load in order to get $name
*/
function etemplate($name='',$load_via='')
{
@@ -84,17 +84,17 @@
* form as submit-url to call process_show for the template before it
* ExecuteMethod's the given $method of the caller.
*
- * @param $method Methode (e.g. 'etemplate.editor.edit') to be called if form is submitted
- * @param $content array with content to fill the input-fields of template, eg. the text-field
- * @param with name 'name' gets its content from $content['name']
+ * @param string $method Methode (e.g. 'etemplate.editor.edit') to be called if form is submitted
+ * @param array $content with content to fill the input-fields of template, eg. the text-field
+ * with name 'name' gets its content from $content['name']
* @param $sel_options array or arrays with the options for each select-field, keys are the
- * @param field-names, eg. array('name' => array(1 => 'one',2 => 'two')) set the
- * @param options for field 'name'. ($content['options-name'] is possible too !!!)
- * @param $readonlys array with field-names as keys for fields with should be readonly
- * @param (eg. to implement ACL grants on field-level or to remove buttons not applicable)
- * @param $preserv array with vars which should be transported to the $method-call (eg. an id) array('id' => $id) sets $_POST['id'] for the $method-call
- * @param $output_mode int 0 = echo incl. navbar, 1 = return html, 2 = echo without navbar (eg. for popups)
- * @param $changes array change made in the last call if looping, only used internaly by process_exec
+ * field-names, eg. array('name' => array(1 => 'one',2 => 'two')) set the
+ * options for field 'name'. ($content['options-name'] is possible too !!!)
+ * @param array $readonlys with field-names as keys for fields with should be readonly
+ * (eg. to implement ACL grants on field-level or to remove buttons not applicable)
+ * @param array $preserv with vars which should be transported to the $method-call (eg. an id) array('id' => $id) sets $_POST['id'] for the $method-call
+ * @param int $output_mode 0 = echo incl. navbar, 1 = return html, 2 = echo without navbar (eg. for popups)
+ * @param array $changes change made in the last call if looping, only used internaly by process_exec
* @return string html for $output_mode == 1, else nothing
*/
function exec($method,$content,$sel_options='',$readonlys='',$preserv='',$output_mode=0,$changes='')
@@ -294,14 +294,14 @@
* as it deals with HTML and is so UI-dependent, use exec instead.
*
* @internal
- * @param $content array with content for the cells, keys are the names given in the cells/form elements
- * @param $sel_options array with options for the selectboxes, keys are the name of the selectbox
- * @param $readonlys array with names of cells/form-elements to be not allowed to change
- * @param This is to facilitate complex ACL's which denies access on field-level !!!
- * @param $cname string basename of names for form-elements, means index in $_POST
- * eg. $cname='cont', element-name = 'name' returned content in $_POST['cont']['name']
- * @param $show_c string name/index for name expansion
- * @param $show_row string name/index for name expansion
+ * @param array $content with content for the cells, keys are the names given in the cells/form elements
+ * @param array $sel_options with options for the selectboxes, keys are the name of the selectbox
+ * @param array $readonlys with names of cells/form-elements to be not allowed to change
+ * 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
* @return string the generated HTML
*/
function show($content,$sel_options='',$readonlys='',$cname='',$show_c=0,$show_row=0/*TEST-RB,$no_table_tr=False,$tr_class=''*/)
@@ -345,15 +345,15 @@
* as it deals with HTML and is so UI-dependent, use exec instead.
*
* @internal
- * @param $grid array representing a grid
- * @param $content array with content for the cells, keys are the names given in the cells/form elements
- * @param $sel_options array with options for the selectboxes, keys are the name of the selectbox
- * @param $readonlys array with names of cells/form-elements to be not allowed to change
- * @param This is to facilitate complex ACL's which denies access on field-level !!!
- * @param $cname string basename of names for form-elements, means index in $_POST
- * eg. $cname='cont', element-name = 'name' returned content in $_POST['cont']['name']
- * @param $show_c string name/index for name expansion
- * @param $show_row string name/index for name expansion
+ * @param array $grid representing a grid
+ * @param array $content with content for the cells, keys are the names given in the cells/form elements
+ * @param array $sel_options with options for the selectboxes, keys are the name of the selectbox
+ * @param array $readonlys with names of cells/form-elements to be not allowed to change
+ * 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
* @return string the generated HTML
*/
function show_grid(&$grid,$content,$sel_options='',$readonlys='',$cname='',$show_c=0,$show_row=0/*TEST-RB,$no_table_tr=False,$tr_class=''*/)
@@ -522,9 +522,18 @@
* calls show to generate included eTemplates. Again only an INTERMAL function.
*
* @internal
- * @param $cell array with data of the cell: name, type, ...
- * @param for rest see show
- * @return the generated HTML
+ * @param array $cell with data of the cell: name, type, ...
+ * @param array $content with content for the cells, keys are the names given in the cells/form elements
+ * @param array $sel_options with options for the selectboxes, keys are the name of the selectbox
+ * @param array $readonlys with names of cells/form-elements to be not allowed to change
+ * 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 string &$span on return number of cells to span or 'all' for the rest (only used for grids)
+ * @param string &$class on return the css class of the cell, to be set in the | tag
+ * @return string the generated HTML
*/
function show_cell($cell,$content,$sel_options,$readonlys,$cname,$show_c,$show_row,&$span,&$class)
{
@@ -1331,7 +1340,8 @@
/**
* returns the javascript to be included by exec
*
- * @param $what &1 = returns the test, note: has to be included in the body, not the header, &2 = returns the common functions, best to be included in the header
+ * @param int $what &1 = returns the test, note: has to be included in the body, not the header,
+ * &2 = returns the common functions, best to be included in the header
* @return string javascript
*/
function include_java_script($what = 3)
diff --git a/etemplate/inc/class.xul_io.inc.php b/etemplate/inc/class.xul_io.inc.php
index 6893084753..4c94c72dc4 100644
--- a/etemplate/inc/class.xul_io.inc.php
+++ b/etemplate/inc/class.xul_io.inc.php
@@ -41,7 +41,10 @@
function xul_io()
{
- $this->attr2xul = array( // how to translate attr, common to all widgets
+ /**
+ * @var array $attr2xul how to translate attr, common to all widgets
+ */
+ $this->attr2xul = array(
'name' => 'id',
'help' => 'statustext',
'span' => 'span,class',
@@ -50,7 +53,10 @@
'readonly' => 'readonly=true',
'size' => 'options'
);
- $this->widget2xul = array( // how to translate widget-names and widget-spec. attr.
+ /**
+ * @var array $widget2xul how to widget-names and widget-spec. attr., not set ones are identical
+ */
+ $this->widget2xul = array(
'label' => array(
'.name' => 'description',
'label' => 'value'
@@ -100,6 +106,9 @@
'size' => 'style,plugins',
),
);
+ /**
+ * @var array $xul2widget how to xul-widget names to our internal ones, not set ones are identical
+ */
$this->xul2widget = array(
'menulist' => 'select',
'listbox' => 'select',
@@ -107,6 +116,13 @@
);
}
+ /**
+ * sets an attribute in the xml object representing a widget
+ *
+ * @param object &$widget widget to set the attribute in
+ * @param string $attr comma delimited attr = default-value pairs, eg. "type=int,min=0"
+ * @param array $val array with values to set
+ */
function set_attributes(&$widget,$attr,$val)
{
if ($attr != '')
@@ -128,6 +144,14 @@
}
}
+ /**
+ * add a widget to a parent
+ *
+ * @param object &$parent parten to add the widget
+ * @param array $cell widget to add
+ * @param array &$embeded_too already embeded eTemplates
+ * @return object reference (!) the the xml object representing the widget, so other children can be added
+ */
function &add_widget(&$parent,$cell,&$embeded_too)
{
$type = $cell['type'];
@@ -276,6 +300,13 @@
$parent->add_node($widget);
}
+ /**
+ * add a grid to $parent (xml object)
+ *
+ * @param object &$parent where to add the grid
+ * @param array $grid grid to add
+ * @param array &embeded_too array with already embeded eTemplates
+ */
function add_grid(&$parent,$grid,&$embeded_too)
{
$xul_grid = new xmlnode('grid');
@@ -317,6 +348,12 @@
$parent->add_node($xul_grid);
}
+ /**
+ * add / embed an eTemplate into the global $xul_overlay object (used by export)
+ *
+ * @param object &$etempl eTemplate to embed
+ * @param array &embeded_too array with already embeded templates
+ */
function add_etempl(&$etempl,&$embeded_too)
{
if (is_array($embeded_too))
@@ -352,6 +389,12 @@
$this->xul_overlay->add_node($template);
}
+ /**
+ * create an XML representation of an eTemplate
+ *
+ * @param object $etempl eTemplate object to export
+ * @return string the XML
+ */
function export($etempl)
{
if ($this->debug)
@@ -377,6 +420,13 @@
return $xml;
}
+ /**
+ * create an eTemplate from it's XML representation
+ *
+ * @param object &$etempl eTemplate object to set
+ * @param string $data the XML
+ * @param array/string array with names of imported templates or error-message
+ */
function import(&$etempl,$data)
{
if ($this->debug)
|