PHP Class BaseEventTypeElement

Inheritance: extends BaseElement
Afficher le fichier Open project: openeyes/openeyes Class Usage Examples

Méthodes publiques

Свойство Type Description
$firm
$patientId
$useContainerView
$userId

Protected Properties

Свойство Type Description
$_children
$_element_type
$errorExceptions
$frontEndErrors

Méthodes publiques

Méthode Description
addError ( $attribute, $message )
canCopy ( ) : boolean Can this element be copied (cloned/duplicated) Override to return true if you want an element to be copyable.
canViewPrevious ( ) : boolean Can we view the previous version of this element.
getChildElementTypes ( ) : ElementType[] get the child element types for this BaseEventElementType.
getChildren ( ) : array Return this elements children.
getContainer_create_view ( )
getContainer_form_view ( )
getContainer_print_view ( )
getContainer_update_view ( )
getContainer_view_view ( )
getCreate_view ( )
getDefaultContainerView ( )
getDefaultView ( )
getElementType ( ) : ElementType Get the ElementType for this element.
getElementTypeName ( ) : string Return the element type name.
getForm_View ( )
getFrontEndErrors ( ) returns the front-end attributes with errors.
getInfoText ( )
getPrint_view ( )
getSetting ( $key )
getUpdate_view ( )
getView_view ( )
hasMultiSelectValue ( $relation, $value_string ) Returns true if the specified multiselect relation has the value $value_string.
isEditable ( )
isHiddenInUI ( ) : boolean Is this element to be hidden in the UI? (Prevents the elements from being displayed on page load.).
isRequired ( ) : boolean Is this a required element?
isRequiredInUI ( ) : boolean Is this element required in the UI? (Prevents the user from being able to remove the element.).
loadFromExisting ( BaseEventTypeElement $element ) Load an existing element's data into this one The base implementation simply uses copiedFields(), but it may be overridden to allow for more complex relationships.
render ( $action )
requiredIfSide ( $attribute, $params )
setChildren ( BaseEventTypeElement[] $children ) set the children for this element - allows external definition of what the children should be (for workflows determined by controllers and the like.
setDefaultOptions ( ) Stubbed method to set default options Used by child objects to set defaults for forms on create.
setUpdateOptions ( ) Stubbed method to set update options Used by child objects to override null values for forms on update.
softDelete ( ) stub method to allow elements to carry out actions related to being a part of a soft deleted event.
updateMultiSelectData ( $model, $ids, $relation_field ) Updates multiselect items in the database, deleting items not passed in $ids.

Méthodes protégées

Méthode Description
copiedFields ( ) : array: Fields which are copied by the loadFromExisting() method By default these are taken from the "safe" scenario of the model rules, but should be overridden for more complex requirements.
errorAttributeException ( $attribute ) : mixed Allows for exceptions where the element displayed is not the one required. eg for ajax control elements.

Method Details

addError() public méthode

public addError ( $attribute, $message )

canCopy() public méthode

Can this element be copied (cloned/duplicated) Override to return true if you want an element to be copyable.
public canCopy ( ) : boolean
Résultat boolean

canViewPrevious() public méthode

Can we view the previous version of this element.
public canViewPrevious ( ) : boolean
Résultat boolean

copiedFields() protected méthode

Fields which are copied by the loadFromExisting() method By default these are taken from the "safe" scenario of the model rules, but should be overridden for more complex requirements.
protected copiedFields ( ) : array:
Résultat array:

errorAttributeException() protected méthode

Allows for exceptions where the element displayed is not the one required. eg for ajax control elements.
protected errorAttributeException ( $attribute ) : mixed
$attribute
Résultat mixed

getChildElementTypes() public méthode

get the child element types for this BaseEventElementType.
public getChildElementTypes ( ) : ElementType[]
Résultat ElementType[]

getChildren() public méthode

Return this elements children.
public getChildren ( ) : array
Résultat array

getContainer_create_view() public méthode

public getContainer_create_view ( )

getContainer_form_view() public méthode

public getContainer_form_view ( )

getContainer_print_view() public méthode

public getContainer_print_view ( )

getContainer_update_view() public méthode

public getContainer_update_view ( )

getContainer_view_view() public méthode

public getContainer_view_view ( )

getCreate_view() public méthode

public getCreate_view ( )

getDefaultContainerView() public méthode

public getDefaultContainerView ( )

getDefaultView() public méthode

public getDefaultView ( )

getElementType() public méthode

Get the ElementType for this element.
public getElementType ( ) : ElementType
Résultat ElementType

getElementTypeName() public méthode

Return the element type name.
public getElementTypeName ( ) : string
Résultat string $name

getForm_View() public méthode

public getForm_View ( )

getFrontEndErrors() public méthode

returns the front-end attributes with errors.
public getFrontEndErrors ( )

getInfoText() public méthode

public getInfoText ( )

getPrint_view() public méthode

public getPrint_view ( )

getSetting() public méthode

public getSetting ( $key )

getUpdate_view() public méthode

public getUpdate_view ( )

getView_view() public méthode

public getView_view ( )

hasMultiSelectValue() public méthode

Returns true if the specified multiselect relation has the value $value_string.
public hasMultiSelectValue ( $relation, $value_string )

isEditable() public méthode

public isEditable ( )

isHiddenInUI() public méthode

Is this element to be hidden in the UI? (Prevents the elements from being displayed on page load.).
public isHiddenInUI ( ) : boolean
Résultat boolean

isRequired() public méthode

Is this a required element?
public isRequired ( ) : boolean
Résultat boolean

isRequiredInUI() public méthode

Is this element required in the UI? (Prevents the user from being able to remove the element.).
public isRequiredInUI ( ) : boolean
Résultat boolean

loadFromExisting() public méthode

Load an existing element's data into this one The base implementation simply uses copiedFields(), but it may be overridden to allow for more complex relationships.
public loadFromExisting ( BaseEventTypeElement $element )
$element BaseEventTypeElement

render() public méthode

public render ( $action )

requiredIfSide() public méthode

public requiredIfSide ( $attribute, $params )

setChildren() public méthode

set the children for this element - allows external definition of what the children should be (for workflows determined by controllers and the like.
public setChildren ( BaseEventTypeElement[] $children )
$children BaseEventTypeElement[]

setDefaultOptions() public méthode

Stubbed method to set default options Used by child objects to set defaults for forms on create.
public setDefaultOptions ( )

setUpdateOptions() public méthode

Stubbed method to set update options Used by child objects to override null values for forms on update.
public setUpdateOptions ( )

softDelete() public méthode

stub method to allow elements to carry out actions related to being a part of a soft deleted event.
public softDelete ( )

updateMultiSelectData() public méthode

Updates multiselect items in the database, deleting items not passed in $ids.
public updateMultiSelectData ( $model, $ids, $relation_field )

Property Details

$_children protected_oe property

protected $_children

$_element_type protected_oe property

protected $_element_type

$errorExceptions protected_oe property

protected $errorExceptions

$firm public_oe property

public $firm

$frontEndErrors protected_oe property

protected $frontEndErrors

$patientId public_oe property

public $patientId

$useContainerView public_oe property

public $useContainerView

$userId public_oe property

public $userId