Class: I2CE Form (4.1.12)

From IHRIS Wiki
Revision as of 09:43, 18 August 2015 by Sovello (talk | contribs) (Created page with "{{otherversions|Class: I2CE_Form}} This article describes the class ''I2CE_Form'' . *Extends the class: I2CE_FieldContainer. *Child C...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
For other versions, see Class: I2CE_Form (versions) .


This article describes the class I2CE_Form .

Abstract class for objects using the class that interact with a database and HTML form. This class has a few default functions that are used when interacting with the template engine in setting up form values and displaying the data for objects that tie directly to database tables.

Variables

$children

An array of children objects for this form. It is an array of arrays. The first being an associative array with the name of the form, the second level is a simple array of the objects.

$parent_forms

parent_forms. The array with keys form names and values which are arrays of form names, the form names which the form's parent id can take values in

$parentField

$lastModifiedField

$createdField

@var protected I2CE_FormField_DATE_TIME $created

Methods

__construct()

Create a new instance of a I2CE_Form object.

addChildForm()

Add a child form object to this forms list of children.

childFormAdded()

Check to see if the given form was added

cleanup()

Clean up all the fields for this form. This will unset all the fields associated with this form. This will remove all circular references to this form so it can be cleaned up by the garbage collector. This should only be called when the form is no longer needed. Trying to access it after this may cause unexpected results or errors.

displayField()

Display the field in the given node.

form()

Return the form name for this form. @deprecated -- use {getName()}

getAllowedParentForms()

Gets the allowed parent forms for a given form

  • Defined in i2ce/modules/Forms/lib/I2CE_Form.php on line 103
  • Signature: static public function getAllowedParentForms($form,$use_cache)
  • Parameters:
    • string $form
    • boolean $use_cache
      Defaults to true in which case we cached result of finding parent forms
      • Default Value: true
  • Returns: array
    of string, the form names.

getChildForms()

Get the registered child forms for this form.

getChildFormsByForm()

Get the registered child forms for the given form.

  • Defined in i2ce/modules/Forms/lib/I2CE_Form.php on line 61
  • Signature: static public function getChildFormsByForm($form)
  • Parameters:
    • string $form
      The form to get the children of.
  • Returns: array
    The list of child form names registered for the form.

getChildren()

Get the added children for this form

  • Defined in i2ce/modules/Forms/lib/I2CE_Form.php on line 75
  • Signature: public function getChildren($form)
  • Parameters:
    • string $form
      Defaults to null, in which case we get all children. otherwise we get the popoluated children with the specified form
      • Default Value: null
  • Returns: array
    If $form is null, it is an array with keys the form names and values array of the children of that form type. If $form is set, then it is an array of the forms of type $form

getDisplayName()

Return the display name for this form object.

getField()

Return the I2CE_FormField for the given field name.

getFormID()

Return the form ID for this form.

getHistory()

Get the history of each field in this container. May need to populate the history

  • Defined in i2ce/modules/Forms/lib/I2CE_Form.php on line 274
  • Signature: public function getHistory($as_array)
  • Parameters:
    • boolean $as_array
      Defaults to false in which case results are instances of I2CE_Entry, otherwise reusults are associative arrays
      • Default Value: false
  • Returns: array
    index by field names

getParent()

Return the (db value of the) parent id for this record. If there isn't a parent record set then return the id for this record.

  • Defined in i2ce/modules/Forms/lib/I2CE_Form.php on line 263
  • Signature: public function getParent()
  • Returns: mixed.
    false if there is no parent id or string a parent id of the form "$form|$id"

getParentForm()

Return the name of the parent form for this record. If there isn't a parent record set then return the id for this record.

getParentID()

Return the parent id for this record. If there isn't a parent record set then return the id for this record.

getPost()

Get the nested associative array that is used for post

  • Defined in i2ce/modules/Forms/lib/I2CE_Form.php on line 561
  • Signature: public function getPost($field_names,$skip_invalid,$include_id)
  • Parameters:
    • array $field_names
      Array of string, the field names we wish to query. Defaults to null in which we case we get all fields
      • Default Value: null
    • boolean $skip_invalid
      Defaults to true in which case we skip invalid values
      • Default Value: true
    • boolean $include_id
      defaults to true
      • Default Value: true
  • Returns: array

isValidFieldName()

Checks to see if the given field name is valid

listFields()

  • Defined in i2ce/modules/Forms/lib/I2CE_Form.php on line 729
  • Signature: static public function listFields($form,$fields,$where_data,$ordering,$limit)
  • Parameters:
    • string $form
      The form name
    • array $fields
      of string. The fields we want returned
    • mixed $where_data
      Either I2CE_MagicDataNode or array. contains the where clause information about this form or a nested
      • Default Value: array()
    • array $ordering
      An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
      • Default Value: array()
    • mixed $limit
      Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.
      • Default Value: false
  • Returns: mixed
    an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value.

lookupArray()

Lookup a given id in the given array.

parentIsSet()

Checks to see if the parent field has been set

preProcessFieldArgs()

Pre process field args before creating the field object

processDOM()

Process the DOM for this form.

reset()

Reset this object to its original state.

search()

@param mixed $limit. Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.

  • Defined in i2ce/modules/Forms/lib/I2CE_Form.php on line 690
  • Signature: static public function search($form,$where_data,$ordering,$limit_one)
  • Parameters:
    • string $form
      The form name.
    • mixed $where_data
      Either I2CE_MagicDataNode or array. contains the where clause information about this form or a nested
      • Default Value: array()
    • array $ordering
      An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
      • Default Value: array()
    • $limit_one
      • Default Value: false
  • Returns: mixed
    an array of matching form ids. However, ff $limit_one is true or 1 or array ($offset,1) then then we return either the id or false, if none found or there was an error.

setCreated()

Set the create time for this record

setDisplayName()

Set the display name for this form object.

setForm()

Set the form name for this form object. @deprecated -- use {setName()}

setFromPost()

Load the member variables from an array The array can contain the keys 'id', 'parent', 'fields'. The later of which is an array indexed by field names and which contains the values of the field

setLastModified()

Set the last modified time for this record

setParent()

Set the parent id for this record

  • Defined in i2ce/modules/Forms/lib/I2CE_Form.php on line 338
  • Signature: public function setParent($parent,$set_id)
  • Parameters:
    • mixed $parent
      string or I2CE_Form
    • boolean $set_id
      If the parent will only have one child object then you can set the id by setting this to true.
      • Default Value: false

setupCreatedField()

Setup the last_modified field as a date time @param mixed $value. The value to set it to. Defaults to null in which case no value is set

setupLastModifiedField()

Setup the created field as a DATE_TIME @param mixed $value. The value to set it to. Defaults to null in which case no value is set

setupParentField()

Setup the parent field. the use of string_line is considered temporary. @param mixed $value. The value to set it to. Defaults to null in which case no value is set

Inherited Methods

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

getStaticAttribute()

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

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

hasStaticAttribute()

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

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

setStaticAttribute()

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

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

$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

$static_attrs

Theis protected variable is inherited from I2CE_FieldContainer->$static_attrs

$id

Theis protected variable is inherited from I2CE_FieldContainer->$id

$factory

Theis protected variable is inherited from I2CE_FieldContainer->$factory

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Fuzzy Methods

isNumeric()

This method is implemented by I2CE_Module_CustomReports->isNumeric()

getLimitStyles()

This method is implemented by I2CE_Module_FormLimits->getLimitStyles()

checkLimit()

This method is implemented by I2CE_Module_FormLimits->checkLimit()

checkWhereClause()

This method is implemented by I2CE_Module_FormLimits->checkWhereClause()

createCheckFunction()

This method is implemented by I2CE_Module_FormLimits->createCheckFunction()

createCheckLimitString()

This method is implemented by I2CE_Module_FormLimits->createCheckLimitString()

generateLimit()

This method is implemented by I2CE_Module_FormLimits->generateLimit()

generateWhereClause()

This method is implemented by I2CE_Module_FormLimits->generateWhereClause()

isComponentized()

This method is implemented by I2CE_FormStorage->isComponentizedForm()

addChild()

This method is implemented by I2CE_FormStorage->addChild()

getChildIds()

This method is implemented by I2CE_FormStorage->getChildIds()

getStorage()

This method is implemented by I2CE_FormStorage->getStorage()

isWritable()

This method is implemented by I2CE_FormStorage->isWritable()

populate()

This method is implemented by I2CE_FormStorage->populate()

duplicate()

This method is implemented by I2CE_FormStorage->duplicate()

storeHistory()

This method is implemented by I2CE_FormStorage->storeHistory()

populateChild()

This method is implemented by I2CE_FormStorage->populateChild()

populateChildren()

This method is implemented by I2CE_FormStorage->populateChildren()

populateFirst()

This method is implemented by I2CE_FormStorage->populateFirst()

populateHistory()

This method is implemented by I2CE_FormStorage->populateHistory()

populateLast()

This method is implemented by I2CE_FormStorage->populateLast()

delete()

This method is implemented by I2CE_FormStorage->delete()

save()

This method is implemented by I2CE_FormStorage->save()

setChangeType()

This method is implemented by I2CE_FormStorage->setChangeType()

changeID()

This method is implemented by I2CE_FormStorage->changeID()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_Form_(4.1.12)&oldid=54874"