PHP Class QFormBase, qcodo

Inheritance: extends QBaseClass
Afficher le fichier Open project: qcodo/qcodo Class Usage Examples

Méthodes publiques

Свойство Type Description
$EncryptionKey
$FormStateHandler

Protected Properties

Свойство Type Description
$blnRenderedBodyTag
$blnRenderedCheckableControlArray
$intFormStatus
$intNextControlId
$objControlArray
$objDefaultWaitIcon
$objGroupingArray
$objPersistentControlArray
$strCallType
$strCssClass
$strFormAttributeArray
$strFormId
$strHtmlIncludeFilePath
$strIgnoreJavaScriptFileArray
$strIgnoreStyleSheetFileArray
$strIncludedJavaScriptFileArray
$strIncludedStyleSheetFileArray
$strPreviousRequestMode
$strUrlHash

Méthodes publiques

Méthode 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
tag, itself, e.g. things like autocomplete=false, etc.
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 )

Méthodes protégées

Méthode 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"

Method Details

AddControl() public méthode

public AddControl ( QControl $objControl )
$objControl QControl

AddGrouping() public méthode

public AddGrouping ( QControlGrouping $objGrouping )
$objGrouping QControlGrouping

CallDataBinder() public méthode

public CallDataBinder ( $strMethodName, QPaginatedControl $objPaginatedControl, $objParentControl = null )
$objPaginatedControl QPaginatedControl

ClearPollingProcessor() public méthode

Stops polling of polling processor
public ClearPollingProcessor ( ) : void
Résultat void

ClearUrlHashProcessor() public méthode

Stops polling of URL hash processor
public ClearUrlHashProcessor ( ) : void
Résultat void

EvaluateTemplate() public méthode

public EvaluateTemplate ( $strTemplate )

Form_Create() protected méthode

protected Form_Create ( )

Form_Exit() protected méthode

protected Form_Exit ( )

Form_Load() protected méthode

protected Form_Load ( )

Form_PreRender() protected méthode

protected Form_PreRender ( )

Form_Run() protected méthode

protected Form_Run ( )

Form_Validate() protected méthode

protected Form_Validate ( )

GenerateControlId() public méthode

public GenerateControlId ( )

GetAllControls() public méthode

public GetAllControls ( )

GetAllGroupings() public méthode

public GetAllGroupings ( )

GetChildControls() public méthode

public GetChildControls ( $objParentObject )

GetControl() public méthode

public GetControl ( $strControlId )

GetCustomAttribute() public méthode

Looks up the custom attribute by name, returning NULL if not set
public GetCustomAttribute ( string $strName ) : string
$strName string
Résultat string

GetErrorControls() public méthode

Will return an array of QControls from the form which have either an error or warning message.
public GetErrorControls ( boolean $blnErrorsOnly = false ) : QControl[]
$blnErrorsOnly boolean Return controls that have just errors (otherwise, show both warnings and errors)
Résultat QControl[] an array of controls representing the (multiple) errors and warnings

GetErrorMessages() public méthode

Will return an array of Strings which will show all the error and warning messages in all the controls in the form.
public GetErrorMessages ( boolean $blnErrorsOnly = false ) : string[]
$blnErrorsOnly boolean Show only the errors (otherwise, show both warnings and errors)
Résultat string[] an array of strings representing the (multiple) errors and warnings

GetGrouping() public méthode

public GetGrouping ( $strGroupingId )

IsCheckableControlRendered() public méthode

public IsCheckableControlRendered ( $strControlId )

IsPollingActive() public méthode

Returns whether or not Polling is currently active
public IsPollingActive ( ) : boolean
Résultat boolean

IsPostBack() public méthode

Returns whether or not this Form is being run due to a PostBack event (e.g. a ServerAction or AjaxAction)
public IsPostBack ( ) : boolean
Résultat boolean

PersistControl() public méthode

public PersistControl ( $objControl )

Polling_Process() protected méthode

protected Polling_Process ( $strFormId, $strControlId, $strParameter )

PrepForVarExport() public méthode

public PrepForVarExport ( )

ProcessJavaScriptList() protected méthode

