Class: iHRIS Benefit (Development): Difference between revisions

Revision as of 07:59, 3 August 2010

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

This article describes the class iHRIS_Benefit .

Extends the class: I2CE_Form.
Location: Part of the module ihris-manage-Benefit in the package iHRIS Manage 4.0-dev
Source: Defined in the file modules/Benefit/lib/iHRIS_Benefit.php on line 35
Author: Luke Duncan <lduncan@intrahealth.org>
Since: v1.0.0

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

Methods

validate()

Checks to make sure all the required fields are valid.

Defined in manage/modules/Benefit/lib/iHRIS_Benefit.php on line 41
Signature: public function validate()

Inherited Methods

__construct()

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

addChildForm()

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

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

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

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

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

setParent()

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

lookupArray()

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

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

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

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

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

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

Theis protected variable is inherited from I2CE_Form->$parent

$parent_forms

Theis protected variable is inherited from I2CE_Form->$parent_forms

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

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

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

@@ Line 29: / Line 29: @@
 ===__construct()===
 This public method is inherited from [[Class: I2CE_Form (Development)#__construct() | I2CE_Form->__construct()]]
-===__get()===
-This public method is inherited from [[Class: I2CE_Form (Development)#__get() | I2CE_Form->__get()]]
-===__isset()===
-This public method is inherited from [[Class: I2CE_Form (Development)#__isset() | I2CE_Form->__isset()]]
-===__set()===
-This public method is inherited from [[Class: I2CE_Form (Development)#__set() | I2CE_Form->__set()]]
-===__unset()===
-This public method is inherited from [[Class: I2CE_Form (Development)#__unset() | I2CE_Form->__unset()]]
 ===addChildForm()===
 This public method is inherited from [[Class: I2CE_Form (Development)#addChildForm() | I2CE_Form->addChildForm()]]
-===addField()===
-This public method is inherited from [[Class: I2CE_Form (Development)#addField() | I2CE_Form->addField()]]
 ===cleanup()===
 This public method is inherited from [[Class: I2CE_Form (Development)#cleanup() | I2CE_Form->cleanup()]]
-===clearFields()===
-This public method is inherited from [[Class: I2CE_Form (Development)#clearFields() | I2CE_Form->clearFields()]]
-===current()===
-This public method is inherited from [[Class: I2CE_Form (Development)#current() | I2CE_Form->current()]]
 ===displayField()===
@@ Line 65: / Line 44: @@
 ===getAllowedParentForms()===
 This public method is inherited from [[Class: I2CE_Form (Development)#getAllowedParentForms() | I2CE_Form->getAllowedParentForms()]]
-===getAttribute()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getAttribute() | I2CE_Form->getAttribute()]]
 ===getChildForms()===
@@ Line 83: / Line 59: @@
 ===getField()===
 This public method is inherited from [[Class: I2CE_Form (Development)#getField() | I2CE_Form->getField()]]
+===getParent()===
+This public method is inherited from [[Class: I2CE_Form (Development)#getParent() | I2CE_Form->getParent()]]
+===getParentForm()===
+This public method is inherited from [[Class: I2CE_Form (Development)#getParentForm() | I2CE_Form->getParentForm()]]
+===getParentID()===
+This public method is inherited from [[Class: I2CE_Form (Development)#getParentID() | I2CE_Form->getParentID()]]
+===getPost()===
+This public method is inherited from [[Class: I2CE_Form (Development)#getPost() | I2CE_Form->getPost()]]
+===listFields()===
+This public method is inherited from [[Class: I2CE_Form (Development)#listFields() | I2CE_Form->listFields()]]
+===processDOM()===
+This public method is inherited from [[Class: I2CE_Form (Development)#processDOM() | I2CE_Form->processDOM()]]
+===reset()===
+This public method is inherited from [[Class: I2CE_Form (Development)#reset() | I2CE_Form->reset()]]
+===search()===
+This public method is inherited from [[Class: I2CE_Form (Development)#search() | I2CE_Form->search()]]
+===setDisplayName()===
+This public method is inherited from [[Class: I2CE_Form (Development)#setDisplayName() | I2CE_Form->setDisplayName()]]
+===setForm()===
+This public method is inherited from [[Class: I2CE_Form (Development)#setForm() | I2CE_Form->setForm()]]
+===setFromPost()===
+This public method is inherited from [[Class: I2CE_Form (Development)#setFromPost() | I2CE_Form->setFromPost()]]
+===setParent()===
+This public method is inherited from [[Class: I2CE_Form (Development)#setParent() | I2CE_Form->setParent()]]
+===lookupArray()===
+This protected method is inherited from [[Class: I2CE_Form (Development)#lookupArray() | I2CE_Form->lookupArray()]]
+===__get()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#__get() | I2CE_FieldContainer->__get()]]
+===__isset()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#__isset() | I2CE_FieldContainer->__isset()]]
+===__set()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#__set() | I2CE_FieldContainer->__set()]]
+===__unset()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#__unset() | I2CE_FieldContainer->__unset()]]
+===addField()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#addField() | I2CE_FieldContainer->addField()]]
+===clearFields()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#clearFields() | I2CE_FieldContainer->clearFields()]]
+===current()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#current() | I2CE_FieldContainer->current()]]
+===getAttribute()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getAttribute() | I2CE_FieldContainer->getAttribute()]]
+===getContainerType()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getContainerType() | I2CE_FieldContainer->getContainerType()]]
 ===getFieldNames()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getFieldNames() | I2CE_Form->getFieldNames()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getFieldNames() | I2CE_FieldContainer->getFieldNames()]]
-===getFormId()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getFormId() | I2CE_Form->getFormId()]]
 ===getHTMLName()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getHTMLName() | I2CE_Form->getHTMLName()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getHTMLName() | I2CE_FieldContainer->getHTMLName()]]
 ===getId()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getId() | I2CE_Form->getId()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getId() | I2CE_FieldContainer->getId()]]
+===getLoad()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getLoad() | I2CE_FieldContainer->getLoad()]]
-===getParent()===
+===getMeta()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getParent() | I2CE_Form->getParent()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getMeta() | I2CE_FieldContainer->getMeta()]]
-===getParentForm()===
+===getName()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getParentForm() | I2CE_Form->getParentForm()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getName() | I2CE_FieldContainer->getName()]]
-===getParentID()===
+===getNameId()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getParentID() | I2CE_Form->getParentID()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getNameId() | I2CE_FieldContainer->getNameId()]]
 ===getQueryDisplay()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getQueryDisplay() | I2CE_Form->getQueryDisplay()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getQueryDisplay() | I2CE_FieldContainer->getQueryDisplay()]]
 ===getQueryFields()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getQueryFields() | I2CE_Form->getQueryFields()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getQueryFields() | I2CE_FieldContainer->getQueryFields()]]
 ===getQueryString()===
-This public method is inherited from [[Class: I2CE_Form (Development)#getQueryString() | I2CE_Form->getQueryString()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#getQueryString() | I2CE_FieldContainer->getQueryString()]]
 ===hasAttribute()===
-This public method is inherited from [[Class: I2CE_Form (Development)#hasAttribute() | I2CE_Form->hasAttribute()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasAttribute() | I2CE_FieldContainer->hasAttribute()]]
 ===hasInvalid()===
-This public method is inherited from [[Class: I2CE_Form (Development)#hasInvalid() | I2CE_Form->hasInvalid()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasInvalid() | I2CE_FieldContainer->hasInvalid()]]
+===hasMeta()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#hasMeta() | I2CE_FieldContainer->hasMeta()]]
+===isValid()===
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#isValid() | I2CE_FieldContainer->isValid()]]
 ===key()===
-This public method is inherited from [[Class: I2CE_Form (Development)#key() | I2CE_Form->key()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#key() | I2CE_FieldContainer->key()]]
-===listFields()===
-This public method is inherited from [[Class: I2CE_Form (Development)#listFields() | I2CE_Form->listFields()]]
 ===load()===
-This public method is inherited from [[Class: I2CE_Form (Development)#load() | I2CE_Form->load()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#load() | I2CE_FieldContainer->load()]]
 ===next()===
-This public method is inherited from [[Class: I2CE_Form (Development)#next() | I2CE_Form->next()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#next() | I2CE_FieldContainer->next()]]
-===processDOM()===
-This public method is inherited from [[Class: I2CE_Form (Development)#processDOM() | I2CE_Form->processDOM()]]
 ===removeField()===
-This public method is inherited from [[Class: I2CE_Form (Development)#removeField() | I2CE_Form->removeField()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#removeField() | I2CE_FieldContainer->removeField()]]
-===reset()===
-This public method is inherited from [[Class: I2CE_Form (Development)#reset() | I2CE_Form->reset()]]
 ===rewind()===
-This public method is inherited from [[Class: I2CE_Form (Development)#rewind() | I2CE_Form->rewind()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#rewind() | I2CE_FieldContainer->rewind()]]
-===search()===
-This public method is inherited from [[Class: I2CE_Form (Development)#search() | I2CE_Form->search()]]
 ===setAttribute()===
-This public method is inherited from [[Class: I2CE_Form (Development)#setAttribute() | I2CE_Form->setAttribute()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setAttribute() | I2CE_FieldContainer->setAttribute()]]
-===setDisplayName()===
+===setId()===
-This public method is inherited from [[Class: I2CE_Form (Development)#setDisplayName() | I2CE_Form->setDisplayName()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setId() | I2CE_FieldContainer->setId()]]
-===setForm()===
+===setMeta()===
-This public method is inherited from [[Class: I2CE_Form (Development)#setForm() | I2CE_Form->setForm()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setMeta() | I2CE_FieldContainer->setMeta()]]
-===setFromPost()===
+===setName()===
-This public method is inherited from [[Class: I2CE_Form (Development)#setFromPost() | I2CE_Form->setFromPost()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#setName() | I2CE_FieldContainer->setName()]]
-===setId()===
-This public method is inherited from [[Class: I2CE_Form (Development)#setId() | I2CE_Form->setId()]]
-===setParent()===
-This public method is inherited from [[Class: I2CE_Form (Development)#setParent() | I2CE_Form->setParent()]]
 ===valid()===
-This public method is inherited from [[Class: I2CE_Form (Development)#valid() | I2CE_Form->valid()]]
+This public method is inherited from [[Class: I2CE_FieldContainer (Development)#valid() | I2CE_FieldContainer->valid()]]
-===addFormFields()===
+===addFields()===
-This protected method is inherited from [[Class: I2CE_Form (Development)#addFormFields() | I2CE_Form->addFormFields()]]
+This protected method is inherited from [[Class: I2CE_FieldContainer (Development)#addFields() | I2CE_FieldContainer->addFields()]]
-===getFormFieldsData()===
+===getAttributes()===
-This protected method is inherited from [[Class: I2CE_Form (Development)#getFormFieldsData() | I2CE_Form->getFormFieldsData()]]
+This protected method is inherited from [[Class: I2CE_FieldContainer (Development)#getAttributes() | I2CE_FieldContainer->getAttributes()]]
-===lookupArray()===
-This protected method is inherited from [[Class: I2CE_Form (Development)#lookupArray() | I2CE_Form->lookupArray()]]
 ===_hasMethod()===
@@ Line 182: / Line 209: @@
 ===$children===
 Theis public variable is inherited from [[Class: I2CE_Form (Development)#$children | I2CE_Form->$children]]
-===$fields===
-Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$fields | I2CE_Form->$fields]]
 ===$parent===
 Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent | I2CE_Form->$parent]]
-===$id===
+===$parent_forms===
-Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$id | I2CE_Form->$id]]
+Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent_forms | I2CE_Form->$parent_forms]]
+===$name===
+Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$name | I2CE_FieldContainer->$name]]
+===$display_name===
+Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$display_name | I2CE_FieldContainer->$display_name]]
+===$fields===
+Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$fields | I2CE_FieldContainer->$fields]]
 ===$attributes===
-Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$attributes | I2CE_Form->$attributes]]
+Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$attributes | I2CE_FieldContainer->$attributes]]
+===$id===
+Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$id | I2CE_FieldContainer->$id]]
-===$parent_forms===
+===$factory===
-Theis protected variable is inherited from [[Class: I2CE_Form (Development)#$parent_forms | I2CE_Form->$parent_forms]]
+Theis protected variable is inherited from [[Class: I2CE_FieldContainer (Development)#$factory | I2CE_FieldContainer->$factory]]
 ==Inherited Fuzzy Methods==
 ===isNumeric()===
@@ Line 221: / Line 257: @@
 ===generateWhereClause()===
 This method is inherited from [[Class: I2CE_Form (Development)#generateWhereClause() | I2CE_Form->generateWhereClause()]]
-===processLimit()===
-This method is inherited from [[Class: I2CE_Form (Development)#processLimit() | I2CE_Form->processLimit()]]
-===getDisplayedExistingLimit()===
-This method is inherited from [[Class: I2CE_Form (Development)#getDisplayedExistingLimit() | I2CE_Form->getDisplayedExistingLimit()]]
 ===isComponentized()===

Anonymous

Search