PHP Class EventType

Mostra file Open project: openeyes/openeyes Class Usage Examples

Public Methods

Method Description
attributeLabels ( ) : array
getActiveList ( ) * get list data of all the event types that are currently enabled on the instance
getAllElementTypes ( ) : BaseEventTypeElement[] Get all the element types that are defined for this event type.
getApi ( ) : mixed Return the module api for this event type.
getDefaultElements ( )
getDisabled ( ) : boolean Check if the event type is disabled.
getDisabled_detail ( ) : string String to display detailed information about a disabled event type (note this method assumes the event type is disabled, this should be checked with the disabled attribute).
getDisabled_title ( ) : string string to display for the event type when it's disabled (note this method assumes the event type is disabled, this should be checked with the disabled attribute).
getEventTypeInUseList ( ) : array get list data of all the event types for which >0 events exist.
getEventTypeModules ( ) : EventType[] Get all the event types for the modules that are currently enabled (and aren't legacy).
getEvent_group ( ) : CActiveRecord Get the EventGroup for the module of the event type (as defined by the second camelcase section of the module name).
getParentEventTypes ( ) : EventType[] Returns the parent(s) of this event type.
getSpecialty ( ) : Specialty Get the Specialty for this event type (as defined by the first camelcase section of the module name).
model ( $className = __CLASS__ ) : EventType Returns the static model of the specified AR class.
registerShortCode ( $code, $method, boolean $description = false ) Register a short code for this event type.
relations ( ) : array
rules ( ) : array
search ( ) : CActiveDataProvider Retrieves a list of models based on the current search/filter conditions.
tableName ( ) : string

Method Details

attributeLabels() public method

public attributeLabels ( ) : array
return array customized attribute labels (name=>label)

getActiveList() public method

* get list data of all the event types that are currently enabled on the instance
public getActiveList ( )

getAllElementTypes() public method

Get all the element types that are defined for this event type.
public getAllElementTypes ( ) : BaseEventTypeElement[]
return BaseEventTypeElement[]

getApi() public method

Return the module api for this event type.
public getApi ( ) : mixed
return mixed

getDefaultElements() public method

public getDefaultElements ( )

getDisabled() public method

Check if the event type is disabled.
public getDisabled ( ) : boolean
return boolean

getDisabled_detail() public method

String to display detailed information about a disabled event type (note this method assumes the event type is disabled, this should be checked with the disabled attribute).
public getDisabled_detail ( ) : string
return string

getDisabled_title() public method

string to display for the event type when it's disabled (note this method assumes the event type is disabled, this should be checked with the disabled attribute).
public getDisabled_title ( ) : string
return string

getEventTypeInUseList() public method

get list data of all the event types for which >0 events exist.
public getEventTypeInUseList ( ) : array
return array

getEventTypeModules() public method

Get all the event types for the modules that are currently enabled (and aren't legacy).
public getEventTypeModules ( ) : EventType[]
return EventType[]

getEvent_group() public method

Get the EventGroup for the module of the event type (as defined by the second camelcase section of the module name).
public getEvent_group ( ) : CActiveRecord
return CActiveRecord

getParentEventTypes() public method

Returns the parent(s) of this event type.
public getParentEventTypes ( ) : EventType[]
return EventType[]

getSpecialty() public method

Get the Specialty for this event type (as defined by the first camelcase section of the module name).
public getSpecialty ( ) : Specialty
return Specialty

model() public static method

Returns the static model of the specified AR class.
public static model ( $className = __CLASS__ ) : EventType
return EventType the static model class

registerShortCode() public method

Register a short code for this event type.
public registerShortCode ( $code, $method, boolean $description = false )
$code
$method
$description boolean

relations() public method

public relations ( ) : array
return array relational rules.

rules() public method

public rules ( ) : array
return array validation rules for model attributes.

tableName() public method

public tableName ( ) : string
return string the associated database table name