StuckJob Class Reference

Inheritance diagram for StuckJob:
RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()

Static Public Member Functions

static getByType ($type)
static getDefaultMetadata ()
static isTypeDeletable ()

Static Protected Member Functions

static translatedAttributeLabels ($language)
static getLabel ($language=null)
static getPluralLabel ($language=null)

Detailed Description

A model to store information about jobs that are stuck. If a job is stuck 5 times in a row when it runs then it will store the job type and quantity 5. This does not mean if 'an existing job is detected', this means if it is reset from being stuck and gets stuck 5 times in a row before running successfully again.

Definition at line 42 of file StuckJob.php.


Member Function Documentation

static getByType ( type  )  [static]
Parameters:
string $type
Returns:
mixed
Exceptions:
NotFoundException 

Definition at line 49 of file StuckJob.php.

__toString (  ) 

Returns the displayable string for the class. Should be overridden in any model that can provide a meaningful string representation of itself.

Returns:
A string.

Reimplemented from RedBeanModel.

Definition at line 77 of file StuckJob.php.

static getDefaultMetadata (  )  [static]

Returns the default meta data for the class. It must be appended to the meta data from the parent model, if any.

Reimplemented from RedBeanModel.

Definition at line 86 of file StuckJob.php.

static isTypeDeletable (  )  [static]

To be overriden on intermediate derived classes to return false so that deletes are not done on intermediate classes because the object relational mapping will not clean up properly. For example if User is a Person, and Person is a RedBeanModel delete should be called only on User, not on Person. So User must override isDeletable to return false.

Reimplemented from RedBeanModel.

Definition at line 109 of file StuckJob.php.

static getLabel ( language = null  )  [static, protected]

Returns the display name for the model class.

Parameters:
null | string $language
Returns:
dynamic label name based on module.

Reimplemented from RedBeanModel.

Definition at line 129 of file StuckJob.php.

static getPluralLabel ( language = null  )  [static, protected]

Returns the display name for plural of the model class.

Parameters:
null | string $language
Returns:
dynamic label name based on module.

Reimplemented from RedBeanModel.

Definition at line 139 of file StuckJob.php.


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