Class: iHRIS NextOfKin (Development): Difference between revisions

From IHRIS Wiki
(Created page with '{{otherversions|Class: iHRIS_NextOfKin}} This article desrcibes the dynamically created class ''iHRIS_NextOfKin''. *Extends the class: [[Class…')
 
No edit summary
 
Line 2: Line 2:
This article desrcibes the [[Defining Forms#Dynamic Creation|dynamically]] created class ''iHRIS_NextOfKin''.
This article desrcibes the [[Defining Forms#Dynamic Creation|dynamically]] created class ''iHRIS_NextOfKin''.
*Extends the class: [[Class: iHRIS_Contact (Development) | iHRIS_Contact]].
*Extends the class: [[Class: iHRIS_Contact (Development) | iHRIS_Contact]].
*Location: It is defined in configuration magic data of the module [[iHRIS Common Module List (Development)#nextOfKin|nextOfKin]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4.0-dev
*Location: It is defined in configuration magic data of the module [[iHRIS Common Module List (Development)#nextOfKin|nextOfKin]] in the package [https://launchpad.net/ihris-common iHRIS Common] 4.1-dev
==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 15: Line 15:
===telephone===
===telephone===
The form field ''telephone'' is implemented by [[Class: I2CE_FormField_STRING_LINE (Development) |STRING_LINE ]]is inherited from the class [[Class: iHRIS_Contact (Development)|iHRIS_Contact]]
The form field ''telephone'' is implemented by [[Class: I2CE_FormField_STRING_LINE (Development) |STRING_LINE ]]is inherited from the class [[Class: iHRIS_Contact (Development)|iHRIS_Contact]]
===mobile_phone===
The form field ''mobile_phone'' is implemented by [[Class: I2CE_FormField_STRING_LINE (Development) |STRING_LINE ]]is inherited from the class [[Class: iHRIS_Contact (Development)|iHRIS_Contact]]


===alt_telephone===
===alt_telephone===
Line 27: Line 30:
===notes===
===notes===
The form field ''notes'' is implemented by [[Class: I2CE_FormField_STRING_MLINE (Development) |STRING_MLINE ]]is inherited from the class [[Class: iHRIS_Contact (Development)|iHRIS_Contact]]
The form field ''notes'' is implemented by [[Class: I2CE_FormField_STRING_MLINE (Development) |STRING_MLINE ]]is inherited from the class [[Class: iHRIS_Contact (Development)|iHRIS_Contact]]
===i2ce_hidden===
The form field ''i2ce_hidden'' is implemented by [[Class: I2CE_FormField_YESNO (Development) |YESNO ]]is inherited from the class [[Class: I2CE_List (Development)|I2CE_List]]


==Inherited Methods==
==Inherited Methods==
Line 37: Line 37:
===lookupType()===
===lookupType()===
This public method is inherited from [[Class: iHRIS_Contact (Development)#lookupType() | iHRIS_Contact->lookupType()]]
This public method is inherited from [[Class: iHRIS_Contact (Development)#lookupType() | iHRIS_Contact->lookupType()]]
===componentizeQuery()===
This public method is inherited from [[Class: I2CE_List (Development)#componentizeQuery() | I2CE_List->componentizeQuery()]]
===createDataTree()===
This public method is inherited from [[Class: I2CE_List (Development)#createDataTree() | I2CE_List->createDataTree()]]
===flattenDataTree()===
This public method is inherited from [[Class: I2CE_List (Development)#flattenDataTree() | I2CE_List->flattenDataTree()]]
===getDisplayFields()===
This public method is inherited from [[Class: I2CE_List (Development)#getDisplayFields() | I2CE_List->getDisplayFields()]]
===getDisplayString()===
This public method is inherited from [[Class: I2CE_List (Development)#getDisplayString() | I2CE_List->getDisplayString()]]
===getExtendedDisplay()===
This public method is inherited from [[Class: I2CE_List (Development)#getExtendedDisplay() | I2CE_List->getExtendedDisplay()]]
===getHTMLTemplate()===
This public method is inherited from [[Class: I2CE_List (Development)#getHTMLTemplate() | I2CE_List->getHTMLTemplate()]]
===getListType()===
This public method is inherited from [[Class: I2CE_List (Development)#getListType() | I2CE_List->getListType()]]
===getSortFields()===
This public method is inherited from [[Class: I2CE_List (Development)#getSortFields() | I2CE_List->getSortFields()]]
===getViewTemplate()===
This public method is inherited from [[Class: I2CE_List (Development)#getViewTemplate() | I2CE_List->getViewTemplate()]]
===listOptions()===
This public method is inherited from [[Class: I2CE_List (Development)#listOptions() | I2CE_List->listOptions()]]
===lookup()===
This public method is inherited from [[Class: I2CE_List (Development)#lookup() | I2CE_List->lookup()]]
===monsterMash()===
This public method is inherited from [[Class: I2CE_List (Development)#monsterMash() | I2CE_List->monsterMash()]]
===name()===
This public method is inherited from [[Class: I2CE_List (Development)#name() | I2CE_List->name()]]
===setDisplayData()===
This public method is inherited from [[Class: I2CE_List (Development)#setDisplayData() | I2CE_List->setDisplayData()]]
===walkupFieldPath()===
This public method is inherited from [[Class: I2CE_List (Development)#walkupFieldPath() | I2CE_List->walkupFieldPath()]]
===_flattenDataTree()===
This protected method is inherited from [[Class: I2CE_List (Development)#_flattenDataTree() | I2CE_List->_flattenDataTree()]]
===_getDisplayFields()===
This protected method is inherited from [[Class: I2CE_List (Development)#_getDisplayFields() | I2CE_List->_getDisplayFields()]]
===_getDisplayString()===
This protected method is inherited from [[Class: I2CE_List (Development)#_getDisplayString() | I2CE_List->_getDisplayString()]]
===_getSortFields()===
This protected method is inherited from [[Class: I2CE_List (Development)#_getSortFields() | I2CE_List->_getSortFields()]]
===_monsterMash()===
This protected method is inherited from [[Class: I2CE_List (Development)#_monsterMash() | I2CE_List->_monsterMash()]]
===addCache()===
This protected method is inherited from [[Class: I2CE_List (Development)#addCache() | I2CE_List->addCache()]]
===getCache()===
This protected method is inherited from [[Class: I2CE_List (Development)#getCache() | I2CE_List->getCache()]]
===isCached()===
This protected method is inherited from [[Class: I2CE_List (Development)#isCached() | I2CE_List->isCached()]]
===showHiddenLimit()===
This protected method is inherited from [[Class: I2CE_List (Development)#showHiddenLimit() | I2CE_List->showHiddenLimit()]]


===__construct()===
===__construct()===
Line 118: Line 43:
===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 145: Line 73:
===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 160: Line 94:
===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 169: Line 106:
===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 178: Line 118:
===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 208: Line 166:
===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 244: Line 205:
===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 274: Line 238:
===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 298: Line 265:
===$types===
===$types===
Theis protected variable is inherited from [[Class: iHRIS_Contact (Development)#$types | iHRIS_Contact->$types]]
Theis protected variable is inherited from [[Class: iHRIS_Contact (Development)#$types | iHRIS_Contact->$types]]
===$cache===
Theis protected variable is inherited from [[Class: I2CE_List (Development)#$cache | I2CE_List->$cache]]


===$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 370: Line 340:
===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 394: Line 370:
===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 09:28, 6 May 2015


This article desrcibes the dynamically created class iHRIS_NextOfKin.

Form Fields

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

name

The form field name is implemented by STRING_LINE

relationship

The form field relationship is implemented by STRING_LINE

Inherited Form Fields

address

The form field address is implemented by STRING_MLINE is inherited from the class iHRIS_Contact

telephone

The form field telephone is implemented by STRING_LINE is inherited from the class iHRIS_Contact

mobile_phone

The form field mobile_phone is implemented by STRING_LINE is inherited from the class iHRIS_Contact

alt_telephone

The form field alt_telephone is implemented by STRING_LINE is inherited from the class iHRIS_Contact

fax

The form field fax is implemented by STRING_LINE is inherited from the class iHRIS_Contact

email

The form field email is implemented by STRING_LINE is inherited from the class iHRIS_Contact

notes

The form field notes is implemented by STRING_MLINE is inherited from the class iHRIS_Contact

Inherited Methods

listTypeOptions()

This public method is inherited from iHRIS_Contact->listTypeOptions()

lookupType()

This public method is inherited from iHRIS_Contact->lookupType()

__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

$types

Theis protected variable is inherited from iHRIS_Contact->$types

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