[Phpgroupware-cvs] CVS: etemplate/inc class.soetemplate.inc.php,1.23,1.24

[Ralf Becker <address@hidden>]

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

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

Index: class.soetemplate.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.soetemplate.inc.php,v
retrieving revision 1.23
retrieving revision 1.24
diff -C2 -r1.23 -r1.24
*** class.soetemplate.inc.php   28 Oct 2002 01:17:31 -0000      1.23
--- class.soetemplate.inc.php   22 Feb 2003 12:25:07 -0000      1.24
***************
*** 70,73 ****
--- 70,74 ----
                @function soetemplate
                @abstract constructor of the class
+               @syntax 
soetemplate($name='',$template='',$lang='',$group=0,$version='',$rows=2,$cols=2)
                @param as read
                */
***************
*** 90,93 ****
--- 91,95 ----
                @function num2chrs
                @abstract generates column-names from index: 'A', 'B', ..., 
'AA', 'AB', ..., 'ZZ' (not more!)
+               @syntax num2chrs($num)
                @param $num index to generate name from 1 => 'A'
                @result the name
***************
*** 109,112 ****
--- 111,115 ----
                @function empty_cell
                @abstracts constructor for a new / empty cell (nothing fancy so 
far)
+               @syntax empty_cell()
                @result the cell
                */
***************
*** 119,122 ****
--- 122,126 ----
                @function set_rows_cols()
                @abstract initialises rows & cols from the size of the 
data-array
+               @syntax set_rows_cols()
                */
                function set_rows_cols()
***************
*** 129,132 ****
--- 133,137 ----
                @function init
                @abstract initialises all internal data-structures of the 
eTemplate and sets the keys
+               @syntax 
init($name='',$template='',$lang='',$group=0,$version='',$rows=1,$cols=1)
                @param $name name of the eTemplate or array with the keys or 
all data
                @param $template,$lang,$group,$version see class
***************
*** 171,174 ****
--- 176,180 ----
                @function read
                @abstract Reads an eTemplate from the database
+               @syntax 
read($name,$template='default',$lang='default',$group=0,$version='')
                @param as discripted with the class, with the following 
exeptions
                @param $template as '' loads the prefered template 'default' 
loads the default one '' in the db
***************
*** 246,249 ****
--- 252,256 ----
                @function readfile
                @abstract Reads an eTemplate from the filesystem, the keys are 
already set by init in read
+               @syntax readfile()
                @result True if a template is found, else False
                */
***************
*** 381,384 ****
--- 388,392 ----
                @function db2obj
                @abstract copies all cols into the obj and unserializes the 
data-array
+               @syntax db2obj()
                */
                function db2obj()
***************
*** 447,450 ****
--- 455,459 ----
                @function as_array
                @abstract returns obj-data as array
+               @syntax as_array($data_too=0)
                @param $data_too 0 = no data array, 1 = data array too, 2 = 
serialize data array
                @result the array
***************
*** 474,477 ****
--- 483,487 ----
                @function save
                @abstract saves eTemplate-object to db, can be used as saveAs 
by giving keys as params
+               @syntax 
save($name='',$template='.',$lang='.',$group='',$version='.')
                @params keys see class
                @result the number of affected rows, 1 should be ok, 0 
somethings wrong
***************
*** 560,563 ****
--- 570,574 ----
                @function delete
                @abstract Deletes the eTemplate from the db, object itself is 
unchanged
+               @syntax delete()
                @result the number of affected rows, 1 should be ok, 0 
somethings wrong
                */
***************
*** 576,579 ****
--- 587,591 ----
                @function dump2setup
                @abstract dumps all eTemplates to 
<app>/setup/etemplates.inc.php for distribution
+               @syntax dump2setup($app)
                @param $app app- or template-name
                @result the number of templates dumped as message
***************
*** 638,641 ****
--- 650,654 ----
                @abstract extracts all texts: labels and helptexts from an 
eTemplate-object
                @discussion some extensions use a '|' to squezze multiple texts 
in a label or help field
+               @syntax getToTranslate()
                @result array with messages as key AND value
                */
***************
*** 666,669 ****
--- 679,683 ----
                @function getToTranslateApp
                @abstract Read all eTemplates of an app an extracts the texts 
to an array
+               @syntax getToTranslateApp($app)
                @param $app name of the app
                @result the array with texts
***************
*** 694,697 ****
--- 708,712 ----
                @function writeLangFile
                @abstract Write new lang-file using the existing one and all 
text from the eTemplates
+               @syntax writeLangFile($app,$lang='en',$additional='')
                @param $app app- or template-name
                @param $lang language the messages in the template are, 
defaults to 'en'
***************
*** 769,772 ****
--- 784,788 ----
                @function import_dump
                @abstract Imports the dump-file /$app/setup/etempplates.inc.php 
unconditional (!)
+               @syntax import_dump($app)
                @param $app app name
                @result message with number of templates imported
***************
*** 798,801 ****
--- 814,818 ----
                @discussion Get called on every read of a eTemplate, caches the 
result in phpgw_info.
                @discussion The timestamp of the last import for app gets 
written into the db.
+               @syntax test_import($app)
                @param $app app- or template-name
                */