SavedReport Class Reference

Inheritance diagram for SavedReport:
OwnedSecurableItem SecurableItem Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()

Static Public Member Functions

static getByName ($name)
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()
static getModuleClassName ()
static hasReadPermissionsOptimization ()
static getGamificationRulesType ()

Static Protected Member Functions

static translatedAttributeLabels ($language)

Detailed Description

Model for saving a report definition. This does not save report results, but only the definition of how a report should act when run. Most information is defined as serializedData.

See also:
Report model which is used to interact with most report components views.

Definition at line 42 of file SavedReport.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 44 of file SavedReport.php.

static getByName ( name  )  [static]

Gets by name

Parameters:
string $name
Returns:
string

Reimplemented from Item.

Definition at line 53 of file SavedReport.php.

static canSaveMetadata (  )  [static]

By default models cannot save their metadata, allowing them to be loaded quickly because the loading of of metadata can be avoided as much as possible. To make a model able to save its metadata override this method to return true. PUT it before the getDefaultMetadata in the derived class.

Reimplemented from RedBeanModel.

Definition at line 59 of file SavedReport.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 OwnedSecurableItem.

Definition at line 64 of file SavedReport.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 OwnedSecurableItem.

Definition at line 97 of file SavedReport.php.

static hasReadPermissionsOptimization (  )  [static]

Override on any models you want to utilize ReadPermissionsOptimization

Reimplemented from SecurableItem.

Definition at line 107 of file SavedReport.php.

static getGamificationRulesType (  )  [static]
Returns:
string of gamificationRulesType Override for a child class as needed.

Reimplemented from Item.

Definition at line 123 of file SavedReport.php.


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