This WILL update the internal $strIncludedJavaScriptFileArray array.
protected ProcessJavaScriptList ( string $strJavaScriptFileList ) : string[]
$strJavaScriptFileList string
Résultat string[] array of script files to include or NULL if none

ProcessStyleSheetList() protected méthode

This WILL update the internal $strIncludedStyleSheetFileArray array.
protected ProcessStyleSheetList ( string $strStyleSheetFileList ) : string[]
$strStyleSheetFileList string
Résultat string[] array of stylesheet files to include or NULL if none

RemoveControl() public méthode

public RemoveControl ( $strControlId )

RemoveGrouping() public méthode

public RemoveGrouping ( $strGroupingId )

Render() protected méthode

protected Render ( )

RenderAjax() protected méthode

protected RenderAjax ( )

RenderAjaxHelper() protected méthode

protected RenderAjaxHelper ( $objControl )

RenderBegin() protected méthode

protected RenderBegin ( $blnDisplayOutput = true )

RenderChildren() protected méthode

protected RenderChildren ( $blnDisplayOutput = true )

RenderEnd() protected méthode

protected RenderEnd ( $blnDisplayOutput = true )

Run() public static méthode

public static Run ( $strFormId, $strAlternateHtmlFile = null )

Serialize() public static méthode

public static Serialize ( QForm $objForm ) : string
$objForm QForm
Résultat string the Serialized Form

SetCustomAttribute() public méthode

Allows you to set or clear custom attributes on the tag, itself, e.g. things like autocomplete=false, etc.
public SetCustomAttribute ( string $strName, string $strValue ) : void
$strName string the name of the attribute
$strValue string the value of the attribute, or NULL if you no longer want the attribute
Résultat void

SetPollingProcessor() public méthode

Adds polling to the QForm
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)
Résultat void

SetUrlHashProcessor() public méthode

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.
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)
Résultat void

TriggerActions() protected méthode

protected TriggerActions ( $strControlIdOverride = null )

TriggerMethod() public méthode

public TriggerMethod ( $strId, $strMethodName )

Unserialize() public static méthode

public static Unserialize ( $strPostDataState ) : Form
Résultat Form the Form object

UrlHashProxy_Process() protected méthode

protected UrlHashProxy_Process ( $strFormId, $strControlId, $strParameter )

ValidateControlAndChildren() protected méthode

protected ValidateControlAndChildren ( QControl $objControl )
$objControl QControl

__construct() protected méthode

This exists to prevent inadverant "New"
protected __construct ( )

__get() public méthode

public __get ( $strName )

__set() public méthode

public __set ( $strName, $mixValue )

Property Details

$EncryptionKey public_oe static_oe property

public static $EncryptionKey

$FormStateHandler public_oe static_oe property

public static $FormStateHandler

$blnRenderedBodyTag protected_oe property

protected $blnRenderedBodyTag

$blnRenderedCheckableControlArray protected_oe property

protected $blnRenderedCheckableControlArray

$intFormStatus protected_oe property

protected $intFormStatus

$intNextControlId protected_oe property

protected $intNextControlId

$objControlArray protected_oe property

protected $objControlArray

$objDefaultWaitIcon protected_oe property

protected $objDefaultWaitIcon

$objGroupingArray protected_oe property

protected $objGroupingArray

$objPersistentControlArray protected_oe property

protected $objPersistentControlArray

$strCallType protected_oe property

protected $strCallType

$strCssClass protected_oe property

protected $strCssClass

$strFormAttributeArray protected_oe property

protected $strFormAttributeArray

$strFormId protected_oe property

protected $strFormId

$strHtmlIncludeFilePath protected_oe property

protected $strHtmlIncludeFilePath

$strIgnoreJavaScriptFileArray protected_oe property

protected $strIgnoreJavaScriptFileArray

$strIgnoreStyleSheetFileArray protected_oe property

protected $strIgnoreStyleSheetFileArray

$strIncludedJavaScriptFileArray protected_oe property

protected $strIncludedJavaScriptFileArray

$strIncludedStyleSheetFileArray protected_oe property

protected $strIncludedStyleSheetFileArray

$strPreviousRequestMode protected_oe property

protected $strPreviousRequestMode

$strUrlHash protected_oe property

protected $strUrlHash