Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Attributes | Static Protected Attributes
BaseJob Class Reference
Inheritance diagram for BaseJob:
AddressGeocodeUpdateJob AutoresponderOrCampaignBaseJob CheckZurmoUpdatesJob ClearSentNotificationsEmailJob CurrencyRatesUpdateJob DraftEmailTemplateCleanupJob ExportCleanupJob ExportJob ImapBaseJob ImportCleanupJob InQueueJob JobLogCleanupJob ModelIntegrationIntegrityCheckJob MonitorJob ProcessOutboundEmailJob ReadPermissionSubscriptionUpdateJob SendGridEmailEventsJob ShortUrlCleanupJob TestJob TestOutboundEmailJob UpdateModelsLatestActivityDateTimeByMeetingJob WorkflowValidityCheckJob

Public Member Functions

 run ()
 
 getErrorMessage ()
 
 setMessageLogger (MessageLogger $messageLogger)
 
 getMessageLogger ()
 

Static Public Member Functions

static shouldLoadJobQueueOnCleanupAndFallback ()
 
static getDisplayName ()
 
static getType ()
 
static resolveJobsForQueue ()
 
static loadJobQueue ()
 
static getRecommendedRunFrequencyContent ()
 
static getDefaultMessageLogger ()
 
static getRunTimeThresholdInSeconds ()
 
static showInJobManagerToRunManually ()
 
static jobExecutionInQueueDependsOnTime ()
 

Data Fields

const JOB_QUEUE_PAGE_SIZE = 100
 

Protected Attributes

 $errorMessage
 

Static Protected Attributes

static $loadJobQueueOnCleanupAndFallback = false
 

Detailed Description

Base class for making Jobs. Jobs can be run on a scheduled basis. An example job would be a job that removes old import tables.

Definition at line 41 of file BaseJob.php.

Member Function Documentation

run ( )
abstract

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

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

Definition at line 79 of file BaseJob.php.

static getType ( )
static
Returns
The type of the NotificationRules

Definition at line 87 of file BaseJob.php.

static resolveJobsForQueue ( )
static

Call to override if needed to have additional logic to load jobs up in the queue. This is utilized when first enabling job queues and cleaning up jobs that need to be queued up

Definition at line 96 of file BaseJob.php.

static getRecommendedRunFrequencyContent ( )
static
Returns
string content specifying how often this job should be run as a scheduled task.

Definition at line 109 of file BaseJob.php.

static getDefaultMessageLogger ( )
static
Returns
string content specifying the Message Logger Class Name.

Definition at line 117 of file BaseJob.php.

getErrorMessage ( )
Returns
error message string otherwise returns null if not populated.

Definition at line 125 of file BaseJob.php.

static getRunTimeThresholdInSeconds ( )
static
Returns
the threshold for how long a job is allowed to run. This is the 'threshold'. If a job is running longer than the threshold, the monitor job might take action on it since it would be considered 'stuck'.

Definition at line 135 of file BaseJob.php.

static showInJobManagerToRunManually ( )
static
Returns
bool if the job should appear in Job Manager list to be run manually.

Definition at line 157 of file BaseJob.php.

static jobExecutionInQueueDependsOnTime ( )
static

Used for determining if job should be executed at exact time or latter For example CampaignGenerateDueCampaignItems need to be executed at exact time or latter to trigger some actions This is used in JobQueues

Returns
bool

Definition at line 168 of file BaseJob.php.

Field Documentation

const JOB_QUEUE_PAGE_SIZE = 100

When calling resolveJobsForQueue() to loading existing items into the jobQueue, how many to page at a time

Definition at line 46 of file BaseJob.php.


The documentation for this class was generated from the following file:
Generated on Tue Jul 14 2020 07:10:40
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.