JobInProcess Class Reference

Inheritance diagram for JobInProcess:
Item CustomFieldsModel 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)

Protected Attributes

 $isAudited = false

Detailed Description

A model to store information about jobs that are currently running.

Definition at line 40 of file JobInProcess.php.


Member Function Documentation

static getByType ( type  )  [static]

if count is greater than 1, return first, since then eventually this will clean out the jobs in process over time.

Parameters:
string $type
Returns:
mixed
Exceptions:
NotFoundException 

Definition at line 54 of file JobInProcess.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 80 of file JobInProcess.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 Item.

Definition at line 89 of file JobInProcess.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 Item.

Definition at line 107 of file JobInProcess.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 126 of file JobInProcess.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 136 of file JobInProcess.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Sep 25 07:10:26 2017