JobLog Class Reference

Inheritance diagram for JobLog:
Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()
 validateIsProcessedIsSet ()

Static Public Member Functions

static getByType ($type, $pageSize=null, $orderBy=null)
static getDefaultMetadata ()
static isTypeDeletable ()

Data Fields

const STATUS_COMPLETE_WITHOUT_ERROR = 1
const STATUS_COMPLETE_WITH_ERROR = 2

Static Protected Member Functions

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

Protected Attributes

 $isAudited = false

Detailed Description

A class to store historical information on past jobs that have run.

Definition at line 40 of file JobLog.php.


Member Function Documentation

__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 60 of file JobLog.php.

static getByType ( type,
pageSize = null,
orderBy = null 
) [static]
Parameters:
$type 
null $pageSize
null $orderBy
Returns:
An

Definition at line 75 of file JobLog.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 93 of file JobLog.php.

validateIsProcessedIsSet (  ) 

Because isProcessed is a boolean attribute, disallow if the value is not specified. We do not want NULL values in the database for this attribute.

Definition at line 133 of file JobLog.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 141 of file JobLog.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 151 of file JobLog.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 161 of file JobLog.php.


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