Class: iHRIS Benefit (Development): Difference between revisions

Latest revision as of 08:20, 6 May 2015

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

This article desrcibes the dynamically created class iHRIS_Benefit.

Extends the class: I2CE_Form.
Location: It is defined in configuration magic data of the module ihris-manage-Benefit in the package iHRIS Manage 4.1-dev

Form Fields

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

type

The form field type is implemented by MAP

amount

The form field amount is implemented by CURRENCY

source

The form field source 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

recurrence

The form field recurrence is implemented by MAP

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()

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()

@@ Line 1: / Line 1: @@
 {{otherversions|Class: iHRIS_Benefit}}
-This article describes the class ''iHRIS_Benefit'' .
+This article desrcibes the [[Defining Forms#Dynamic Creation|dynamically]] created class ''iHRIS_Benefit''.
 *Extends the class: [[Class: I2CE_Form (Development) | I2CE_Form]].
-*Location: Part of the module [[iHRIS Manage Module List (Development)#ihris-manage-Benefit|ihris-manage-Benefit]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4.0-dev
+*Location: It is defined in configuration magic data of the module [[iHRIS Manage Module List (Development)#ihris-manage-Benefit|ihris-manage-Benefit]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4.1-dev
-*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Benefit/lib/iHRIS_Benefit.php#L35 modules/Benefit/lib/iHRIS_Benefit.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 benefits.
 ==Form Fields==
 This class is a [[Class: I2CE_Form (Development) |form class]] and provides the following [[Class: I2CE_FormField (Development) |form fields]]
@@ Line 21: / Line 17: @@
 ===recurrence===
 The form field ''recurrence'' is implemented by [[Class: I2CE_FormField_MAP (Development) |MAP ]]
-==Methods==
-===validate()===
-Checks to make sure all the required fields are valid.
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0-dev/annotate/head:/modules/Benefit/lib/iHRIS_Benefit.php#L41 manage/modules/Benefit/lib/iHRIS_Benefit.php] on line 41
-*Signature: public function validate()
 ==Inherited Methods==
 ===__construct()===
@@ Line 32: / Line 23: @@
 ===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()===
@@ Line 59: / Line 53: @@
 ===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()===
@@ Line 74: / Line 74: @@
 ===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()===
@@ Line 83: / Line 86: @@
 ===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()===
@@ Line 92: / Line 98: @@
 ===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()===
 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()===
 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()===
@@ Line 122: / Line 146: @@
 ===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()===
@@ Line 158: / Line 185: @@
 ===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()===
@@ Line 188: / Line 218: @@
 ===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()===
@@ Line 197: / Line 230: @@
 ===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()===
@@ Line 209: / Line 245: @@
 ===$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===
 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===
@@ Line 275: / Line 317: @@
 ===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()===
@@ Line 299: / Line 347: @@
 ===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()===

Anonymous

Search