SCPHP
[ class tree: SCPHP ] [ index: SCPHP ] [ all elements ]

Class: ScForms

Source Location: /ScForms.php

Class Overview

ScGeneral
   |
   --ScForms

Smart Client Forms Helper


Variables

Methods


Inherited Variables

Inherited Methods

Class: ScGeneral

ScGeneral::__construct()
Set $remove_quotes_str
ScGeneral::ScGeneral()
Return instance
ScGeneral::addQuotesStr()
Add QuotesStr to String
ScGeneral::includeScripts()
Create the scripts for include
ScGeneral::removeQuotes()
Remove quotes from specific vars that are not supposed to be quoted using the $removeQuotesStr var

Class Details

[line 21]
Smart Client Forms Helper



[ Top ]


Class Variables

$_defaultTitleOrientation =  'left'

[line 32]



Tags:

var:  Default title orientation for the form fields
access:  protected

Type:   string


[ Top ]

$_fields =

[line 27]



Tags:

access:  protected

Type:   array


[ Top ]



Class Methods


method addButton [line 42]

void addButton( mixed $data, [ $click = ''], [array $options = ''])

Add Button



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the title of the field. If array, them we will loop on it
array   $options   Additional options
   $click  

[ Top ]

method addCheckboxField [line 88]

void addCheckboxField( mixed $data, [string $title = ''], [boolean $checked = false], [array $options = ''])

Add Checkbox Field



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the name of the field. If array, them we will loop on it
string   $title   Title of the field
boolean   $checked   Default value
array   $options   Additional options

[ Top ]

method addDateField [line 139]

void addDateField( mixed $data, [string $title = ''], [string $defaultValue = ''], [boolean $useTextField = false], [string $dateDisplayFormat = ''], [string $startDate = ''], [string $endDate = ''], [array $options = ''])

Add Date Field



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the name of the field. If array, them we will loop on it
string   $title   Title of the field
string   $defaultValue   Default value
boolean   $useTextField   Use a text field
string   $dateDisplayFormat   Display format
string   $startDate   Start date
string   $endDate   End date
array   $options   Additional options

[ Top ]

method addHeader [line 188]

void addHeader( mixed $data, [array $options = ''])

Add Header



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the value of the field. If array, them we will loop on it
array   $options   Additional options

[ Top ]

method addHiddenField [line 232]

void addHiddenField( mixed $data, [string $defaultValue = ''], [array $options = ''])

Add Hidden Field



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the name of the field. If array, them we will loop on it
string   $defaultValue   Default value for the hidden field
array   $options   Additional options

[ Top ]

method addPasswordField [line 331]

void addPasswordField( mixed $data, [string $title = ''], [string $defaultValue = ''], [array $options = ''])

Add Password Field



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the name of the field. If array, them we will loop on it
string   $title   Title of the field
string   $defaultValue   Default value for the text area
array   $options   Additional options

[ Top ]

method addSection [line 432]

void addSection( mixed $data, [string $defaultValue = ''], [array $itemIds = ''], [boolean $sectionExpanded = true], [array $options = ''])

Add Section



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be a unique value for this section. If array, them we will loop on it
string   $defaultValue   Title of the section
array   $itemIds   Fields on this section
boolean   $sectionExpanded   True if section is expanded
array   $options   Additional options

[ Top ]

method addSelectField [line 484]

void addSelectField( mixed $data, [string $title = ''], [array $valueMap = ''], [mixed $defaultValue = ''], [array $options = ''])

Add Select Field



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the name of the field. If array, them we will loop on it
string   $title   Title of the field
array   $valueMap   Array containing the values for this select field
mixed   $defaultValue   Default value
array   $options   Additional options

[ Top ]

method addSliderField [line 381]

void addSliderField( mixed $data, [string $title = ''], [ $minValue = ''], [ $maxValue = ''], [ $numValues = ''], [float $defaultValue = ''], [array $options = ''], float $min, float $max, float $step)

Add Slider Field



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the name of the field. If array, them we will loop on it
string   $title   Title of the field
float   $min   Min value
float   $max   Max value
float   $step   Step value
float   $defaultValue   Default value
array   $options   Additional options
   $minValue  
   $maxValue  
   $numValues  

[ Top ]

method addSpinnerField [line 281]

void addSpinnerField( mixed $data, [string $title = ''], [float $min = ''], [float $max = ''], [float $step = ''], [float $defaultValue = ''], [array $options = ''])

Add Spinner Field



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the name of the field. If array, them we will loop on it
string   $title   Title of the field
float   $min   Min value
float   $max   Max value
float   $step   Step value
float   $defaultValue   Default value
array   $options   Additional options

[ Top ]

method addSubmitButton [line 530]

void addSubmitButton( mixed $data, [array $options = ''])

Add Submit Button



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the value of the field. If array, them we will loop on it
array   $options   Additional options

[ Top ]

method addTextArea [line 575]

void addTextArea( mixed $data, [string $title = ''], [string $defaultValue = ''], [array $options = ''])

Add Text Area Field



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the name of the field. If array, them we will loop on it
string   $title   Title of the field
string   $defaultValue   Default value for the text area
array   $options   Additional options

[ Top ]

method addTextField [line 622]

void addTextField( mixed $data, [string $title = ''], [string $defaultValue = ''], [array $options = ''])

Add Text Field



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the name of the field. If array, them we will loop on it
string   $title   Title of the field
string   $defaultValue   Default value for the text area
array   $options   Additional options

[ Top ]

method addTimeField [line 669]

void addTimeField( mixed $data, [string $title = ''], [string $defaultValue = ''], [array $options = ''])

Add Time Field



Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the name of the field. If array, them we will loop on it
string   $title   Title of the field
string   $defaultValue   Default value
array   $options   Additional options

[ Top ]

method clearFields [line 726]

void clearFields( )

Clear fields

Clear Fields array




Tags:

access:  public


[ Top ]

method create [line 743]

string create( mixed $data, [string $action = ''], [array $options = ''])

Create

Create the dynamic form




Tags:

access:  public


Parameters:

mixed   $data   If string, it must be the id of the form. If array, them we will loop through it
string   $action   Action of the form
array   $options   Additional options

[ Top ]

method getFields [line 714]

array getFields( )

Get Fields

Return the current fields array




Tags:

access:  public


[ Top ]


Documentation generated on Wed, 29 Jul 2009 22:37:14 -0300 by phpDocumentor 1.4.1