Class: iHRIS DisciplinaryAction (Development): Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
 
Line 1: Line 1:
{{otherversions|Class: iHRIS_DisciplinaryAction}}
{{otherversions|Class: iHRIS_DisciplinaryAction}}
This article describes the class ''iHRIS_DisciplinaryAction'' .
This article desrcibes the [[Defining Forms#Dynamic Creation|dynamically]] created class ''iHRIS_DisciplinaryAction''.
*Extends the class: [[Class: I2CE_Form (Development) | I2CE_Form]].
*Extends the class: [[Class: I2CE_Form (Development) | I2CE_Form]].
*Location: Part of the module [[iHRIS Qualify Module List (Development)#ihris-qualify|ihris-qualify]] in the package [https://launchpad.net/qualify iHRIS Qualify] 4.0-dev
*Location: It is defined in configuration magic data of the module [[iHRIS Qualify Module List (Development)#ihris-qualify|ihris-qualify]] in the package [https://launchpad.net/qualify iHRIS Qualify] 4.1-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_DisciplinaryAction.php#L35 lib/iHRIS_DisciplinaryAction.php] on line 35
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v1.0.0
@copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.    Object for dealing with disciplinary actions.
==Form Fields==
==Form Fields==
This class is a [[Class: I2CE_Form (Development) |form class]] and provides the following [[Class: I2CE_FormField (Development) |form fields]]
This class is a [[Class: I2CE_Form (Development) |form class]] and provides the following [[Class: I2CE_FormField (Development) |form fields]]
Line 13: Line 9:
===disciplinary_action_type===
===disciplinary_action_type===
The form field ''disciplinary_action_type'' is implemented by [[Class: I2CE_FormField_MAP (Development) |MAP ]]
The form field ''disciplinary_action_type'' is implemented by [[Class: I2CE_FormField_MAP (Development) |MAP ]]
===disciplinary_action_reason===
The form field ''disciplinary_action_reason'' is implemented by [[Class: I2CE_FormField_MAP (Development) |MAP ]]
===start_date===
===start_date===
The form field ''start_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD (Development) |DATE_YMD ]]
The form field ''start_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD (Development) |DATE_YMD ]]
Line 21: Line 19:
===persons_present===
===persons_present===
The form field ''persons_present'' is implemented by [[Class: I2CE_FormField_STRING_MLINE (Development) |STRING_MLINE ]]
The form field ''persons_present'' is implemented by [[Class: I2CE_FormField_STRING_MLINE (Development) |STRING_MLINE ]]
===disciplinary_action_reason===
The form field ''disciplinary_action_reason'' is implemented by [[Class: I2CE_FormField_MAP (Development) |MAP ]]
===suspend===
===suspend===
The form field ''suspend'' is implemented by [[Class: I2CE_FormField_YESNO (Development) |YESNO ]]
The form field ''suspend'' is implemented by [[Class: I2CE_FormField_YESNO (Development) |YESNO ]]
===reinstate_date===
===reinstate_date===
The form field ''reinstate_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD (Development) |DATE_YMD ]]
The form field ''reinstate_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD (Development) |DATE_YMD ]]
==Methods==
===validate()===
Perform any extra validation for the disciplinary action.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0-dev/annotate/head:/lib/iHRIS_DisciplinaryAction.php#L40 qualify/lib/iHRIS_DisciplinaryAction.php] on line 40
*Signature: public function validate()
==Inherited Methods==
==Inherited Methods==
===__construct()===
===__construct()===
Line 38: Line 29:
===addChildForm()===
===addChildForm()===
This public method is inherited from [[Class: I2CE_Form (Development)#addChildForm() | I2CE_Form->addChildForm()]]
This public method is inherited from [[Class: I2CE_Form (Development)#addChildForm() | I2CE_Form->addChildForm()]]
===childFormAdded()===
This public method is inherited from [[Class: I2CE_Form (Development)#childFormAdded() | I2CE_Form->childFormAdded()]]


===cleanup()===
===cleanup()===
Line 65: Line 59:
===getField()===
===getField()===
This public method is inherited from [[Class: I2CE_Form (Development)#getField() | I2CE_Form->getField()]]
This public method is inherited from [[Class: I2CE_Form (Development)#getField() | I2CE_Form->getField()]]
===getFormID()===
This public method is inherited from [[Class: I2CE_Form (Development)#getFormID() | I2CE_Form->getFormID()]]
===getHistory()===
This public method is inherited from [[Class: I2CE_Form (Development)#getHistory() | I2CE_Form->getHistory()]]


===getParent()===
===getParent()===
Line 80: Line 80:
===listFields()===
===listFields()===
This public method is inherited from [[Class: I2CE_Form (Development)#listFields() | I2CE_Form->listFields()]]
This public method is inherited from [[Class: I2CE_Form (Development)#listFields() | I2CE_Form->listFields()]]
===parentIsSet()===
This public method is inherited from [[Class: I2CE_Form (Development)#parentIsSet() | I2CE_Form->parentIsSet()]]


===processDOM()===
===processDOM()===
Line 89: Line 92:
===search()===
===search()===
This public method is inherited from [[Class: I2CE_Form (Development)#search() | I2CE_Form->search()]]
This public method is inherited from [[Class: I2CE_Form (Development)#search() | I2CE_Form->search()]]
===setCreated()===
This public method is inherited from [[Class: I2CE_Form (Development)#setCreated() | I2CE_Form->setCreated()]]


===setDisplayName()===
===setDisplayName()===
Line 98: Line 104:
===setFromPost()===
===setFromPost()===
This public method is inherited from [[Class: I2CE_Form (Development)#setFromPost() | I2CE_Form->setFromPost()]]
This public method is inherited from [[Class: I2CE_Form (Development)#setFromPost() | I2CE_Form->setFromPost()]]
===setLastModified()===
This public method is inherited from [[Class: I2CE_Form (Development)#setLastModified() | I2CE_Form->setLastModified()]]


===setParent()===
===setParent()===
This public method is inherited from [[Class: I2CE_Form (Development)#setParent() | I2CE_Form->setParent()]]
This public method is inherited from [[Class: I2CE_Form (Development)#setParent() | I2CE_Form->setParent()]]
===isValidFieldName()===
This protected method is inherited from [[Class: I2CE_Form (Development)#isValidFieldName() | I2CE_Form->isValidFieldName()]]


===lookupArray()===
===lookupArray()===
This protected method is inherited from [[Class: I2CE_Form (Development)#lookupArray() | I2CE_Form->lookupArray()]]
This protected method is inherited from [[Class: I2CE_Form (Development)#lookupArray() | I2CE_Form->lookupArray()]]
===preProcessFieldArgs()===
This protected method is inherited from [[Class: I2CE_Form (Development)#preProcessFieldArgs() | I2CE_Form->preProcessFieldArgs()]]
===setupCreatedField()===
This protected method is inherited from [[Class: I2CE_Form (Development)#setupCreatedField() | I2CE_Form->setupCreatedField()]]
===setupLastModifiedField()===
This protected method is inherited from [[Class: I2CE_Form (Development)#setupLastModifiedField() | I2CE_Form->setupLastModifiedField()]]
===setupParentField()===
This protected method is inherited from [[Class: I2CE_Form (Development)#setupParentField() | I2CE_Form->setupParentField()]]


===__get()===
===__get()===
Line 128: Line 152:
===getAttribute()===
===getAttribute()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getAttribute() | I2CE_FieldContainer->getAttribute()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getAttribute() | I2CE_FieldContainer->getAttribute()]]
===getContainerIndex()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getContainerIndex() | I2CE_FieldContainer->getContainerIndex()]]


===getContainerType()===
===getContainerType()===
Line 164: Line 191:
===hasAttribute()===
===hasAttribute()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasAttribute() | I2CE_FieldContainer->hasAttribute()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasAttribute() | I2CE_FieldContainer->hasAttribute()]]
===hasField()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasField() | I2CE_FieldContainer->hasField()]]


===hasInvalid()===
===hasInvalid()===
Line 194: Line 224:
===setId()===
===setId()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setId() | I2CE_FieldContainer->setId()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setId() | I2CE_FieldContainer->setId()]]
===setInvalidMessage()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setInvalidMessage() | I2CE_FieldContainer->setInvalidMessage()]]


===setMeta()===
===setMeta()===
Line 203: Line 236:
===valid()===
===valid()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#valid() | I2CE_FieldContainer->valid()]]
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#valid() | I2CE_FieldContainer->valid()]]
===validate()===
This public method is inherited from [[Class: I2CE_FieldContainer (Development)#validate() | I2CE_FieldContainer->validate()]]


===addFields()===
===addFields()===
Line 215: Line 251:
===$children===
===$children===
Theis public variable is inherited from [[Class: I2CE_Form (Development)#$children | I2CE_Form->$children]]
Theis public variable is inherited from [[Class: I2CE_Form (Development)#$children | I2CE_Form->$children]]
===$parent===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent | I2CE_Form->$parent]]


===$parent_forms===
===$parent_forms===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent_forms | I2CE_Form->$parent_forms]]
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent_forms | I2CE_Form->$parent_forms]]
===$parentField===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parentField | I2CE_Form->$parentField]]
===$lastModifiedField===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$lastModifiedField | I2CE_Form->$lastModifiedField]]
===$createdField===
Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$createdField | I2CE_Form->$createdField]]


===$name===
===$name===
Line 281: Line 323:
===populate()===
===populate()===
This method is inherited from [[Class: I2CE_Form (Development)#populate() | I2CE_Form->populate()]]
This method is inherited from [[Class: I2CE_Form (Development)#populate() | I2CE_Form->populate()]]
===duplicate()===
This method is inherited from [[Class: I2CE_Form (Development)#duplicate() | I2CE_Form->duplicate()]]
===storeHistory()===
This method is inherited from [[Class: I2CE_Form (Development)#storeHistory() | I2CE_Form->storeHistory()]]


===populateChild()===
===populateChild()===
Line 305: Line 353:
===setChangeType()===
===setChangeType()===
This method is inherited from [[Class: I2CE_Form (Development)#setChangeType() | I2CE_Form->setChangeType()]]
This method is inherited from [[Class: I2CE_Form (Development)#setChangeType() | I2CE_Form->setChangeType()]]
===changeID()===
This method is inherited from [[Class: I2CE_Form (Development)#changeID() | I2CE_Form->changeID()]]


===userMessage()===
===userMessage()===

Latest revision as of 08:23, 6 May 2015

For other versions, see Class: iHRIS_DisciplinaryAction (versions) .


This article desrcibes the dynamically created class iHRIS_DisciplinaryAction.

Form Fields

This class is a form class and provides the following form fields

action_date

The form field action_date is implemented by DATE_YMD

disciplinary_action_type

The form field disciplinary_action_type is implemented by MAP

disciplinary_action_reason

The form field disciplinary_action_reason is implemented by MAP

start_date

The form field start_date is implemented by DATE_YMD

end_date

The form field end_date is implemented by DATE_YMD

notes

The form field notes is implemented by STRING_TEXT

persons_present

The form field persons_present is implemented by STRING_MLINE

suspend

The form field suspend is implemented by YESNO

reinstate_date

The form field reinstate_date is implemented by DATE_YMD

Inherited Methods

__construct()

This public method is inherited from I2CE_Form->__construct()

addChildForm()

This public method is inherited from I2CE_Form->addChildForm()

childFormAdded()

This public method is inherited from I2CE_Form->childFormAdded()

cleanup()

This public method is inherited from I2CE_Form->cleanup()

displayField()

This public method is inherited from I2CE_Form->displayField()

form()

This public method is inherited from I2CE_Form->form()

getAllowedParentForms()

This public method is inherited from I2CE_Form->getAllowedParentForms()

getChildForms()

This public method is inherited from I2CE_Form->getChildForms()

getChildFormsByForm()

This public method is inherited from I2CE_Form->getChildFormsByForm()

getChildren()

This public method is inherited from I2CE_Form->getChildren()

getDisplayName()

This public method is inherited from I2CE_Form->getDisplayName()

getField()

This public method is inherited from I2CE_Form->getField()

getFormID()

This public method is inherited from I2CE_Form->getFormID()

getHistory()

This public method is inherited from I2CE_Form->getHistory()

getParent()

This public method is inherited from I2CE_Form->getParent()

getParentForm()

This public method is inherited from I2CE_Form->getParentForm()

getParentID()

This public method is inherited from I2CE_Form->getParentID()

getPost()

This public method is inherited from I2CE_Form->getPost()

listFields()

This public method is inherited from I2CE_Form->listFields()

parentIsSet()

This public method is inherited from I2CE_Form->parentIsSet()

processDOM()

This public method is inherited from I2CE_Form->processDOM()

reset()

This public method is inherited from I2CE_Form->reset()

search()

This public method is inherited from I2CE_Form->search()

setCreated()

This public method is inherited from I2CE_Form->setCreated()

setDisplayName()

This public method is inherited from I2CE_Form->setDisplayName()

setForm()

This public method is inherited from I2CE_Form->setForm()

setFromPost()

This public method is inherited from I2CE_Form->setFromPost()

setLastModified()

This public method is inherited from I2CE_Form->setLastModified()

setParent()

This public method is inherited from I2CE_Form->setParent()

isValidFieldName()

This protected method is inherited from I2CE_Form->isValidFieldName()

lookupArray()

This protected method is inherited from I2CE_Form->lookupArray()

preProcessFieldArgs()

This protected method is inherited from I2CE_Form->preProcessFieldArgs()

setupCreatedField()

This protected method is inherited from I2CE_Form->setupCreatedField()

setupLastModifiedField()

This protected method is inherited from I2CE_Form->setupLastModifiedField()

setupParentField()

This protected method is inherited from I2CE_Form->setupParentField()

__get()

This public method is inherited from I2CE_FieldContainer->__get()

__isset()

This public method is inherited from I2CE_FieldContainer->__isset()

__set()

This public method is inherited from I2CE_FieldContainer->__set()

__unset()

This public method is inherited from I2CE_FieldContainer->__unset()

addField()

This public method is inherited from I2CE_FieldContainer->addField()

clearFields()

This public method is inherited from I2CE_FieldContainer->clearFields()

current()

This public method is inherited from I2CE_FieldContainer->current()

getAttribute()

This public method is inherited from I2CE_FieldContainer->getAttribute()

getContainerIndex()

This public method is inherited from I2CE_FieldContainer->getContainerIndex()

getContainerType()

This public method is inherited from I2CE_FieldContainer->getContainerType()

getFieldNames()

This public method is inherited from I2CE_FieldContainer->getFieldNames()

getHTMLName()

This public method is inherited from I2CE_FieldContainer->getHTMLName()

getId()

This public method is inherited from I2CE_FieldContainer->getId()

getLoad()

This public method is inherited from I2CE_FieldContainer->getLoad()

getMeta()

This public method is inherited from I2CE_FieldContainer->getMeta()

getName()

This public method is inherited from I2CE_FieldContainer->getName()

getNameId()

This public method is inherited from I2CE_FieldContainer->getNameId()

getQueryDisplay()

This public method is inherited from I2CE_FieldContainer->getQueryDisplay()

getQueryFields()

This public method is inherited from I2CE_FieldContainer->getQueryFields()

getQueryString()

This public method is inherited from I2CE_FieldContainer->getQueryString()

hasAttribute()

This public method is inherited from I2CE_FieldContainer->hasAttribute()

hasField()

This public method is inherited from I2CE_FieldContainer->hasField()

hasInvalid()

This public method is inherited from I2CE_FieldContainer->hasInvalid()

hasMeta()

This public method is inherited from I2CE_FieldContainer->hasMeta()

isValid()

This public method is inherited from I2CE_FieldContainer->isValid()

key()

This public method is inherited from I2CE_FieldContainer->key()

load()

This public method is inherited from I2CE_FieldContainer->load()

next()

This public method is inherited from I2CE_FieldContainer->next()

removeField()

This public method is inherited from I2CE_FieldContainer->removeField()

rewind()

This public method is inherited from I2CE_FieldContainer->rewind()

setAttribute()

This public method is inherited from I2CE_FieldContainer->setAttribute()

setId()

This public method is inherited from I2CE_FieldContainer->setId()

setInvalidMessage()

This public method is inherited from I2CE_FieldContainer->setInvalidMessage()

setMeta()

This public method is inherited from I2CE_FieldContainer->setMeta()

setName()

This public method is inherited from I2CE_FieldContainer->setName()

valid()

This public method is inherited from I2CE_FieldContainer->valid()

validate()

This public method is inherited from I2CE_FieldContainer->validate()

addFields()

This protected method is inherited from I2CE_FieldContainer->addFields()

getAttributes()

This protected method is inherited from I2CE_FieldContainer->getAttributes()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Variables

$children

Theis public variable is inherited from I2CE_Form->$children

$parent_forms

Theis protected variable is inherited from I2CE_Form->$parent_forms

$parentField

Theis protected variable is inherited from I2CE_Form->$parentField

$lastModifiedField

Theis protected variable is inherited from I2CE_Form->$lastModifiedField

$createdField

Theis protected variable is inherited from I2CE_Form->$createdField

$name

Theis protected variable is inherited from I2CE_FieldContainer->$name

$display_name

Theis protected variable is inherited from I2CE_FieldContainer->$display_name

$fields

Theis protected variable is inherited from I2CE_FieldContainer->$fields

$attributes

Theis protected variable is inherited from I2CE_FieldContainer->$attributes

$id

Theis protected variable is inherited from I2CE_FieldContainer->$id

$factory

Theis protected variable is inherited from I2CE_FieldContainer->$factory

Inherited Fuzzy Methods

isNumeric()

This method is inherited from I2CE_Form->isNumeric()

getLimitStyles()

This method is inherited from I2CE_Form->getLimitStyles()

checkLimit()

This method is inherited from I2CE_Form->checkLimit()

checkWhereClause()

This method is inherited from I2CE_Form->checkWhereClause()

createCheckFunction()

This method is inherited from I2CE_Form->createCheckFunction()

createCheckLimitString()

This method is inherited from I2CE_Form->createCheckLimitString()

generateLimit()

This method is inherited from I2CE_Form->generateLimit()

generateWhereClause()

This method is inherited from I2CE_Form->generateWhereClause()

isComponentized()

This method is inherited from I2CE_Form->isComponentized()

addChild()

This method is inherited from I2CE_Form->addChild()

getChildIds()

This method is inherited from I2CE_Form->getChildIds()

getStorage()

This method is inherited from I2CE_Form->getStorage()

isWritable()

This method is inherited from I2CE_Form->isWritable()

populate()

This method is inherited from I2CE_Form->populate()

duplicate()

This method is inherited from I2CE_Form->duplicate()

storeHistory()

This method is inherited from I2CE_Form->storeHistory()

populateChild()

This method is inherited from I2CE_Form->populateChild()

populateChildren()

This method is inherited from I2CE_Form->populateChildren()

populateFirst()

This method is inherited from I2CE_Form->populateFirst()

populateHistory()

This method is inherited from I2CE_Form->populateHistory()

populateLast()

This method is inherited from I2CE_Form->populateLast()

delete()

This method is inherited from I2CE_Form->delete()

save()

This method is inherited from I2CE_Form->save()

setChangeType()

This method is inherited from I2CE_Form->setChangeType()

changeID()

This method is inherited from I2CE_Form->changeID()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_iHRIS_DisciplinaryAction_(Development)&oldid=54219"