ZurmoModule Class Reference

Inheritance diagram for ZurmoModule:
SecurableModule Module

Public Member Functions

 canDisable ()
 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

static getTranslatedRightsLabels ()
static getDefaultMetadata ()
static stringifyAuditEvent (AuditEvent $auditEvent, $format= 'long')
static getDemoDataMakerClassNames ()
static getDefaultDataMakerClassName ()
static getLastAttemptedInfoUpdateTimeStamp ()
static setLastAttemptedInfoUpdateTimeStamp ()
static getLastZurmoStableVersion ()
static setLastZurmoStableVersion ($zurmoVersion)
static checkAndUpdateZurmoInfo ($forceCheck=false)

Data Fields

const ADMINISTRATION_CATEGORY_GENERAL = 1
const ADMINISTRATION_CATEGORY_AUTHENTICATION = 2
const ADMINISTRATION_CATEGORY_PLUGINS = 3
const RIGHT_ACCESS_ADMINISTRATION = 'Access Administration Tab'
const RIGHT_BULK_WRITE = 'Mass Update'
const RIGHT_ACCESS_GLOBAL_CONFIGURATION = 'Access Global Configuration'
const RIGHT_ACCESS_CURRENCY_CONFIGURATION = 'Access Currency Configuration'
const RIGHT_BULK_DELETE = 'Mass Delete'
const RIGHT_BULK_MERGE = 'Mass Merge'
const AUDIT_EVENT_ITEM_CREATED = 'Item Created'
const AUDIT_EVENT_ITEM_MODIFIED = 'Item Modified'
const AUDIT_EVENT_ITEM_DELETED = 'Item Deleted'
const AUDIT_EVENT_ITEM_VIEWED = 'Item Viewed'

Static Protected Member Functions

static getSingularModuleLabel ($language)
static getPluralModuleLabel ($language)

Detailed Description

Definition at line 37 of file ZurmoModule.php.


Member Function Documentation

canDisable (  ) 

Returns whether the module is can be disabled. Modules that must not be disabled must override and return false.

Reimplemented from Module.

Definition at line 69 of file ZurmoModule.php.

getDependencies (  ) 

Returns an array of the names of the the modules the module depends on. ie: if the module is enabled then those modules must be too, recursively through their dependencies.

Reimplemented from Module.

Definition at line 74 of file ZurmoModule.php.

getRootModelNames (  ) 

Implement in all modules that have models. The root models are the models that if they are created, then their related models are created, and so on recursively, then all of module's models will have been created, allowing RedBean to create all of the required tables and columns.

Reimplemented from Module.

Definition at line 79 of file ZurmoModule.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 Module.

Definition at line 91 of file ZurmoModule.php.

static getDemoDataMakerClassNames (  )  [static]

Override in modules that create demo data during an installation.

Reimplemented from Module.

Definition at line 260 of file ZurmoModule.php.

static getDefaultDataMakerClassName (  )  [static]

Override in modules that create default data during an installation.

Reimplemented from Module.

Definition at line 265 of file ZurmoModule.php.

static getLastAttemptedInfoUpdateTimeStamp (  )  [static]

When updates info are pulled from zurmo home.

Returns:
$lastAttemptedInfoUpdateTimeStamp

Definition at line 274 of file ZurmoModule.php.

static setLastAttemptedInfoUpdateTimeStamp (  )  [static]

Set $lastAttemptedInfoUpdateTimeStamp global configuration. This function is called during execution of ZurmoModule::checkAndUpdateZurmoInfo()

Definition at line 284 of file ZurmoModule.php.

static getLastZurmoStableVersion (  )  [static]

Get last Zurmo Stable version from global configuration property.

Definition at line 292 of file ZurmoModule.php.

static setLastZurmoStableVersion ( zurmoVersion  )  [static]

Set lastZurmoStableVersion global pconfiguration property.

Parameters:
string $zurmoVersion

Definition at line 302 of file ZurmoModule.php.

static checkAndUpdateZurmoInfo ( forceCheck = false  )  [static]

Check if available zurmo updates has been checked within the last 7 days. If not, then perform update and update the lastAttemptedInfoUpdateTimeStamp and lastZurmoStableVersion global configuration properties.

Parameters:
boolean $forceCheck - If true, it will ignore the last time the check was made

Definition at line 314 of file ZurmoModule.php.

static getSingularModuleLabel ( language  )  [static, protected]

Zurmo is a special case, where the module label is always the label of the application

Parameters:
string $language
Returns:
string

Reimplemented from Module.

Definition at line 372 of file ZurmoModule.php.

static getPluralModuleLabel ( language  )  [static, protected]

Zurmo is a special case, where the module label is always the label of the application and is always singular

Parameters:
string $language
Returns:
string

Reimplemented from Module.

Definition at line 382 of file ZurmoModule.php.


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