[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Phpgroupware-cvs] CVS: etemplate/inc class.boetemplate.inc.php,1.11,1.1
|
From: |
Ralf Becker <address@hidden> |
|
Subject: |
[Phpgroupware-cvs] CVS: etemplate/inc class.boetemplate.inc.php,1.11,1.12 class.date_widget.inc.php,1.2,1.3 class.datefield_widget.inc.php,1.3,1.4 class.db_tools.inc.php,1.10,1.11 class.editor.inc.php,1.6,1.7 class.html.inc.php,1.3,1.4 class.so_sql.inc.php,1.2,1.3 class.soetemplate.inc.php,1.6,1.7 class.tab_widget.inc.php,1.4,1.5 class.uietemplate.inc.php,1.13,1.14 class.uietemplate_gtk.inc.php,1.9,1.10 |
|
Date: |
Mon, 02 Sep 2002 07:11:11 -0400 |
Update of /cvsroot/phpgroupware/etemplate/inc
In directory subversions:/tmp/cvs-serv23347
Modified Files:
class.boetemplate.inc.php class.date_widget.inc.php
class.datefield_widget.inc.php class.db_tools.inc.php
class.editor.inc.php class.html.inc.php class.so_sql.inc.php
class.soetemplate.inc.php class.tab_widget.inc.php
class.uietemplate.inc.php class.uietemplate_gtk.inc.php
Log Message:
some corrections for the inline-doc-parser
Index: class.boetemplate.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.boetemplate.inc.php,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -r1.11 -r1.12
*** class.boetemplate.inc.php 15 Jun 2002 19:58:35 -0000 1.11
--- class.boetemplate.inc.php 2 Sep 2002 11:11:08 -0000 1.12
***************
*** 17,20 ****
--- 17,21 ----
/*!
@class boetemplate
+ @author ralfbecker
@abstract Buiseness Objects for eTemplates
@discussion Not so much so far, as the most logic is still in the
UI-class
***************
*** 66,70 ****
/*!
! @function expand_name($name,$c,$row,$c_='',$row_='',$cont='')
@abstract allows a few variables (eg. row-number) to be used in
field-names
@discussion This is mainly used for autorepeat, but other use
is possible.
--- 67,73 ----
/*!
! @function expand_name
! @syntax expand_name( $name,$c,$row,$c_='',$row_='',$cont='' )
! @author ralfbecker
@abstract allows a few variables (eg. row-number) to be used in
field-names
@discussion This is mainly used for autorepeat, but other use
is possible.
***************
*** 124,128 ****
@param (no ',') is given in size (name (not
template-fields) are always only one value)
@param $check_col boolean to check for col- or row-autorepeat
! @returns true if cell is autorepeat (has index with vars / '$')
or false otherwise
*/
function
autorepeat_idx($cell,$c,$r,&$idx,&$idx_cname,$check_col=False)
--- 127,131 ----
@param (no ',') is given in size (name (not
template-fields) are always only one value)
@param $check_col boolean to check for col- or row-autorepeat
! @result true if cell is autorepeat (has index with vars / '$')
or false otherwise
*/
function
autorepeat_idx($cell,$c,$r,&$idx,&$idx_cname,$check_col=False)
***************
*** 172,176 ****
/*!
! @function save_appsession($data,$id='')
@abstract saves content,readonlys,template-keys, ... via the
appsession function
@discussion As a user may open several windows with the same
content/template wie generate a location-id from microtime
--- 175,181 ----
/*!
! @function save_appsession
! @syntax save_appsession( $data,$id='' )
! @author ralfbecker
@abstract saves content,readonlys,template-keys, ... via the
appsession function
@discussion As a user may open several windows with the same
content/template wie generate a location-id from microtime
***************
*** 180,184 ****
@param $data the data to save
@param $id the id to use or '' to generate a new id
! @returns the location-id
*/
function save_appsession($data,$id='')
--- 185,189 ----
@param $data the data to save
@param $id the id to use or '' to generate a new id
! @result the location-id
*/
function save_appsession($data,$id='')
***************
*** 194,201 ****
/*!
! @function get_appsession($id)
@abstract gets content,readonlys,template-keys, ... back from
the appsession function
@param $id the location-id
! @returns the session-data
*/
function get_appsession($id)
--- 199,208 ----
/*!
! @function get_appsession
! @syntax get_appsession( $id )
! @author ralfbecker
@abstract gets content,readonlys,template-keys, ... back from
the appsession function
@param $id the location-id
! @result the session-data
*/
function get_appsession($id)
***************
*** 209,215 ****
/*!
! @function get_cell_attribute($name,$attr)
@abstract gets an attribute in a named cell
! @returns the attribute or False if named cell not found
*/
function get_cell_attribute($name,$attr)
--- 216,224 ----
/*!
! @function get_cell_attribute
! @syntax get_cell_attribute( $name,$attr )
! @author ralfbecker
@abstract gets an attribute in a named cell
! @result the attribute or False if named cell not found
*/
function get_cell_attribute($name,$attr)
***************
*** 233,239 ****
/*!
! @function set_cell_attribute($name,$attr,$val)
@abstract set an attribute in a named cell
! @returns the number of changed cells
*/
function set_cell_attribute($name,$attr,$val)
--- 242,250 ----
/*!
! @function set_cell_attribute
! @syntax set_cell_attribute( $name,$attr,$val )
! @author ralfbecker
@abstract set an attribute in a named cell
! @result the number of changed cells
*/
function set_cell_attribute($name,$attr,$val)
***************
*** 258,264 ****
/*!
! @function set_cell_attribute($name,$attr,$val)
@abstract set an attribute in a named cell
! @returns the number of changed cells
*/
function set_cell_attribute($name,$attr,$val)
--- 269,277 ----
/*!
! @function set_cell_attribute
! @syntax set_cell_attribute( $name,$attr,$val )
! @author ralfbecker
@abstract set an attribute in a named cell
! @result the number of changed cells
*/
function set_cell_attribute($name,$attr,$val)
***************
*** 283,287 ****
/*!
! @function disable_cells($name)
@abstract disables all cells with name == $name
*/
--- 296,302 ----
/*!
! @function disable_cells
! @syntax disable_cells( $name )
! @author ralfbecker
@abstract disables all cells with name == $name
*/
***************
*** 292,299 ****
/*!
! @function loadExtension($name,$ui='')
@abstact trys to load the Extension / Widget-class from the app
or etemplate
@param $name name of the extension the classname should be
class.${name}_widget.inc.php
! @note the $name might be "$name.$app" to give a app-name
(default is the current app)
*/
function loadExtension($name,&$parent,$ui='html')
--- 307,316 ----
/*!
! @function loadExtension
! @syntax loadExtension( $name,$ui='' )
! @author ralfbecker
@abstact trys to load the Extension / Widget-class from the app
or etemplate
@param $name name of the extension the classname should be
class.${name}_widget.inc.php
! @discussion the $name might be "$name.$app" to give a app-name
(default is the current app)
*/
function loadExtension($name,&$parent,$ui='html')
***************
*** 328,332 ****
/*!
! @function isset_array($arr,$idx)
@abstract checks if idx, which may contain ONE subindex is set
in array
*/
--- 345,351 ----
/*!
! @function isset_array
! @syntax isset_array( $arr,$idx )
! @author ralfbecker
@abstract checks if idx, which may contain ONE subindex is set
in array
*/
***************
*** 378,385 ****
/*!
! @function complete_array_merge($old,$new)
@abstract merges $old and $new, content of $new has precedence
over $old
! @note THIS IS NOT THE SAME AS PHP4: array_merge (as it calls
itself recursive for values which are arrays,
! @note if there key does NOT start with a '_' (array_merge just
overwrites the old (sub)array)
*/
function complete_array_merge($old,$new)
--- 397,406 ----
/*!
! @function complete_array_merge
! @syntax complete_array_merge( $old,$new )
! @author ralfbecker
@abstract merges $old and $new, content of $new has precedence
over $old
! @discussion THIS IS NOT THE SAME AS PHP4: array_merge (as it
calls itself recursive for values which are arrays,
! @discussion if there key does NOT start with a '_' (array_merge
just overwrites the old (sub)array)
*/
function complete_array_merge($old,$new)
Index: class.date_widget.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.date_widget.inc.php,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** class.date_widget.inc.php 9 Jun 2002 21:36:06 -0000 1.2
--- class.date_widget.inc.php 2 Sep 2002 11:11:08 -0000 1.3
***************
*** 15,20 ****
/*!
@class date_widget
@abstract widget that reads dates in via 3 select-boxes
! @note This widget is generates html vi the sbox-class, so it does not
work (without an extra implementation) in an other UI
*/
class date_widget
--- 15,21 ----
/*!
@class date_widget
+ @author ralfbecker
@abstract widget that reads dates in via 3 select-boxes
! @discussion This widget is generates html vi the sbox-class, so it does
not work (without an extra implementation) in an other UI
*/
class date_widget
Index: class.datefield_widget.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.datefield_widget.inc.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** class.datefield_widget.inc.php 15 Jun 2002 13:04:19 -0000 1.3
--- class.datefield_widget.inc.php 2 Sep 2002 11:11:08 -0000 1.4
***************
*** 15,20 ****
/*!
@class datefield_widget
@abstract widget that reads date in via 3 input-fields
! @note This widget is independent of the UI as it only uses
etemplate-widgets and has therefor no render-function
*/
class datefield_widget
--- 15,21 ----
/*!
@class datefield_widget
+ @author ralfbecker
@abstract widget that reads date in via 3 input-fields
! @discussion This widget is independent of the UI as it only uses
etemplate-widgets and has therefor no render-function
*/
class datefield_widget
Index: class.db_tools.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.db_tools.inc.php,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -r1.10 -r1.11
*** class.db_tools.inc.php 1 Sep 2002 21:12:21 -0000 1.10
--- class.db_tools.inc.php 2 Sep 2002 11:11:08 -0000 1.11
***************
*** 66,70 ****
/*!
! @function db_tools()
@abstract constructor of class
*/
--- 66,72 ----
/*!
! @function db_tools
! @syntax db_tools( )
! @author ralfbecker
@abstract constructor of class
*/
***************
*** 93,97 ****
/*!
! @function edit($content='',$msg='')
@abstract this is the table editor (and the
callback/submit-method too)
*/
--- 95,101 ----
/*!
! @function edit
! @syntax edit( $content='',$msg='' )
! @author ralfbecker
@abstract this is the table editor (and the
callback/submit-method too)
*/
***************
*** 242,246 ****
/*!
! @function
needs_save($cont='',$posted_app='',$posted_table='',$edited_table='')
@abstract checks if table was changed and if so offers user to
save changes
@param $cont the content of the form (if called by process_exec)
--- 246,252 ----
/*!
! @function needs_save
! @syntax needs_save(
$cont='',$posted_app='',$posted_table='',$edited_table='' )
! @author ralfbecker
@abstract checks if table was changed and if so offers user to
save changes
@param $cont the content of the form (if called by process_exec)
***************
*** 248,252 ****
@param $posted_table the table-name
@param $edited_table the edited table-definitions
! @returns only if no changes
*/
function
needs_save($cont='',$posted_app='',$posted_table='',$edited_table='')
--- 254,258 ----
@param $posted_table the table-name
@param $edited_table the edited table-definitions
! @result only if no changes
*/
function
needs_save($cont='',$posted_app='',$posted_table='',$edited_table='')
***************
*** 321,328 ****
/*!
! @function table2content($table)
@abstract creates content-array from a $table
@param $table table-definition, eg. $phpgw_baseline[$table_name]
! @returns content-array
*/
function table2content($table)
--- 327,336 ----
/*!
! @function table2content
! @syntax table2content( $table )
! @author ralfbecker
@abstract creates content-array from a $table
@param $table table-definition, eg. $phpgw_baseline[$table_name]
! @result content-array
*/
function table2content($table)
***************
*** 352,359 ****
/*!
! @function content2table($content)
@abstract creates table-definition from posted content
@param $content posted content-array
! @returns table-definition
*/
function content2table($content)
--- 360,369 ----
/*!
! @function content2table
! @syntax content2table( $content )
! @author ralfbecker
@abstract creates table-definition from posted content
@param $content posted content-array
! @result table-definition
*/
function content2table($content)
***************
*** 427,435 ****
/*!
! @function read($app,&$phpgw_baseline)
@abstract includes $app/setup/tables_current.inc.php
@param $app application name
@param $phpgw_baseline where to put the data
! @returns True if file found, False else
*/
function read($app,&$phpgw_baseline)
--- 437,447 ----
/*!
! @function read
! @syntax read( $app,&$phpgw_baseline )
! @author ralfbecker
@abstract includes $app/setup/tables_current.inc.php
@param $app application name
@param $phpgw_baseline where to put the data
! @result True if file found, False else
*/
function read($app,&$phpgw_baseline)
***************
*** 509,513 ****
/*!
! @function write($app,$phpgw_baseline)
@abstract writes tabledefinitions $phpgw_baseline to file
/$app/setup/tables_current.inc.php
@param $app app-name
--- 521,527 ----
/*!
! @function write
! @syntax write( $app,$phpgw_baseline )
! @author ralfbecker
@abstract writes tabledefinitions $phpgw_baseline to file
/$app/setup/tables_current.inc.php
@param $app app-name
***************
*** 553,557 ****
/*!
! @function setup_version($app,$new = '',$tables='')
@abstract reads and updates the version in file
$app/setup/setup.inc.php if $new != ''
@return the version or False if the file could not be read or
written
--- 567,573 ----
/*!
! @function setup_version
! @syntax setup_version( $app,$new = '',$tables='' )
! @author ralfbecker
@abstract reads and updates the version in file
$app/setup/setup.inc.php if $new != ''
@return the version or False if the file could not be read or
written
***************
*** 600,604 ****
/*!
! @function update($app,$current,$version)
@abstract updates file /$app/setup/tables_update.inc.php to
reflect changes in $current
@param $app app-name
--- 616,622 ----
/*!
! @function update
! @syntax update( $app,$current,$version )
! @author ralfbecker
@abstract updates file /$app/setup/tables_update.inc.php to
reflect changes in $current
@param $app app-name
***************
*** 760,766 ****
/*!
! @function normalize($table)
@abstract sets all nullable properties to True or False
! @returns the new array
*/
function normalize($table)
--- 778,786 ----
/*!
! @function normalize
! @syntax normalize( $table )
! @author ralfbecker
@abstract sets all nullable properties to True or False
! @result the new array
*/
function normalize($table)
***************
*** 789,795 ****
/*!
! @function tables_identical($old,$new)
@abstract compares two table-definitions
! @returns True if they are identical or False else
*/
function tables_identical($a,$b)
--- 809,817 ----
/*!
! @function tables_identical
! @syntax tables_identical( $old,$new )
! @author ralfbecker
@abstract compares two table-definitions
! @result True if they are identical or False else
*/
function tables_identical($a,$b)
Index: class.editor.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.editor.inc.php,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -r1.6 -r1.7
*** class.editor.inc.php 9 Jun 2002 21:33:07 -0000 1.6
--- class.editor.inc.php 2 Sep 2002 11:11:08 -0000 1.7
***************
*** 435,442 ****
/*!
! @function scan_for_extensions()
@abstract search the inc-dirs of etemplate and the app whichs
template is edited for extensions / custom widgets
! @note extensions are class-files in
$app/inc/class.${name}_widget.inc.php
! @returns array with name => human_name of the extensions found
*/
function scan_for_extensions($app='etemplate')
--- 435,444 ----
/*!
! @function scan_for_extensions
! @syntax scan_for_extensions( )
! @author ralfbecker
@abstract search the inc-dirs of etemplate and the app whichs
template is edited for extensions / custom widgets
! @discussion extensions are class-files in
$app/inc/class.${name}_widget.inc.php
! @result array with name => human_name of the extensions found
*/
function scan_for_extensions($app='etemplate')
Index: class.html.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.html.inc.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** class.html.inc.php 15 Jun 2002 19:58:35 -0000 1.3
--- class.html.inc.php 2 Sep 2002 11:11:08 -0000 1.4
***************
*** 68,72 ****
@example
link('/index.php?menuaction=infolog.uiinfolog.get_list',array('info_id' => 123))
@example =
'http://domain/phpgw-path/index.php?menuaction=infolog.uiinfolog.get_list&info_id=123'
! @returns absolut link already run through $phpgw->link
*/
function link($url,$vars='')
--- 68,72 ----
@example
link('/index.php?menuaction=infolog.uiinfolog.get_list',array('info_id' => 123))
@example =
'http://domain/phpgw-path/index.php?menuaction=infolog.uiinfolog.get_list&info_id=123'
! @result absolut link already run through $phpgw->link
*/
function link($url,$vars='')
***************
*** 125,129 ****
@example '.1' => 'BGCOLOR="#0000FF"' );
@example table($rows,'WIDTH="100%"') = '<table WIDTH="100%"><tr><td
colspan=3>cell1</td><td>cell2</td><td width="10%">cell3</td></tr></table>'
! @returns string with html-code of the table
*/
function table($rows,$options = '')
--- 125,129 ----
@example '.1' => 'BGCOLOR="#0000FF"' );
@example table($rows,'WIDTH="100%"') = '<table WIDTH="100%"><tr><td
colspan=3>cell1</td><td>cell2</td><td width="10%">cell3</td></tr></table>'
! @result string with html-code of the table
*/
function table($rows,$options = '')
***************
*** 201,205 ****
@param $names String (or Array) with the option-names eg.
'WIDTH,HEIGHT,BORDER'
@example formatOptions('100%,,1','WIDTH,HEIGHT,BORDER') = '
WIDTH="100%" BORDER="1"'
! @returns option string
*/
function formatOptions($options,$names)
--- 201,205 ----
@param $names String (or Array) with the option-names eg.
'WIDTH,HEIGHT,BORDER'
@example formatOptions('100%,,1','WIDTH,HEIGHT,BORDER') = '
WIDTH="100%" BORDER="1"'
! @result option string
*/
function formatOptions($options,$names)
***************
*** 218,222 ****
@function nextMatchStyles
@abstract returns simple stylesheet for nextmatch row-colors
! @returns the classes 'nmh' = nextmatch header, 'nmr0'+'nmr1' =
alternating rows
*/
function nextMatchStyles()
--- 218,222 ----
@function nextMatchStyles
@abstract returns simple stylesheet for nextmatch row-colors
! @result the classes 'nmh' = nextmatch header, 'nmr0'+'nmr1' =
alternating rows
*/
function nextMatchStyles()
Index: class.so_sql.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.so_sql.inc.php,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** class.so_sql.inc.php 18 Feb 2002 13:51:04 -0000 1.2
--- class.so_sql.inc.php 2 Sep 2002 11:11:09 -0000 1.3
***************
*** 15,18 ****
--- 15,19 ----
/*!
@class so_sql
+ @author ralfbecker
@abstract generalized SQL Storage Object
@discussion the class can be used in following ways:
***************
*** 51,55 ****
/*!
! @function so_sql($app='',$table='')
@abstract constructor of the class
@discussion NEED to be called from the constructor of the derived class
--- 52,58 ----
/*!
! @function so_sql
! @syntax so_sql( $app='',$table='' )
! @author ralfbecker
@abstract constructor of the class
@discussion NEED to be called from the constructor of the derived class
***************
*** 74,78 ****
/*!
! @function setup_table($app,$table)
@abstract reads table-definition from <app>/setup/tables_current.inc.php
@discussion Does NOT set a different internal-data-name. If you want
this, you have to do so
--- 77,83 ----
/*!
! @function setup_table
! @syntax setup_table( $app,$table )
! @author ralfbecker
@abstract reads table-definition from <app>/setup/tables_current.inc.php
@discussion Does NOT set a different internal-data-name. If you want
this, you have to do so
***************
*** 111,115 ****
/*!
! @function so_data_merge($new)
@abstract merges in new values from the given new data-array
@param $new array in form col => new_value with values to set
--- 116,122 ----
/*!
! @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
***************
*** 183,187 ****
@abstract initializes data with the content of key
@param $keys array with keys in form internalName => value
! @returns void
*/
function so_sql_init($keys=array())
--- 190,194 ----
@abstract initializes data with the content of key
@param $keys array with keys in form internalName => value
! @result void
*/
function so_sql_init($keys=array())
***************
*** 208,212 ****
@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
! @returns data array if row could be retrived else False and data =
array()
*/
function so_sql_read($keys)
--- 215,219 ----
@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()
*/
function so_sql_read($keys)
***************
*** 275,279 ****
@abstracts saves the content of data to the db
@param $keys if given $keys are copied to data before saveing => allows
a save as
! @returns 0 on success and errno != 0 else
*/
function so_sql_save($keys='')
--- 282,286 ----
@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 so_sql_save($keys='')
***************
*** 339,343 ****
@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
! @returns affected rows, should be 1 if ok, 0 if an error
*/
function so_sql_delete($keys='')
--- 346,350 ----
@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
*/
function so_sql_delete($keys='')
***************
*** 387,391 ****
@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
! @returns array of matching rows (the row is an array of the cols) or
False
*/
function
so_sql_search($criteria,$only_keys=True,$order_by='',$extra_cols='',$wildcard='',$empty=False)
--- 394,398 ----
@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
! @result array of matching rows (the row is an array of the cols) or
False
*/
function
so_sql_search($criteria,$only_keys=True,$order_by='',$extra_cols='',$wildcard='',$empty=False)
***************
*** 434,441 ****
/*!
! @function so_sql_not_unique($data='')
@abstract Check if values for unique keys are unique
@param $data data-set to check, defaults to $this->data
! @returns 0: all keys are unique, 1: first key not unique, 2: ...
*/
function so_sql_not_unique($data='')
--- 441,450 ----
/*!
! @function so_sql_not_unique
! @syntax so_sql_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 so_sql_not_unique($data='')
***************
*** 466,470 ****
/*!
! @function not_unique($data='')
@abstract just an convinient alias for so_sql_search, might be
reimplemented in derived class
@parms as for so_sql_not_unique
--- 475,481 ----
/*!
! @function not_unique
! @syntax not_unique( $data='' )
! @author ralfbecker
@abstract just an convinient alias for so_sql_search, might be
reimplemented in derived class
@parms as for so_sql_not_unique
Index: class.soetemplate.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.soetemplate.inc.php,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -r1.6 -r1.7
*** class.soetemplate.inc.php 10 Jun 2002 21:30:09 -0000 1.6
--- class.soetemplate.inc.php 2 Sep 2002 11:11:09 -0000 1.7
***************
*** 15,18 ****
--- 15,19 ----
/*!
@class soetemplate
+ @author ralfbecker
@abstract Storage Objects: Everything to store and retrive the
eTemplates.
@discussion eTemplates are stored in the db in table 'phpgw_etemplate'
and gets distributed
***************
*** 80,84 ****
@abstract generates column-names from index: 'A', 'B', ...,
'AA', 'AB', ..., 'ZZ' (not more!)
@param $num index to generate name from 1 => 'A'
! @returns the name
*/
function num2chrs($num)
--- 81,85 ----
@abstract generates column-names from index: 'A', 'B', ...,
'AA', 'AB', ..., 'ZZ' (not more!)
@param $num index to generate name from 1 => 'A'
! @result the name
*/
function num2chrs($num)
***************
*** 98,102 ****
@function empty_cell
@abstracts constructor for a new / empty cell (nothing fancy so
far)
! @returns the cell
*/
function empty_cell()
--- 99,103 ----
@function empty_cell
@abstracts constructor for a new / empty cell (nothing fancy so
far)
! @result the cell
*/
function empty_cell()
***************
*** 151,155 ****
@param $lang as '' loads the pref. lang 'default' loads the
default one '' in the db
@param $group is NOT used / implemented yet
! @returns True if a fitting template is found, else False
*/
function
read($name,$template='default',$lang='default',$group=0,$version='')
--- 152,156 ----
@param $lang as '' loads the pref. lang 'default' loads the
default one '' in the db
@param $group is NOT used / implemented yet
! @result True if a fitting template is found, else False
*/
function
read($name,$template='default',$lang='default',$group=0,$version='')
***************
*** 243,252 ****
/*!
! @function compress_array($arr)
@abstract to save space in the db all empty values in the array
got unset
@discussion The never-'' type field ensures a cell does not
disapear completely.
@discussion Calls it self recursivly for arrays / the rows
@param $arr the array to compress
! @returns the compressed array
*/
function compress_array($arr)
--- 244,255 ----
/*!
! @function compress_array
! @syntax compress_array( $arr )
! @author ralfbecker
@abstract to save space in the db all empty values in the array
got unset
@discussion The never-'' type field ensures a cell does not
disapear completely.
@discussion Calls it self recursivly for arrays / the rows
@param $arr the array to compress
! @result the compressed array
*/
function compress_array($arr)
***************
*** 274,278 ****
@abstract returns obj-data as array
@param $data_too 0 = no data array, 1 = data array too, 2 =
serialize data array
! @returns the array
*/
function as_array($data_too=0)
--- 277,281 ----
@abstract returns obj-data as array
@param $data_too 0 = no data array, 1 = data array too, 2 =
serialize data array
! @result the array
*/
function as_array($data_too=0)
***************
*** 298,302 ****
@abstract saves eTemplate-object to db, can be used as saveAs
by giving keys as params
@params keys see class
! @returns the number of affected rows, 1 should be ok, 0
somethings wrong
*/
function
save($name='',$template='.',$lang='.',$group='',$version='.')
--- 301,305 ----
@abstract saves eTemplate-object to db, can be used as saveAs
by giving keys as params
@params keys see class
! @result the number of affected rows, 1 should be ok, 0
somethings wrong
*/
function
save($name='',$template='.',$lang='.',$group='',$version='.')
***************
*** 367,371 ****
@function delete
@abstract Deletes the eTemplate from the db, object itself is
unchanged
! @returns the number of affected rows, 1 should be ok, 0
somethings wrong
*/
function delete()
--- 370,374 ----
@function delete
@abstract Deletes the eTemplate from the db, object itself is
unchanged
! @result the number of affected rows, 1 should be ok, 0
somethings wrong
*/
function delete()
***************
*** 384,388 ****
@abstract dumps all eTemplates to
<app>/setup/etemplates.inc.php for distribution
@param $app app- or template-name
! @returns the number of templates dumped as message
*/
function dump2setup($app)
--- 387,391 ----
@abstract dumps all eTemplates to
<app>/setup/etemplates.inc.php for distribution
@param $app app- or template-name
! @result the number of templates dumped as message
*/
function dump2setup($app)
***************
*** 426,431 ****
@function getToTranslate
@abstract extracts all texts: labels and helptexts from an
eTemplate-object
! @note some extensions use a '|' to squezze multiple texts in a
label or help field
! @returns array with messages as key AND value
*/
function getToTranslate()
--- 429,434 ----
@function getToTranslate
@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
! @result array with messages as key AND value
*/
function getToTranslate()
***************
*** 455,459 ****
@abstract Read all eTemplates of an app an extracts the texts
to an array
@param $app name of the app
! @returns the array with texts
*/
function getToTranslateApp($app)
--- 458,462 ----
@abstract Read all eTemplates of an app an extracts the texts
to an array
@param $app name of the app
! @result the array with texts
*/
function getToTranslateApp($app)
***************
*** 479,483 ****
@param $additional extra texts to translate, if you pass here
an array with all messages and
@param select-options they get writen too (form is
<unique key> => <message>)
! @returns message with number of messages written (total and new)
*/
function writeLangFile($app,$lang='en',$additional='')
--- 482,486 ----
@param $additional extra texts to translate, if you pass here
an array with all messages and
@param select-options they get writen too (form is
<unique key> => <message>)
! @result message with number of messages written (total and new)
*/
function writeLangFile($app,$lang='en',$additional='')
***************
*** 541,545 ****
@abstract Imports the dump-file /$app/setup/etempplates.inc.php
unconditional (!)
@param $app app name
! @returns message with number of templates imported
*/
function import_dump($app)
--- 544,548 ----
@abstract Imports the dump-file /$app/setup/etempplates.inc.php
unconditional (!)
@param $app app name
! @result message with number of templates imported
*/
function import_dump($app)
Index: class.tab_widget.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.tab_widget.inc.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** class.tab_widget.inc.php 15 Jun 2002 19:58:35 -0000 1.4
--- class.tab_widget.inc.php 2 Sep 2002 11:11:09 -0000 1.5
***************
*** 15,21 ****
/*!
@class tab_widget
@abstract widget that shows one row of tabs and an other row with the
eTemplate of the selected tab
! @note see the example in 'etemplate.tab_widget.test' (use show to view
it)
! @note This widget is independent of the UI as it only uses
etemplate-widgets and has therefor no render-function
*/
class tab_widget
--- 15,22 ----
/*!
@class tab_widget
+ @author ralfbecker
@abstract widget that shows one row of tabs and an other row with the
eTemplate of the selected tab
! @discussion see the example in 'etemplate.tab_widget.test' (use show to
view it)
! @discussion This widget is independent of the UI as it only uses
etemplate-widgets and has therefor no render-function
*/
class tab_widget
Index: class.uietemplate.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.uietemplate.inc.php,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -r1.13 -r1.14
*** class.uietemplate.inc.php 15 Jun 2002 19:58:35 -0000 1.13
--- class.uietemplate.inc.php 2 Sep 2002 11:11:09 -0000 1.14
***************
*** 17,20 ****
--- 17,21 ----
/*!
@class etemplate
+ @author ralfbecker
@abstract creates dialogs / HTML-forms from eTemplate descriptions
@discussion etemplate or uietemplate extends boetemplate, all vars and
public functions are inherited
***************
*** 77,81 ****
@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 $HTTP_POST_VARS['id'] for
the $method-call
! @returns nothing
*/
function
exec($method,$content,$sel_options='',$readonlys='',$preserv='',$changes='')
--- 78,82 ----
@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 $HTTP_POST_VARS['id'] for
the $method-call
! @result nothing
*/
function
exec($method,$content,$sel_options='',$readonlys='',$preserv='',$changes='')
***************
*** 192,196 ****
@param eg. $cname='cont', element-name = 'name' returned
content in $HTTP_POST_VARS['cont']['name']
@param $show_xxx row,col name/index for name expansion
! @returns the generated HTML
*/
function
show($content,$sel_options='',$readonlys='',$cname='cont',$show_c=0,$show_row=0)
--- 193,197 ----
@param eg. $cname='cont', element-name = 'name' returned
content in $HTTP_POST_VARS['cont']['name']
@param $show_xxx row,col name/index for name expansion
! @result the generated HTML
*/
function
show($content,$sel_options='',$readonlys='',$cname='cont',$show_c=0,$show_row=0)
***************
*** 312,316 ****
@param $cell array with data of the cell: name, type, ...
@param for rest see show
! @returns the generated HTML
*/
function
show_cell($cell,$content,$sel_options,$readonlys,$cname,$show_c,$show_row,&$span)
--- 313,317 ----
@param $cell array with data of the cell: name, type, ...
@param for rest see show
! @result the generated HTML
*/
function
show_cell($cell,$content,$sel_options,$readonlys,$cname,$show_c,$show_row,&$span)
***************
*** 584,588 ****
@param $readonly array with cell- / var-names which should NOT
return content (this is to workaround browsers who not understand READONLY
correct)
@param $cname basename of our returnt content (same as in call
to show)
! @returns the adjusted content (by using the var-param &$content)
*/
function process_show(&$content,$readonlys='')
--- 585,589 ----
@param $readonly array with cell- / var-names which should NOT
return content (this is to workaround browsers who not understand READONLY
correct)
@param $cname basename of our returnt content (same as in call
to show)
! @result the adjusted content (by using the var-param &$content)
*/
function process_show(&$content,$readonlys='')
***************
*** 700,704 ****
/*!
! @function
process_show_cell($cell,$name,$c,$r,$readonlys,&$value)
@abstract makes necessary adjustments on $value eTemplate /
form gots submitted
@discussion This is only an internal function, dont call it
direct use only exec
--- 701,707 ----
/*!
! @function process_show_cell
! @syntax process_show_cell( $cell,$name,$c,$r,$readonlys,&$value
)
! @author ralfbecker
@abstract makes necessary adjustments on $value eTemplate /
form gots submitted
@discussion This is only an internal function, dont call it
direct use only exec
***************
*** 709,713 ****
@param $readonlys readonlys-array to pass on for templates
@param &$value value to change
! @returns if $value is set
*/
function process_show_cell($cell,$name,$c,$r,$readonlys,&$value)
--- 712,716 ----
@param $readonlys readonlys-array to pass on for templates
@param &$value value to change
! @result if $value is set
*/
function process_show_cell($cell,$name,$c,$r,$readonlys,&$value)
***************
*** 812,819 ****
/*!
! @function java_script($consider_not_tested_as_enabled = True)
@abstract is javascript enabled?
@discussion this should be tested by the api at login
! @returns true if javascript is enabled or not yet tested
*/
function java_script($consider_not_tested_as_enabled = True)
--- 815,824 ----
/*!
! @function java_script
! @syntax java_script( $consider_not_tested_as_enabled = True )
! @author ralfbecker
@abstract is javascript enabled?
@discussion this should be tested by the api at login
! @result true if javascript is enabled or not yet tested
*/
function java_script($consider_not_tested_as_enabled = True)
***************
*** 826,830 ****
/*!
! @function include_java_script()
@abstract returns the javascript to be included by exec
*/
--- 831,837 ----
/*!
! @function include_java_script
! @syntax include_java_script( )
! @author ralfbecker
@abstract returns the javascript to be included by exec
*/
Index: class.uietemplate_gtk.inc.php
===================================================================
RCS file: /cvsroot/phpgroupware/etemplate/inc/class.uietemplate_gtk.inc.php,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -r1.9 -r1.10
*** class.uietemplate_gtk.inc.php 15 Jun 2002 09:21:55 -0000 1.9
--- class.uietemplate_gtk.inc.php 2 Sep 2002 11:11:09 -0000 1.10
***************
*** 17,20 ****
--- 17,21 ----
/*!
@class etemplate
+ @author ralfbecker
@abstract creates dialogs / HTML-forms from eTemplate descriptions
@discussion etemplate or uietemplate extends boetemplate, all vars and
public functions are inherited
***************
*** 78,82 ****
@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 $HTTP_POST_VARS['id'] for
the $method-call
! @returns nothing
*/
function
exec($method,$content,$sel_options='',$readonlys='',$preserv='')
--- 79,83 ----
@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 $HTTP_POST_VARS['id'] for
the $method-call
! @result nothing
*/
function
exec($method,$content,$sel_options='',$readonlys='',$preserv='')
***************
*** 155,159 ****
@function process_show
@abstract this is only an empty function for the GTK ui
! @returns the adjusted content (in the simplest case that would
be $content)
*/
function process_show(&$content,$readonlys='')
--- 156,160 ----
@function process_show
@abstract this is only an empty function for the GTK ui
! @result the adjusted content (in the simplest case that would
be $content)
*/
function process_show(&$content,$readonlys='')
***************
*** 264,268 ****
@param eg. $cname='cont', element-name = 'name' returned
content in $HTTP_POST_VARS['cont']['name']
@param $show_xxx row,col name/index for name expansion
! @returns the generated HTML
*/
function
show(&$result,$content,$sel_options='',$readonlys='',$cname='',$show_c=0,$show_row=0)
--- 265,269 ----
@param eg. $cname='cont', element-name = 'name' returned
content in $HTTP_POST_VARS['cont']['name']
@param $show_xxx row,col name/index for name expansion
! @result the generated HTML
*/
function
show(&$result,$content,$sel_options='',$readonlys='',$cname='',$show_c=0,$show_row=0)
***************
*** 434,438 ****
@param $cell array with data of the cell: name, type, ...
@param for rest see show
! @returns the generated HTML
*/
function
show_cell($cell,$content,$sel_options,$readonlys,$cname,$show_c,$show_row,&$span,&$result)
--- 435,439 ----
@param $cell array with data of the cell: name, type, ...
@param for rest see show
! @result the generated HTML
*/
function
show_cell($cell,$content,$sel_options,$readonlys,$cname,$show_c,$show_row,&$span,&$result)
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Phpgroupware-cvs] CVS: etemplate/inc class.boetemplate.inc.php,1.11,1.12 class.date_widget.inc.php,1.2,1.3 class.datefield_widget.inc.php,1.3,1.4 class.db_tools.inc.php,1.10,1.11 class.editor.inc.php,1.6,1.7 class.html.inc.php,1.3,1.4 class.so_sql.inc.php,1.2,1.3 class.soetemplate.inc.php,1.6,1.7 class.tab_widget.inc.php,1.4,1.5 class.uietemplate.inc.php,1.13,1.14 class.uietemplate_gtk.inc.php,1.9,1.10,
Ralf Becker <address@hidden> <=
- Prev by Date:
[Phpgroupware-cvs] CVS: infolog/inc class.boinfolog.inc.php,1.19,1.20
- Next by Date:
[Phpgroupware-cvs] CVS: infolog/inc class.boinfolog.inc.php,1.20,1.21 class.bolink.inc.php,1.1,1.2 class.solink.inc.php,1.1,1.2 class.uilink.inc.php,1.1,1.2 class.vfs.inc.php,1.4,1.5
- Previous by thread:
[Phpgroupware-cvs] CVS: infolog/inc class.boinfolog.inc.php,1.19,1.20
- Next by thread:
[Phpgroupware-cvs] CVS: infolog/inc class.boinfolog.inc.php,1.20,1.21 class.bolink.inc.php,1.1,1.2 class.solink.inc.php,1.1,1.2 class.uilink.inc.php,1.1,1.2 class.vfs.inc.php,1.4,1.5
- Index(es):