All Data Structures Functions Variables Pages
Public Member Functions | Protected Member Functions | Protected Attributes
ProgressView Class Reference
Inheritance diagram for ProgressView:
View MassProgressView RebuildSecurityCacheProgressView MassDeleteProgressView MassEditProgressView MarketingListMembersMassUnsubscribeProgressView MassSubscribeProgressView

Public Member Functions

 __construct ($controllerId, $moduleId, $model, $totalRecordCount, $start, $pageSize, $page, $refreshActionId, $title)
 
 renderRefreshJSONScript ()
 
 renderRefreshScript ()
 
- Public Member Functions inherited from View
 isUniqueToAPage ()
 
 render ()
 
 setCssClasses (array $classes)
 
 getCssClasses ()
 
 getTitle ()
 
 getPostTruncatedTitleContent ()
 

Protected Member Functions

 headerLabelPrefixContent ()
 
 renderContent ()
 
 getCreateProgressBarAjax ($progressBarId)
 
 getProgressValue ()
 
 getEndSize ()
 
 onProgressComplete ()
 
- Protected Member Functions inherited from View
 resolveDefaultClasses ()
 
 renderContainerWrapperId ()
 
 getContainerWrapperTag ()
 
 getId ()
 
 renderContent ()
 
 getViewStyle ()
 
 renderTitleContent ()
 
 resolveCustomViewTemplateFileName ($theme, $view)
 

Protected Attributes

 $totalRecordCount
 
 $pageSize
 
 $progressBarId
 
- Protected Attributes inherited from View
 $cssClasses = array()
 
 $title
 
 $makeDefaultClassesFromClassHeirarchy = true
 

Detailed Description

Progress view is an abstraction used for processes that occur in phases. This includes import, export, and mass edit as examples. Allows for an automatic loop of server calls using Ajax until a process is complete.

Definition at line 43 of file ProgressView.php.

Constructor & Destructor Documentation

__construct (   $controllerId,
  $moduleId,
  $model,
  $totalRecordCount,
  $start,
  $pageSize,
  $page,
  $refreshActionId,
  $title 
)

Constructs a mass edit progress view specifying the controller as well as the model that will have its mass edit displayed.

Definition at line 66 of file ProgressView.php.

Member Function Documentation

renderRefreshJSONScript ( )

Returns JSON encoded script utilized on AJAX call by ProgressView Return has three elements in the array callback, value, and message

Definition at line 95 of file ProgressView.php.

onProgressComplete ( )
protected

Override if you have a specific action to perform when the progress is completed.

Definition at line 205 of file ProgressView.php.

Field Documentation

$totalRecordCount
protected

How many total records need to be processed in the batch

Definition at line 50 of file ProgressView.php.

$pageSize
protected

How many records to process per ajax call.

Definition at line 55 of file ProgressView.php.

$progressBarId
protected

Unique identifier for the progress bar widget that is displayed

Definition at line 60 of file ProgressView.php.


The documentation for this class was generated from the following file:
Generated on Sat Mar 28 2020 07:11:16