Class: iHRIS Benefit: Difference between revisions

Revision as of 13:06, 19 October 2009

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
Source: Defined in the file modules/Benefit/lib/iHRIS_Benefit.php
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.

Signature: public function validate($page)
Parameters:
- I2CE_Template &$page

Inherited Methods

__construct()

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

addChildForm()

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

addField()

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

cleanup()

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

clearFields()

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

current()

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

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

getAttribute()

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

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

getFieldNames()

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

getFormId()

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

getHTMLName()

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

getId()

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

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

getQueryDisplay()

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

getQueryFields()

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

getQueryString()

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

hasAttribute()

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

hasInvalid()

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

key()

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

listFields()

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

load()

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

next()

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

processDOM()

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

removeField()

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

reset()

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

rewind()

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

search()

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

setAttribute()

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

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

setId()

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

setParent()

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

valid()

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

__get()

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

__isset()

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

__set()

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

__unset()

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

addFormFields()

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

getFormFieldsData()

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

lookupArray()

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

_hasMethod()

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

Inherited Variables

$children

Theis public variable is inherited from I2CE_Form->$children

$fields

Theis protected variable is inherited from I2CE_Form->$fields

$parent

Theis protected variable is inherited from I2CE_Form->$parent

$id

Theis protected variable is inherited from I2CE_Form->$id

$attributes

Theis protected variable is inherited from I2CE_Form->$attributes

$parent_forms

Theis protected variable is inherited from I2CE_Form->$parent_forms

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

processLimit()

This method is inherited from I2CE_Form->processLimit()

getDisplayedExistingLimit()

This method is inherited from I2CE_Form->getDisplayedExistingLimit()

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 8: / Line 8: @@
 ==Form Fields==
 This class is a [[Class: I2CE_Form |form class]] and provides the following [[Class: I2CE_FormField |form fields]]
-==type==
+===type===
 The form field ''type'' is implemented by [[Class: I2CE_FormField_MAP |MAP ]]
-==amount==
+===amount===
 The form field ''amount'' is implemented by [[Class: iHRIS_FormField_CURRENCY |CURRENCY ]]
-==source==
+===source===
 The form field ''source'' is implemented by [[Class: I2CE_FormField_MAP |MAP ]]
-==start_date==
+===start_date===
 The form field ''start_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD |DATE_YMD ]]
-==end_date==
+===end_date===
 The form field ''end_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD |DATE_YMD ]]
-==recurrence==
+===recurrence===
 The form field ''recurrence'' is implemented by [[Class: I2CE_FormField_MAP |MAP ]]
 ==Methods==
@@ Line 26: / Line 26: @@
 *Parameters:
 ** [[Class: I2CE_Template | I2CE_Template]] &$page
