|
|
|
File: C:/usr/local/lib/php/blueshoes-4.2/core/html/form/Bs_FormHandler.class.php
BlueShoes Application Framework - Form
Bs_FormHandler
Bs_Object | +-- Bs_FormHandler
Form Handler Class
|
public class Bs_FormHandler extends Bs_Object
Form Handler Class
loads and persists html forms from/to the [mysql] database.dependencies: Bs_Form (which starts a chain of includes)
| Authors | andrej arn <andrej@arn.li> |
| Version | 4.0.$id$ |
| Copyright | blueshoes.org |
|
| |
|
Methods inherited from Bs_Object |
| isex, isexception, tostring, tohtml, persist, unpersist, bs_object, bbsetoutput, bbawake, bbisawake, bbxmsg, bbxfunctionstart, bbxfunctionend, bbxecho, bbxvar, bbxvardump, bbforcetrace, bbbufferstart, bbbufferget, bbbufferendflush, bbbufferendclean |
|
|
|
Private Method Summary |
| void |
loadForm()Warning: documentation is missing. |
|
Public Field Summary |
| object [unknown] |
$forminstance of bs_form |
|
Private Field Summary |
| object [unknown] |
$_bsDbinstance of bs_mysql (bs_db). usually a reference to the globally used db object, |
| unknown |
$_postVarsreference to $GLOBALS['HTTP_POST_VARS'] |
| mixed |
$_formNameIdthe identifier for the form. |
| unknown |
$_language |
| unknown |
$_mode |
|
|
|
Public Method Details |
Bs_FormHandler |
|
public void Bs_FormHandler( mixed $formNameId, [ string $bsDb ] )
|
| |
Constructor.
|
| Parameter |
|
| mixed |
$formNameId |
|
|
one of string: the internally used form name. int: the internally used form ID. |
|
|
| string |
$bsDb |
= >>NULL<< |
|
an instance of bs_mysql (bs_db) if you want to use a custom db object, the globally one is used instead. pass it byref if you can. |
|
| Returns |
void |
|
go |
|
public string go( [ string $doLoadForm ] )
|
| |
this method does it all itself.
|
| Parameter |
|
| string |
$doLoadForm |
= >>TRUE<< |
|
default is TRUE. it may be needed that you do loadForm() yourself, do something with the form, and then call this method. |
|
| Returns |
string the whole form as html code.
@throw bs_exception |
|
setLanguage |
|
public void setLanguage( [ string $lang ] )
|
| |
sets the language for this form handler. if the form already exists,
it's passed along. otherwise it is used as soon as the form object is instanced.
|
| Parameter |
|
| string |
$lang |
= >>'en'<< |
|
default is 'en' |
|
| Returns |
void |
| See Also |
$_language |
|
setMode |
|
public void setMode( [ string $mode ] )
|
| |
sets the mode. one of 'add', 'edit', 'delete'. if the form already exists,
it's passed along. otherwise it is used as soon as the form object is instanced.
|
| Parameter |
|
| string |
$mode |
= >>''<< |
|
default is '' |
|
| Returns |
void |
| See Also |
$_mode |
|
|
Private Method Details |
loadForm |
|
private void loadForm( )
|
| |
Warning: documentation is missing.
|
| Returns |
void |
|
|
Public Field Details |
$form |
|
public object [unknown] $form
>><<
instance of bs_form
|
|
|
Private Field Details |
$_bsDb |
|
private object [unknown] $_bsDb
>><<
instance of bs_mysql (bs_db). usually a reference to the globally used db object,
may also be a custom one.
|
|
$_postVars |
|
private unknown $_postVars
>><<
reference to $GLOBALS['HTTP_POST_VARS']
|
|
$_formNameId |
|
private mixed $_formNameId
>><<
the identifier for the form.
one of:string: the internally used form name.int: the internally used form ID.
|
|
$_language |
|
private unknown $_language
>><<
|
|
$_mode |
|
private unknown $_mode
>><<
|
|
|
Private Constant Details |
BS_FORMHANDLER_VERSION
define( BS_FORMHANDLER_VERSION, >>4.0.$x$<< )
Case: default: case sensitive
|
|
|
|
|
|
| PHPDoc 1.0beta |