Public Method Details |
template_bridge |
public void template_bridge( [ string $form, string $template, mixed $template_files ] )
|
|
Constructor.
|
Parameter |
|
string |
$form |
= >>""<< |
|
to template file |
|
|
string |
$template |
= >>""<< |
|
unknowns? |
|
|
mixed |
$template_files |
= >>""<< |
|
files |
|
Returns |
void |
See Also |
$template_files, $tpl |
|
setTemplatePath |
public bool setTemplatePath( string $template )
|
|
Sets the path to the template
|
Parameter |
|
|
Returns |
bool $ok |
Throws |
runtime_wrongparam |
See Also |
$template |
|
setTemplateFiles |
public bool setTemplateFiles( mixed $template_files )
|
|
Sets the template files
|
Parameter |
|
|
Returns |
bool $ok |
Throws |
runtime_wrongparam |
See Also |
$template_files |
|
setForm |
public void setForm( mixed $form )
|
|
Defines the form to use
|
Parameter |
|
|
Returns |
void |
Throws |
runtime_wrongparam |
See Also |
$form |
|
isValid |
public bool isValid( )
|
|
Are there errors in this form?
|
Returns |
bool $ok |
|
setMethod |
public void setMethod( [ string $method ] )
|
|
Set the method used in the form. Form needs it for autoloadValues().
You set the method eighter by Start() or be setMethod()
|
Parameter |
|
string |
$method |
= >>"POST"<< |
|
|
|
Returns |
void |
|
setImagepath |
public bool setImagepath( string $path )
|
|
Were are the images stored?
|
Parameter |
|
|
Returns |
bool $ok |
Throws |
runtime_wrongparam |
|
setImages |
public bool setImages( array $images )
|
|
If you want to use images to assign the status of a field, define them.
|
Parameter |
|
|
Returns |
bool $ok |
Throws |
runtime_wrongparam |
See Also |
$images, dropImages() |
|
dropImages |
public bool dropImages( array $images )
|
|
Drop some images
|
Parameter |
|
|
Returns |
bool $ok |
Throws |
runtime_wrongparam |
See Also |
setImages(), $images |
|
addElement |
public bool addElement( array $element_data )
|
|
Adds a new element to the template
|
Parameter |
|
|
Returns |
bool $ok |
Throws |
runtime_wrongparam, notice |
|
addComment |
public bool addComment( string $comment, [ string $bgcolor ] )
|
|
Adds a comment to the form
|
Parameter |
|
|
|
|
Returns |
bool $ok |
Throws |
runtime_wrongparam |
|
addSubmit |
public bool addSubmit( string $name )
|
|
Define a submit button - today there's always just on submit button
|
Parameter |
|
|
Returns |
bool $ok |
Throws |
runtime_wrongparam |
See Also |
addReset(), addNext(), addPrev() |
|
addReset |
public bool addReset( string $name )
|
|
Define a reset button
|
Parameter |
|
|
Returns |
bool $ok |
Throws |
runtime_wrongparam |
See Also |
addSubmit(), addNext(), addPrev() |
|
addNext |
public bool addNext( string $name )
|
|
Define a next step submit button, tribute to tab styled forms
|
Parameter |
|
|
Returns |
bool $ok |
See Also |
addReset(), addSubmit(), addPrev() |
|
addPrev |
public bool addPrev( string $name )
|
|
Define a previous step submit button, tribute to tab styled forms
|
Parameter |
|
|
Returns |
bool $ok |
Throws |
runtime_wrongparam |
See Also |
addSubmit(), addReset(), addNext() |
|
dumpForm |
public string dumpForm( )
|
|
Dumps a form to the template. This is no replacement for a custom init()
function. Within init() you define labels, hints, comments and buttons. Thiscan't be done with dumpForm.
|
Returns |
string $html |
Throws |
runtime |
|
Start |
public void Start( [ string $js_name, mixed $method, string $action, string $target ] )
|
|
Generate <form>-Tag
|
Parameter |
|
|
|
mixed |
$method |
= >>"POST"<< |
|
|
|
|
|
|
|
Returns |
void |
See Also |
setStart(), Finish(), setFinish() |
|
setStart |
public boolean setStart( string $html )
|
|
Sets the opening form tag
|
Parameter |
|
|
Returns |
boolean |
See Also |
Start(), Finish(), setFinish() |
|
Finish |
public string Finish( [ string $additional_html, mixed $sess ] )
|
|
Generate closing </form>-Tag
|
Parameter |
|
string |
$additional_html |
= >>""<< |
|
= "" |
|
|
mixed |
$sess |
= >>""<< |
|
= "" |
|
Returns |
string $html |
|
setFinish |
public bool setFinish( string $html )
|
|
Sets the closing form tag
|
Parameter |
|
|
Returns |
bool $ok |
Throws |
runtime |
See Also |
Finish(), Start(), setStart() |
|
get |
public string get( )
|
|
Returns the Form
|
Returns |
string $html |
Throws |
runtime |
|
show |
public string show( )
|
|
Show the generated form
|
Returns |
string $html |
|