[Phpgroupware-cvs] CVS: etemplate/inc class.boetemplate.inc.php,1.32,1.33

[Ralf Becker <address@hidden>]

Update of /cvsroot/phpgroupware/etemplate/inc
In directory subversions:/tmp/cvs-serv11720

Modified Files:
        class.boetemplate.inc.php 
Log Message:
some docu updates

Index: class.boetemplate.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.boetemplate.inc.php,v
retrieving revision 1.32
retrieving revision 1.33
diff -C2 -r1.32 -r1.33
*** class.boetemplate.inc.php   17 Oct 2002 22:08:24 -0000      1.32
--- class.boetemplate.inc.php   22 Feb 2003 12:25:46 -0000      1.33
***************
*** 141,144 ****
--- 141,145 ----
                @discussion In general everything expand_names can generate is 
ok - see there.
                @discussion As you usually have col- and row-headers, 
data-cells start with '1' or 'A' !!!
+               @syntax 
autorepeat_idx($cell,$c,$r,&$idx,&$idx_cname,$check_col=False)
                @param $cell array with data of cell: name, type, size, ...
                @param $c,$r col/row index starting from 0
***************
*** 187,190 ****
--- 188,197 ----
                }
  
+               /*!
+               @function appsession_id
+               @syntax appsession_id( )
+               @author ralfbecker
+               @abstract creates a new appsession-id via microtime()
+               */
                function appsession_id()
                {
***************
*** 348,351 ****
--- 355,359 ----
                @function haveExtension
                @syntax haveExtension($type)
+               @author ralfbecker
                @abstract checks if extension is loaded and load it if it isnt
                */
***************
*** 365,368 ****
--- 373,377 ----
                @param &$readonlys value of the extensions 
readonly-setting(-array)
                @abstract executes the pre_process-function of the extension 
$cell[]type]
+               @author ralfbecker
                */
                {
***************
*** 383,386 ****
--- 392,396 ----
                @param &$value value of the extensions content(-array)
                @abstract executes the post_process-function of the extension 
$cell[type]
+               @author ralfbecker
                */
                {
***************
*** 399,402 ****
--- 409,413 ----
                @syntax extensionRender(&$cell,$form_name,&$value,$readonly)
                @abstract executes the render-function of the extension 
$cell[type]
+               @author ralfbecker
                */
                {
***************
*** 414,417 ****
--- 425,429 ----
                @author ralfbecker
                @abstract checks if idx, which may contain ONE subindex is set 
in array
+               @author ralfbecker
                */
                function isset_array($arr,$idx)
***************
*** 424,427 ****
--- 436,447 ----
                }
  
+               /*!
+               @function set_array
+               @syntax set_array( &$arr,$idx,$val )
+               @author ralfbecker
+               @abstract sets $arr[$idx] = $val
+               @discussion This works for non-trival indexes like 'a[b][c]' 
too: $arr['a']['b']['c'] = $val;
+               @author ralfbecker
+               */
                function set_array(&$arr,$idx,$val)
                {
***************
*** 439,442 ****
--- 459,471 ----
                }
  
+               /*!
+               @function get_array
+               @syntax get_array( &$arr,$idx )
+               @author ralfbecker
+               @abstract return a var-param to $arr[$idx]
+               @example $sub = get_array($arr,'a[b]'); $sub = 'c'; is 
equivalent to $arr['a']['b'] = 'c';
+               @discussion This works for non-trival indexes like 'a[b][c]' 
too: it returns &$arr[a][b][c]
+               @author ralfbecker
+               */
                function &get_array(&$arr,$idx)
                {
***************
*** 458,461 ****
--- 487,499 ----
                }
  
+               /*!
+               @function unset_array
+               @syntax unset_array( &$arr,$idx )
+               @author ralfbecker
+               @abstract unsets $arr[$idx]
+               @example unset_array($arr,'a[b]'); is equivalent to 
unset($arr['a']['b']);
+               @discussion This works for non-trival indexes like 'a[b][c]' too
+               @author ralfbecker
+               */
                function unset_array(&$arr,$idx)
                {