QFormBase Class Reference

classQFormBase

January 9th, 2009|

holmrodd

QFormBase Class Reference

Inherits QBaseClass.

Inherited by QForm.

Collaboration diagram for QFormBase:

[legend]

List of all members.

Public Member Functions

__get ($strName)
__set ($strName, $mixValue)
GenerateControlId ()
VarExport ($blnReturn=true)
IsCheckableControlRendered ($strControlId)
CallDataBinder ($strMethodName, QPaginatedControl $objPaginatedControl, $objParentControl=null)
AddControl (QControl $objControl)
GetControl ($strControlId)
RemoveControl ($strControlId)
GetAllControls ()
PersistControl ($objControl)
AddGrouping (QControlGrouping $objGrouping)
GetGrouping ($strGroupingId)
RemoveGrouping ($strGroupingId)
GetAllGroupings ()
GetChildControls ($objParentObject)
EvaluateTemplate ($strTemplate)
TriggerMethod ($strId, $strMethodName)
RenderBegin ($blnDisplayOutput=true)
IsPostBack ()
GetErrorMessages ($blnErrorsOnly=false)
GetErrorControls ($blnErrorsOnly=false)
RenderEnd ($blnDisplayOutput=true)

Static Public Member Functions

static Run ($strFormId, $strAlternateHtmlFile=null)
static Serialize (QForm $objForm)
static Unserialize ($strPostDataState)

Public Attributes

Static Public Attributes

static $EncryptionKey = null
static $FormStateHandler = 'QFormStateHandler'

Protected Member Functions

Form_Run ()
Form_Load ()
Form_Create ()
Form_PreRender ()
Form_Validate ()
Form_Exit ()
RenderAjaxHelper ($objControl)
RenderAjax ()
ValidateControlAndChildren (QControl $objControl)
TriggerActions ($strControlIdOverride=null)
Render ()
RenderChildren ($blnDisplayOutput=true)
__construct ()
ProcessJavaScriptList ($strJavaScriptFileList)
ProcessStyleSheetList ($strStyleSheetFileList)

Protected Attributes

$strFormId
$intFormStatus
$objControlArray
$objPersistentControlArray = array()
$objGroupingArray
$blnRenderedBodyTag = false
$blnRenderedCheckableControlArray
$strCallType
$objDefaultWaitIcon = null
$strFormAttributeArray = array()
$strIncludedJavaScriptFileArray = array()
$strIgnoreJavaScriptFileArray = array()
$strIncludedStyleSheetFileArray = array()
$strIgnoreStyleSheetFileArray = array()
$strPreviousRequestMode = false
$strHtmlIncludeFilePath
$strCssClass
$intNextControlId = 1

Constructor & Destructor Documentation

QFormBase::__construct ( ) [protected]

Member Function Documentation

QFormBase::__get ( $ strName )

Override method to perform a property "Get" This will get the value of $strName All inhereted objects that call __get() should always fall through to calling parent::__get() in a try/catch statement catching for CallerExceptions.

Parameters:

string

$strName Name of the property to get

Returns:: mixed the returned property

Reimplemented from QBaseClass.

References QCallerException::IncrementOffset().

QFormBase::__set	(	$	strName,
		$	mixValue
	)

Override method to perform a property "Set" This will set the property $strName to be $mixValue All inhereted objects that call __set() should always fall through to calling parent::__set() in a try/catch statement catching for CallerExceptions.

Parameters:

	string	$strName Name of the property to set
	string	$mixValue New value of the property

Returns:: mixed the property that was set

Reimplemented from QBaseClass.

References QType::Cast(), QCallerException::IncrementOffset(), and QType::String.

QFormBase::AddControl ( QControl $ objControl )

QFormBase::AddGrouping ( QControlGrouping $ objGrouping )

Referenced by QControlGrouping::__construct().

QFormBase::CallDataBinder	(	$	strMethodName,
		QPaginatedControl $	objPaginatedControl,
		$	objParentControl = `null`
	)

QFormBase::EvaluateTemplate ( $ strTemplate )

References $_CONTROL.

QFormBase::Form_Create ( ) [protected]

QFormBase::Form_Exit ( ) [protected]

QFormBase::Form_Load ( ) [protected]

QFormBase::Form_PreRender ( ) [protected]

QFormBase::Form_Run ( ) [protected]

QFormBase::Form_Validate ( ) [protected]

Referenced by TriggerActions().

QFormBase::GenerateControlId ( )

Referenced by QControlGrouping::__construct().

QFormBase::GetAllControls ( )

Referenced by GetErrorControls(), GetErrorMessages(), RenderAjax(), RenderBegin(), and RenderEnd().

QFormBase::GetAllGroupings ( )

QFormBase::GetChildControls ( $ objParentObject )

Referenced by RenderChildren(), and TriggerActions().

QFormBase::GetControl ( $ strControlId )

QFormBase::GetErrorControls ( $ blnErrorsOnly = false )

Will return an array of QControls from the form which have either an error or warning message.

Parameters:

bool

$blnErrorsOnly Return controls that have just errors (otherwise, show both warnings and errors)

Returns:: QControl[] an array of controls representing the (multiple) errors and warnings

References GetAllControls().

QFormBase::GetErrorMessages ( $ blnErrorsOnly = false )

Will return an array of Strings which will show all the error and warning messages in all the controls in the form.

Parameters:

bool

$blnErrorsOnly Show only the errors (otherwise, show both warnings and errors)

Returns:: string[] an array of strings representing the (multiple) errors and warnings

References GetAllControls().

QFormBase::GetGrouping ( $ strGroupingId )

QFormBase::IsCheckableControlRendered ( $ strControlId )

QFormBase::IsPostBack ( )

Returns whether or not this Form is being run due to a PostBack event (e.g. a ServerAction or AjaxAction)

Returns:: bool

References QCallType::None.

QFormBase::PersistControl ( $ objControl )

QFormBase::ProcessJavaScriptList ( $ strJavaScriptFileList ) [protected]

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".

This WILL update the internal $strIncludedJavaScriptFileArray array.

Parameters:

string

$strJavaScriptFileList

Returns:: string[] array of script files to include or NULL if none

Referenced by RenderAjax(), RenderBegin(), and RenderEnd().

QFormBase::ProcessStyleSheetList ( $ strStyleSheetFileList ) [protected]

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".

This WILL update the internal $strIncludedStyleSheetFileArray array.

Parameters:

string

$strStyleSheetFileList