| Property | Type | Description | |
|---|---|---|---|
| $EncryptionKey | |||
| $FormStateHandler |
| Method | Description | |
|---|---|---|
| AddControl ( QControl $objControl ) | ||
| AddGrouping ( QControlGrouping $objGrouping ) | ||
| CallDataBinder ( $strMethodName, QPaginatedControl $objPaginatedControl, $objParentControl = null ) | ||
| ClearPollingProcessor ( ) : void | Stops polling of polling processor | |
| ClearUrlHashProcessor ( ) : void | Stops polling of URL hash processor | |
| EvaluateTemplate ( $strTemplate ) | ||
| GenerateControlId ( ) | ||
| GetAllControls ( ) | ||
| GetAllGroupings ( ) | ||
| GetChildControls ( $objParentObject ) | ||
| GetControl ( $strControlId ) | ||
| GetCustomAttribute ( string $strName ) : string | Looks up the custom attribute by name, returning NULL if not set | |
| GetErrorControls ( boolean $blnErrorsOnly = false ) : QControl[] | Will return an array of QControls from the form which have either an error or warning message. | |
| GetErrorMessages ( boolean $blnErrorsOnly = false ) : string[] | Will return an array of Strings which will show all the error and warning messages in all the controls in the form. | |
| GetGrouping ( $strGroupingId ) | ||
| IsCheckableControlRendered ( $strControlId ) | ||
| IsPollingActive ( ) : boolean | Returns whether or not Polling is currently active | |
| IsPostBack ( ) : boolean | Returns whether or not this Form is being run due to a PostBack event (e.g. a ServerAction or AjaxAction) | |
| PersistControl ( $objControl ) | ||
| PrepForVarExport ( ) | ||
| RemoveControl ( $strControlId ) | ||
| RemoveGrouping ( $strGroupingId ) | ||
| Run ( $strFormId, $strAlternateHtmlFile = null ) | ||
| Serialize ( QForm $objForm ) : string | ||
| SetCustomAttribute ( string $strName, string $strValue ) : void | Allows you to set or clear custom attributes on the | |
| SetPollingProcessor ( string $strMethodName, object $objParentControl = null, integer $intPollingInterval = 2500 ) : void | Adds polling to the QForm | |
| SetUrlHashProcessor ( string $strMethodName, Object $objParentControl = null, integer $intUrlHashPollingInterval = 250 ) : void | If the QForm should process the URL hash value after initial rendering, set the PHP method name (and parent object) to be called to process the hash on initial load. Method specified should be an Event Handler, where the $strParameter passed in will be the value of the hash value (if any). If no parent object is specified, this QForm will be assumed. | |
| TriggerMethod ( $strId, $strMethodName ) | ||
| Unserialize ( $strPostDataState ) : Form | ||
| __get ( $strName ) | ||
| __set ( $strName, $mixValue ) |
| Method | Description | |
|---|---|---|
| Form_Create ( ) | ||
| Form_Exit ( ) | ||
| Form_Load ( ) | ||
| Form_PreRender ( ) | ||
| Form_Run ( ) | ||
| Form_Validate ( ) | ||
| Polling_Process ( $strFormId, $strControlId, $strParameter ) | ||
| ProcessJavaScriptList ( string $strJavaScriptFileList ) : string[] | Primarily used by RenderBegin and by RenderAjax Given a comma-delimited list of javascript files, this will return an array of file that NEED to still be included because (1) it hasn't yet been included and (2) it hasn't been specified to be "ignored". | |
| ProcessStyleSheetList ( string $strStyleSheetFileList ) : string[] | Primarily used by RenderBegin and by RenderAjax Given a comma-delimited list of stylesheet files, this will return an array of file that NEED to still be included because (1) it hasn't yet been included and (2) it hasn't been specified to be "ignored". | |
| Render ( ) | ||
| RenderAjax ( ) | ||
| RenderAjaxHelper ( $objControl ) | ||
| RenderBegin ( $blnDisplayOutput = true ) | ||
| RenderChildren ( $blnDisplayOutput = true ) | ||
| RenderEnd ( $blnDisplayOutput = true ) | ||
| TriggerActions ( $strControlIdOverride = null ) | ||
| UrlHashProxy_Process ( $strFormId, $strControlId, $strParameter ) | ||
| ValidateControlAndChildren ( QControl $objControl ) | ||
| __construct ( ) | This exists to prevent inadverant "New" |
| public AddGrouping ( QControlGrouping $objGrouping ) | ||
| $objGrouping | QControlGrouping | |
| public CallDataBinder ( $strMethodName, QPaginatedControl $objPaginatedControl, $objParentControl = null ) | ||
| $objPaginatedControl | QPaginatedControl | |
| public ClearPollingProcessor ( ) : void | ||
| return | void | |
| public ClearUrlHashProcessor ( ) : void | ||
| return | void | |
| public GetCustomAttribute ( string $strName ) : string | ||
| $strName | string | |
| return | string | |
| public GetErrorControls ( boolean $blnErrorsOnly = false ) : QControl[] | ||
| $blnErrorsOnly | boolean | Return controls that have just errors (otherwise, show both warnings and errors) |
| return | QControl[] | an array of controls representing the (multiple) errors and warnings |
| public GetErrorMessages ( boolean $blnErrorsOnly = false ) : string[] | ||
| $blnErrorsOnly | boolean | Show only the errors (otherwise, show both warnings and errors) |
| return | string[] | an array of strings representing the (multiple) errors and warnings |
| public IsPollingActive ( ) : boolean | ||
| return | boolean | |
| public IsPostBack ( ) : boolean | ||
| return | boolean | |
| protected Polling_Process ( $strFormId, $strControlId, $strParameter ) |
| protected ProcessJavaScriptList ( string $strJavaScriptFileList ) : string[] | ||
| $strJavaScriptFileList | string | |
| return | string[] | array of script files to include or NULL if none |
| protected ProcessStyleSheetList ( string $strStyleSheetFileList ) : string[] | ||
| $strStyleSheetFileList | string | |
| return | string[] | array of stylesheet files to include or NULL if none |
| public SetPollingProcessor ( string $strMethodName, object $objParentControl = null, integer $intPollingInterval = 2500 ) : void | ||
| $strMethodName | string | name of the event handling method to be called |
| $objParentControl | object | optional object that contains the method (uses the QForm if none is specified) |
| $intPollingInterval | integer | the interval (in ms) the polling will occur (optional, default is 2500ms) |
| return | void | |
| public SetUrlHashProcessor ( string $strMethodName, Object $objParentControl = null, integer $intUrlHashPollingInterval = 250 ) : void | ||
| $strMethodName | string | name of the event handling method to be called |
| $objParentControl | Object | optional object that contains the method |
| $intUrlHashPollingInterval | integer | the interval (in ms) on how often the URL is reprocessed (optional, default is 250ms) |
| return | void | |
| public static Unserialize ( $strPostDataState ) : Form | ||
| return | Form | the Form object |
| protected UrlHashProxy_Process ( $strFormId, $strControlId, $strParameter ) |
| protected ValidateControlAndChildren ( QControl $objControl ) | ||
| $objControl | QControl | |