PHP Класс QFormBase, qcodo

Наследование: extends QBaseClass
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$EncryptionKey
$FormStateHandler

Защищенные свойства (Protected)

Свойство Тип Описание
$blnRenderedBodyTag
$blnRenderedCheckableControlArray
$intFormStatus
$intNextControlId
$objControlArray
$objDefaultWaitIcon
$objGroupingArray
$objPersistentControlArray
$strCallType
$strCssClass
$strFormAttributeArray
$strFormId
$strHtmlIncludeFilePath
$strIgnoreJavaScriptFileArray
$strIgnoreStyleSheetFileArray
$strIncludedJavaScriptFileArray
$strIncludedStyleSheetFileArray
$strPreviousRequestMode
$strUrlHash

Открытые методы

Метод Описание
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 )

Защищенные методы

Метод Описание
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"

Описание методов

AddControl() публичный Метод

public AddControl ( QControl $objControl )
$objControl QControl

AddGrouping() публичный Метод

public AddGrouping ( QControlGrouping $objGrouping )
$objGrouping QControlGrouping

CallDataBinder() публичный Метод

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

ClearPollingProcessor() публичный Метод

Stops polling of polling processor
public ClearPollingProcessor ( ) : void
Результат void

ClearUrlHashProcessor() публичный Метод

Stops polling of URL hash processor
public ClearUrlHashProcessor ( ) : void
Результат void

EvaluateTemplate() публичный Метод

public EvaluateTemplate ( $strTemplate )

Form_Create() защищенный Метод

protected Form_Create ( )

Form_Exit() защищенный Метод

protected Form_Exit ( )

Form_Load() защищенный Метод

protected Form_Load ( )

Form_PreRender() защищенный Метод

protected Form_PreRender ( )

Form_Run() защищенный Метод

protected Form_Run ( )

Form_Validate() защищенный Метод

protected Form_Validate ( )

GenerateControlId() публичный Метод

public GenerateControlId ( )

GetAllControls() публичный Метод

public GetAllControls ( )

GetAllGroupings() публичный Метод

public GetAllGroupings ( )

GetChildControls() публичный Метод

public GetChildControls ( $objParentObject )

GetControl() публичный Метод

public GetControl ( $strControlId )

GetCustomAttribute() публичный Метод

Looks up the custom attribute by name, returning NULL if not set
public GetCustomAttribute ( string $strName ) : string
$strName string
Результат string

GetErrorControls() публичный Метод

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)
Результат QControl[] an array of controls representing the (multiple) errors and warnings

GetErrorMessages() публичный Метод

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)
Результат string[] an array of strings representing the (multiple) errors and warnings

GetGrouping() публичный Метод

public GetGrouping ( $strGroupingId )

IsCheckableControlRendered() публичный Метод

public IsCheckableControlRendered ( $strControlId )

IsPollingActive() публичный Метод

Returns whether or not Polling is currently active
public IsPollingActive ( ) : boolean
Результат boolean

IsPostBack() публичный Метод

Returns whether or not this Form is being run due to a PostBack event (e.g. a ServerAction or AjaxAction)
public IsPostBack ( ) : boolean
Результат boolean

PersistControl() публичный Метод

public PersistControl ( $objControl )

Polling_Process() защищенный Метод

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

PrepForVarExport() публичный Метод

public PrepForVarExport ( )

ProcessJavaScriptList() защищенный Метод

This WILL update the internal $strIncludedJavaScriptFileArray array.
protected ProcessJavaScriptList ( string $strJavaScriptFileList ) : string[]
$strJavaScriptFileList string
Результат string[] array of script files to include or NULL if none

ProcessStyleSheetList() защищенный Метод

This WILL update the internal $strIncludedStyleSheetFileArray array.
protected ProcessStyleSheetList ( string $strStyleSheetFileList ) : string[]
$strStyleSheetFileList string
Результат string[] array of stylesheet files to include or NULL if none

RemoveControl() публичный Метод

public RemoveControl ( $strControlId )

RemoveGrouping() публичный Метод

public RemoveGrouping ( $strGroupingId )

Render() защищенный Метод

protected Render ( )

RenderAjax() защищенный Метод

protected RenderAjax ( )

RenderAjaxHelper() защищенный Метод

protected RenderAjaxHelper ( $objControl )

RenderBegin() защищенный Метод

protected RenderBegin ( $blnDisplayOutput = true )

RenderChildren() защищенный Метод

protected RenderChildren ( $blnDisplayOutput = true )

RenderEnd() защищенный Метод

protected RenderEnd ( $blnDisplayOutput = true )

Run() публичный статический Метод

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

Serialize() публичный статический Метод

public static Serialize ( QForm $objForm ) : string
$objForm QForm
Результат string the Serialized Form

SetCustomAttribute() публичный Метод

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
Результат void

SetPollingProcessor() публичный Метод

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)
Результат void

SetUrlHashProcessor() публичный Метод

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)
Результат void

TriggerActions() защищенный Метод

protected TriggerActions ( $strControlIdOverride = null )

TriggerMethod() публичный Метод

public TriggerMethod ( $strId, $strMethodName )

Unserialize() публичный статический Метод

public static Unserialize ( $strPostDataState ) : Form
Результат Form the Form object

UrlHashProxy_Process() защищенный Метод

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

ValidateControlAndChildren() защищенный Метод

protected ValidateControlAndChildren ( QControl $objControl )
$objControl QControl

__construct() защищенный Метод

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

__get() публичный Метод

public __get ( $strName )

__set() публичный Метод

public __set ( $strName, $mixValue )

Описание свойств

$EncryptionKey публичное статическое свойство

public static $EncryptionKey

$FormStateHandler публичное статическое свойство

public static $FormStateHandler

$blnRenderedBodyTag защищенное свойство

protected $blnRenderedBodyTag

$blnRenderedCheckableControlArray защищенное свойство

protected $blnRenderedCheckableControlArray

$intFormStatus защищенное свойство

protected $intFormStatus

$intNextControlId защищенное свойство

protected $intNextControlId

$objControlArray защищенное свойство

protected $objControlArray

$objDefaultWaitIcon защищенное свойство

protected $objDefaultWaitIcon

$objGroupingArray защищенное свойство

protected $objGroupingArray

$objPersistentControlArray защищенное свойство

protected $objPersistentControlArray

$strCallType защищенное свойство

protected $strCallType

$strCssClass защищенное свойство

protected $strCssClass

$strFormAttributeArray защищенное свойство

protected $strFormAttributeArray

$strFormId защищенное свойство

protected $strFormId

$strHtmlIncludeFilePath защищенное свойство

protected $strHtmlIncludeFilePath

$strIgnoreJavaScriptFileArray защищенное свойство

protected $strIgnoreJavaScriptFileArray

$strIgnoreStyleSheetFileArray защищенное свойство

protected $strIgnoreStyleSheetFileArray

$strIncludedJavaScriptFileArray защищенное свойство

protected $strIncludedJavaScriptFileArray

$strIncludedStyleSheetFileArray защищенное свойство

protected $strIncludedStyleSheetFileArray

$strPreviousRequestMode защищенное свойство

protected $strPreviousRequestMode

$strUrlHash защищенное свойство

protected $strUrlHash