+==Inherited Methods==
+===__construct()===
+This public method is inherited from [[Class: I2CE_Form#__construct() | I2CE_Form->__construct()]]
+===addChildForm()===
+This public method is inherited from [[Class: I2CE_Form#addChildForm() | I2CE_Form->addChildForm()]]
+===addField()===
+This public method is inherited from [[Class: I2CE_Form#addField() | I2CE_Form->addField()]]
+===cleanup()===
+This public method is inherited from [[Class: I2CE_Form#cleanup() | I2CE_Form->cleanup()]]
+===clearFields()===
+This public method is inherited from [[Class: I2CE_Form#clearFields() | I2CE_Form->clearFields()]]
+===current()===
+This public method is inherited from [[Class: I2CE_Form#current() | I2CE_Form->current()]]
+===displayField()===
+This public method is inherited from [[Class: I2CE_Form#displayField() | I2CE_Form->displayField()]]
+===form()===
+This public method is inherited from [[Class: I2CE_Form#form() | I2CE_Form->form()]]
+===getAllowedParentForms()===
+This public method is inherited from [[Class: I2CE_Form#getAllowedParentForms() | I2CE_Form->getAllowedParentForms()]]
+===getAttribute()===
+This public method is inherited from [[Class: I2CE_Form#getAttribute() | I2CE_Form->getAttribute()]]
+===getChildForms()===
+This public method is inherited from [[Class: I2CE_Form#getChildForms() | I2CE_Form->getChildForms()]]
+===getChildFormsByForm()===
+This public method is inherited from [[Class: I2CE_Form#getChildFormsByForm() | I2CE_Form->getChildFormsByForm()]]
+===getChildren()===
+This public method is inherited from [[Class: I2CE_Form#getChildren() | I2CE_Form->getChildren()]]
+===getDisplayName()===
+This public method is inherited from [[Class: I2CE_Form#getDisplayName() | I2CE_Form->getDisplayName()]]
+===getField()===
+This public method is inherited from [[Class: I2CE_Form#getField() | I2CE_Form->getField()]]
+===getFieldNames()===
+This public method is inherited from [[Class: I2CE_Form#getFieldNames() | I2CE_Form->getFieldNames()]]
+===getFormId()===
+This public method is inherited from [[Class: I2CE_Form#getFormId() | I2CE_Form->getFormId()]]
+===getHTMLName()===
+This public method is inherited from [[Class: I2CE_Form#getHTMLName() | I2CE_Form->getHTMLName()]]
+===getId()===
+This public method is inherited from [[Class: I2CE_Form#getId() | I2CE_Form->getId()]]
+===getParent()===
+This public method is inherited from [[Class: I2CE_Form#getParent() | I2CE_Form->getParent()]]
+===getParentForm()===
+This public method is inherited from [[Class: I2CE_Form#getParentForm() | I2CE_Form->getParentForm()]]
+===getParentID()===
+This public method is inherited from [[Class: I2CE_Form#getParentID() | I2CE_Form->getParentID()]]
+===getQueryDisplay()===
+This public method is inherited from [[Class: I2CE_Form#getQueryDisplay() | I2CE_Form->getQueryDisplay()]]
+===getQueryFields()===
+This public method is inherited from [[Class: I2CE_Form#getQueryFields() | I2CE_Form->getQueryFields()]]
+===getQueryString()===
+This public method is inherited from [[Class: I2CE_Form#getQueryString() | I2CE_Form->getQueryString()]]
+===hasAttribute()===
+This public method is inherited from [[Class: I2CE_Form#hasAttribute() | I2CE_Form->hasAttribute()]]
+===hasInvalid()===
+This public method is inherited from [[Class: I2CE_Form#hasInvalid() | I2CE_Form->hasInvalid()]]
+===key()===
+This public method is inherited from [[Class: I2CE_Form#key() | I2CE_Form->key()]]
+===listFields()===
+This public method is inherited from [[Class: I2CE_Form#listFields() | I2CE_Form->listFields()]]
+===load()===
+This public method is inherited from [[Class: I2CE_Form#load() | I2CE_Form->load()]]
+===next()===
+This public method is inherited from [[Class: I2CE_Form#next() | I2CE_Form->next()]]
+===processDOM()===
+This public method is inherited from [[Class: I2CE_Form#processDOM() | I2CE_Form->processDOM()]]
+===removeField()===
+This public method is inherited from [[Class: I2CE_Form#removeField() | I2CE_Form->removeField()]]
+===reset()===
+This public method is inherited from [[Class: I2CE_Form#reset() | I2CE_Form->reset()]]
+===rewind()===
+This public method is inherited from [[Class: I2CE_Form#rewind() | I2CE_Form->rewind()]]
+===search()===
+This public method is inherited from [[Class: I2CE_Form#search() | I2CE_Form->search()]]
+===setAttribute()===
+This public method is inherited from [[Class: I2CE_Form#setAttribute() | I2CE_Form->setAttribute()]]
+===setDisplayName()===
+This public method is inherited from [[Class: I2CE_Form#setDisplayName() | I2CE_Form->setDisplayName()]]
+===setForm()===
+This public method is inherited from [[Class: I2CE_Form#setForm() | I2CE_Form->setForm()]]
+===setFromPost()===
+This public method is inherited from [[Class: I2CE_Form#setFromPost() | I2CE_Form->setFromPost()]]
+===setId()===
+This public method is inherited from [[Class: I2CE_Form#setId() | I2CE_Form->setId()]]
+===setParent()===
+This public method is inherited from [[Class: I2CE_Form#setParent() | I2CE_Form->setParent()]]
+===valid()===
+This public method is inherited from [[Class: I2CE_Form#valid() | I2CE_Form->valid()]]
+===__get()===
+This protected method is inherited from [[Class: I2CE_Form#__get() | I2CE_Form->__get()]]
+===__isset()===
+This protected method is inherited from [[Class: I2CE_Form#__isset() | I2CE_Form->__isset()]]
+===__set()===
+This protected method is inherited from [[Class: I2CE_Form#__set() | I2CE_Form->__set()]]
+===__unset()===
+This protected method is inherited from [[Class: I2CE_Form#__unset() | I2CE_Form->__unset()]]
+===addFormFields()===
+This protected method is inherited from [[Class: I2CE_Form#addFormFields() | I2CE_Form->addFormFields()]]
+===getFormFieldsData()===
+This protected method is inherited from [[Class: I2CE_Form#getFormFieldsData() | I2CE_Form->getFormFieldsData()]]
+===lookupArray()===
+This protected method is inherited from [[Class: I2CE_Form#lookupArray() | I2CE_Form->lookupArray()]]
+===_hasMethod()===
+This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
+==Inherited Variables==
+===$children===
+Theis public variable is inherited from [[Class: I2CE_Form#$children | I2CE_Form->$children]]
+===$fields===
+Theis protected variable is inherited from [[Class: I2CE_Form#$fields | I2CE_Form->$fields]]
+===$parent===
+Theis protected variable is inherited from [[Class: I2CE_Form#$parent | I2CE_Form->$parent]]
+===$id===
+Theis protected variable is inherited from [[Class: I2CE_Form#$id | I2CE_Form->$id]]
+===$attributes===
+Theis protected variable is inherited from [[Class: I2CE_Form#$attributes | I2CE_Form->$attributes]]
+===$parent_forms===
+Theis protected variable is inherited from [[Class: I2CE_Form#$parent_forms | I2CE_Form->$parent_forms]]
+==Inherited Fuzzy Methods==
+===isNumeric()===
+This method is inherited from [[Class: I2CE_Form#isNumeric() | I2CE_Form->isNumeric()]]
+===getLimitStyles()===
+This method is inherited from [[Class: I2CE_Form#getLimitStyles() | I2CE_Form->getLimitStyles()]]
+===checkLimit()===
+This method is inherited from [[Class: I2CE_Form#checkLimit() | I2CE_Form->checkLimit()]]
+===checkWhereClause()===
+This method is inherited from [[Class: I2CE_Form#checkWhereClause() | I2CE_Form->checkWhereClause()]]
+===createCheckFunction()===
+This method is inherited from [[Class: I2CE_Form#createCheckFunction() | I2CE_Form->createCheckFunction()]]
+===createCheckLimitString()===
+This method is inherited from [[Class: I2CE_Form#createCheckLimitString() | I2CE_Form->createCheckLimitString()]]
+===generateLimit()===
+This method is inherited from [[Class: I2CE_Form#generateLimit() | I2CE_Form->generateLimit()]]
+===generateWhereClause()===
+This method is inherited from [[Class: I2CE_Form#generateWhereClause() | I2CE_Form->generateWhereClause()]]
+===processLimit()===
+This method is inherited from [[Class: I2CE_Form#processLimit() | I2CE_Form->processLimit()]]
+===getDisplayedExistingLimit()===
+This method is inherited from [[Class: I2CE_Form#getDisplayedExistingLimit() | I2CE_Form->getDisplayedExistingLimit()]]
+===isComponentized()===
+This method is inherited from [[Class: I2CE_Form#isComponentized() | I2CE_Form->isComponentized()]]
+===addChild()===
+This method is inherited from [[Class: I2CE_Form#addChild() | I2CE_Form->addChild()]]
+===getChildIds()===
+This method is inherited from [[Class: I2CE_Form#getChildIds() | I2CE_Form->getChildIds()]]
+===getStorage()===
+This method is inherited from [[Class: I2CE_Form#getStorage() | I2CE_Form->getStorage()]]
+===isWritable()===
+This method is inherited from [[Class: I2CE_Form#isWritable() | I2CE_Form->isWritable()]]
+===populate()===
+This method is inherited from [[Class: I2CE_Form#populate() | I2CE_Form->populate()]]
+===populateChild()===
+This method is inherited from [[Class: I2CE_Form#populateChild() | I2CE_Form->populateChild()]]
+===populateChildren()===
+This method is inherited from [[Class: I2CE_Form#populateChildren() | I2CE_Form->populateChildren()]]
+===populateFirst()===
+This method is inherited from [[Class: I2CE_Form#populateFirst() | I2CE_Form->populateFirst()]]
+===populateHistory()===
+This method is inherited from [[Class: I2CE_Form#populateHistory() | I2CE_Form->populateHistory()]]
+===populateLast()===
+This method is inherited from [[Class: I2CE_Form#populateLast() | I2CE_Form->populateLast()]]
+===delete()===
+This method is inherited from [[Class: I2CE_Form#delete() | I2CE_Form->delete()]]
+===save()===
+This method is inherited from [[Class: I2CE_Form#save() | I2CE_Form->save()]]
+===setChangeType()===
+This method is inherited from [[Class: I2CE_Form#setChangeType() | I2CE_Form->setChangeType()]]
+===userMessage()===
+This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 [[Category:Class Documentation]]

Anonymous

Search