WizardView Class Reference

Inheritance diagram for WizardView:
View EmailTemplateWizardView ReportWizardView WorkflowWizardView BuilderEmailTemplateWizardView ClassicEmailTemplateWizardView MatrixReportWizardView RowsAndColumnsReportWizardView SummationReportWizardView ByTimeWorkflowWizardView OnSaveWorkflowWizardView RowsAndColumnsReportForSavedCalendarWizardView

Public Member Functions

 __construct (WizardForm $model, $isBeingCopied=false)
 isUniqueToAPage ()

Static Public Member Functions

static getFormId ()
static getModuleId ()
static getControllerId ()
static renderTreeViewAjaxScriptContent ($formName, $componentViewClassName, $reportType)

Protected Member Functions

 registerClickFlowScript ()
 renderContainingViews (WizardActiveForm $form)
 renderConfigSaveAjax ($formName)
 renderContent ()
 renderForm ()
 renderUIOverLayBlock ()
 renderAfterFormContent ()
 getClientOptions ()
 getBeforeValidateActionScript ()
 registerScripts ()
 registerCss ()
 getFormActionUrl ()
 getSaveAjaxString ($formName, $redirectAfterSave=true, array $additionalAjaxOptions=array())
 resolveSaveAjaxArray ($formName, $redirectAfterSave=true, array $additionalAjaxOptions=array())
 resolveSaveRedirectToDetailsUrl ()
 resolveSaveRedirectToListUrl ()
 registerOperatorOnLoadAndOnChangeScript ()
 renderModalContainer ()

Static Protected Member Functions

static renderValidationScenarioInputContent ()
static getStartingValidationScenario ()
static getValidationScenarioInputId ()

Protected Attributes

 $model
 $isBeingCopied

Detailed Description

Base class for working with the wizard based user interfaces such as reporting and workflow

Definition at line 40 of file WizardView.php.


Constructor & Destructor Documentation

__construct ( WizardForm model,
isBeingCopied = false 
)
Parameters:
WizardForm $model
bool $isBeingCopied

Definition at line 136 of file WizardView.php.


Member Function Documentation

registerClickFlowScript (  )  [abstract, protected]
renderConfigSaveAjax ( formName  )  [abstract, protected]
static getFormId (  )  [static]
Returns:
string

Definition at line 73 of file WizardView.php.

static getModuleId (  )  [static]

Override in children with correct moduleId

Exceptions:
NotImplementedException 

Reimplemented in RowsAndColumnsReportForSavedCalendarWizardView, EmailTemplateWizardView, ReportWizardView, and WorkflowWizardView.

Definition at line 82 of file WizardView.php.

static getControllerId (  )  [static]

Override in children with correct controllerId

Exceptions:
NotImplementedException 

Reimplemented in RowsAndColumnsReportForSavedCalendarWizardView.

Definition at line 91 of file WizardView.php.

static renderTreeViewAjaxScriptContent ( formName,
componentViewClassName,
reportType 
) [static]
Parameters:
string $formName
string $componentViewClassName
string $reportType
Returns:
string

Definition at line 102 of file WizardView.php.

isUniqueToAPage (  ) 
Returns:
bool

Reimplemented from View.

Definition at line 146 of file WizardView.php.

static renderValidationScenarioInputContent (  )  [static, protected]
Returns:
string

Definition at line 154 of file WizardView.php.

static getStartingValidationScenario (  )  [static, protected]

Override in children classes. Should

Returns:
string
Exceptions:
NotImplementedException 

Reimplemented in EmailTemplateWizardView, ReportWizardView, and WorkflowWizardView.

Definition at line 165 of file WizardView.php.

static getValidationScenarioInputId (  )  [static, protected]
Returns:
string

Definition at line 173 of file WizardView.php.

renderContent (  )  [protected]
Returns:
string

Reimplemented from View.

Definition at line 181 of file WizardView.php.

renderForm (  )  [protected]
Returns:
string

Definition at line 192 of file WizardView.php.

getClientOptions (  )  [protected]
Returns:
array

Definition at line 232 of file WizardView.php.

getBeforeValidateActionScript (  )  [protected]

The script to be triggered before validation action

See also:
WizardView::getClientOptions
Returns:
string

Reimplemented in BuilderEmailTemplateWizardView.

Definition at line 248 of file WizardView.php.

getFormActionUrl (  )  [protected]
Returns:
mixed

Reimplemented in EmailTemplateWizardView.

Definition at line 269 of file WizardView.php.

getSaveAjaxString ( formName,
redirectAfterSave = true,
array $  additionalAjaxOptions = array() 
) [protected]
Parameters:
$formName 
bool $redirectAfterSave
array $additionalAjaxOptions
Returns:
string

Definition at line 281 of file WizardView.php.

resolveSaveAjaxArray ( formName,
redirectAfterSave = true,
array $  additionalAjaxOptions = array() 
) [protected]
Parameters:
$formName 
bool $redirectAfterSave
array $additionalAjaxOptions
Returns:
array

Definition at line 294 of file WizardView.php.

resolveSaveRedirectToDetailsUrl (  )  [protected]
Returns:
string

Definition at line 324 of file WizardView.php.

resolveSaveRedirectToListUrl (  )  [protected]
Returns:
string

Reimplemented in EmailTemplateWizardView.

Definition at line 332 of file WizardView.php.


Field Documentation

bool $isBeingCopied [protected]

whether the model is being copied to 'Save As' or not.

Definition at line 51 of file WizardView.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Fri Nov 24 07:10:30 2017