Warning: mysql_connect(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /home/zurmoorg/public_html/z-header.php on line 8

Deprecated: mysql_connect(): The mysql extension is deprecated and will be removed in the future: use mysqli or PDO instead in /home/zurmoorg/public_html/z-header.php on line 8

ExportJob Class Reference

Inheritance diagram for ExportJob:
BaseJob

Public Member Functions

 getTotalModelsProcessed ()
 run ()

Static Public Member Functions

static getDisplayName ()
static getType ()
static getRecommendedRunFrequencyContent ()

Protected Member Functions

 processExportItem (ExportItem $exportItem)
 processRedBeanModelDataProviderExport (ExportItem $exportItem, RedBeanModelDataProvider $dataProvider)
 processReportDataProviderExport (ExportItem $exportItem, ReportDataProvider $dataProvider)
 processMatrixReportDataProviderExport (ExportItem $exportItem, MatrixReportDataProvider $dataProvider)
 processIdsToExport (ExportItem $exportItem, $idsToExport)
 updateExportFileModelByExportItem ($content, ExportItem $exportItem)
 makeExportFileModelByContent ($content, $exportFileName)
 processInProgressExportItem (ExportItem $exportItem, ExportFileModel $exportFileModel, $offset)
 processCompletedExportItem (ExportItem $exportItem, ExportFileModel $exportFileModel)
 processCompletedWithSecurityExceptionExportItem (ExportItem $exportItem)
 processEndMemoryUsageMessage ($startTime)
 processExportPage (CDataProvider $dataProvider, $offset, &$headerData, &$data, $resolveForHeader)
 processReportExportPage (ReportDataProvider $dataProvider, $offset, &$headerData, &$data, $resolveForHeader)
 processExportModels (array $models, &$headerData, &$data, $resolveForHeader=true)
 runGarbageCollection ($model)
 getAsynchronousPageSize ()
 getAsynchronousMaximumModelsToProcess ()
 hasReachedMaximumProcessingCount ()
 addMaxmimumProcessingCountMessage (ExportItem $exportItem)
 addMaximumProcessingCountMessageForAllExportItems ()
 addMaximumMemoryUsageReachedForAllExportItems ()
 addMemoryMarkerMessageAfterPageIsProcessed ($startingMemoryUsage)
 getExportProcessCompletedNotificationRulesForExportItem (ExportItem $exportItem)

Protected Attributes

 $totalModelsProcessed = 0

Static Protected Attributes

static $loadJobQueueOnCleanupAndFallback = true

Detailed Description

For exports with many records we create jobs that will generate export file in background, and send notification to user with export download link, when export job is completed.

Definition at line 42 of file ExportJob.php.


Member Function Documentation

static getDisplayName (  )  [static]
Returns:
Translated label that describes this job type.

Reimplemented from BaseJob.

Definition at line 60 of file ExportJob.php.

static getType (  )  [static]
Returns:
The type of the NotificationRules

Reimplemented from BaseJob.

Definition at line 68 of file ExportJob.php.

static getRecommendedRunFrequencyContent (  )  [static]
Returns:
string

Reimplemented from BaseJob.

Definition at line 76 of file ExportJob.php.

getTotalModelsProcessed (  ) 
Returns:
int

Definition at line 84 of file ExportJob.php.

run (  ) 

After a Job is instantiated, the run method is called to execute the job.

Reimplemented from BaseJob.

Definition at line 92 of file ExportJob.php.

processExportItem ( ExportItem exportItem  )  [protected]
Parameters:
ExportItem $exportItem

Definition at line 157 of file ExportJob.php.

processRedBeanModelDataProviderExport ( ExportItem exportItem,
RedBeanModelDataProvider dataProvider 
) [protected]
Parameters:
ExportItem $exportItem
RedBeanModelDataProvider $dataProvider

Definition at line 186 of file ExportJob.php.

processReportDataProviderExport ( ExportItem exportItem,
ReportDataProvider dataProvider 
) [protected]
Parameters:
ExportItem $exportItem
ReportDataProvider $dataProvider

Definition at line 230 of file ExportJob.php.

processIdsToExport ( ExportItem exportItem,
idsToExport 
) [protected]
Parameters:
ExportItem $exportItem
$idsToExport 

Definition at line 286 of file ExportJob.php.

updateExportFileModelByExportItem ( content,
ExportItem exportItem 
) [protected]
Parameters:
$content 
ExportItem $exportItem
Returns:
A
Exceptions:
FailedToSaveModelException 

Definition at line 308 of file ExportJob.php.

makeExportFileModelByContent ( content,
exportFileName 
) [protected]
Parameters:
string $content
string $exportFileName
Returns:
ExportFileModel
Exceptions:
FailedToSaveModelException 

Definition at line 325 of file ExportJob.php.

processInProgressExportItem ( ExportItem exportItem,
ExportFileModel exportFileModel,
offset 
) [protected]
Parameters:
ExportItem $exportItem
ExportFileModel $exportFileModel
int $offset
Exceptions:
FailedToSaveModelException 

Definition at line 349 of file ExportJob.php.

processCompletedExportItem ( ExportItem exportItem,
ExportFileModel exportFileModel 
) [protected]
Parameters:
ExportItem $exportItem
ExportFileModel $exportFileModel
Exceptions:
FailedToSaveModelException 

Definition at line 366 of file ExportJob.php.

processCompletedWithSecurityExceptionExportItem ( ExportItem exportItem  )  [protected]
Parameters:
ExportItem $exportItem
Exceptions:
FailedToSaveModelException 

Definition at line 398 of file ExportJob.php.

processEndMemoryUsageMessage ( startTime  )  [protected]
Parameters:
integer $startTime

Definition at line 420 of file ExportJob.php.

processExportPage ( CDataProvider $  dataProvider,
offset,
&$  headerData,
&$  data,
resolveForHeader 
) [protected]
Parameters:
CDataProvider $dataProvider
int $offset
$headerData 
$data 
bool $resolveForHeader
Returns:
bool

Definition at line 443 of file ExportJob.php.

processExportModels ( array $  models,
&$  headerData,
&$  data,
resolveForHeader = true 
) [protected]
Parameters:
array $models
array $headerData
array $data
bool $resolveForHeader

Definition at line 500 of file ExportJob.php.

runGarbageCollection ( model  )  [protected]
Parameters:
$model 

Definition at line 523 of file ExportJob.php.

getAsynchronousPageSize (  )  [protected]
Returns:
int

Definition at line 540 of file ExportJob.php.

getAsynchronousMaximumModelsToProcess (  )  [protected]
Returns:
int

Definition at line 548 of file ExportJob.php.

hasReachedMaximumProcessingCount (  )  [protected]
Returns:
bool

Definition at line 556 of file ExportJob.php.

addMaxmimumProcessingCountMessage ( ExportItem exportItem  )  [protected]
Parameters:
ExportItem $exportItem

Definition at line 569 of file ExportJob.php.

addMemoryMarkerMessageAfterPageIsProcessed ( startingMemoryUsage  )  [protected]
Parameters:
int $startingMemoryUsage

Definition at line 596 of file ExportJob.php.

getExportProcessCompletedNotificationRulesForExportItem ( ExportItem exportItem  )  [protected]
Parameters:
ExportItem $exportItem
Returns:
ExportProcessCompletedNotificationRules

Definition at line 611 of file ExportJob.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Mar 25 07:10:51 2019

Warning: mysql_connect(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /home/zurmoorg/public_html/z-footer.php on line 8

Deprecated: mysql_connect(): The mysql extension is deprecated and will be removed in the future: use mysqli or PDO instead in /home/zurmoorg/public_html/z-footer.php on line 8