Class: I2CE FormField MAP: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 13: Line 13:
===create_DOMEditable_list()===
===create_DOMEditable_list()===
Creates a drop down list of options.
Creates a drop down list of options.
@pararm array $fields
*Signature: protected function create_DOMEditable_list($node,$template,$form_node,$fields,$forms,$limits,$orders)
*Signature: protected function create_DOMEditable_list($node,$template,$form_node,$fields,$forms,$limits,$orders)
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ] DOMNode or an array of DOMNodes to add.
*Parameters:
Parameters:
** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node <br/>the node we wish to add the drop down list under @pararm array $fields
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node<br/>the node we wish to add the drop down list under
** [[Class: I2CE_Template | I2CE_Template]] $template
* [[Class: I2CE_Template | I2CE_Template]] $template
*$form_node  
*$form_node  
*$fields  
*$fields  
* [http://www.php.net/manual/en/language.types.array.php array ] $forms<br/>The selectable forms for this map.  Order does not matter
** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>The selectable forms for this map.  Order does not matter
* [http://www.php.net/manual/en/language.types.array.php array ] $limits<br/>An array, indexed by form name, of limiting data
** [http://www.php.net/manual/en/language.types.array.php array ] $limits <br/>An array, indexed by form name, of limiting data
* [http://www.php.net/manual/en/language.types.array.php array ] $orders<br/>An array, indexed by form name, of ordering data
** [http://www.php.net/manual/en/language.types.array.php array ] $orders <br/>An array, indexed by form name, of ordering data
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>DOMNode or an array of DOMNodes to add.
===create_DOMEditable_tree()===
===create_DOMEditable_tree()===
Creates a selectable auto-suggest tree view of the options
Creates a selectable auto-suggest tree view of the options
@pararm array $fields
*Signature: protected function create_DOMEditable_tree($node,$template,$form_node,$fields,$forms,$limits,$orders)
*Signature: protected function create_DOMEditable_tree($node,$template,$form_node,$fields,$forms,$limits,$orders)
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ] DOMNode or an array of DOMNodes to add.
*Parameters:
Parameters:
** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node <br/>the node that requested this drop down @pararm array $fields
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node<br/>the node that requested this drop down
** [[Class: I2CE_Template | I2CE_Template]] $template
* [[Class: I2CE_Template | I2CE_Template]] $template
*$form_node  
*$form_node  
*$fields  
*$fields  
* [http://www.php.net/manual/en/language.types.array.php array ] $forms<br/>The selectable forms for this map.  Order does not matter
** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>The selectable forms for this map.  Order does not matter
* [http://www.php.net/manual/en/language.types.array.php array ] $limits<br/>An array, indexed by form name, of limiting data
** [http://www.php.net/manual/en/language.types.array.php array ] $limits <br/>An array, indexed by form name, of limiting data
* [http://www.php.net/manual/en/language.types.array.php array ] $orders<br/>An array, indexed by form name, of ordering data
** [http://www.php.net/manual/en/language.types.array.php array ] $orders <br/>An array, indexed by form name, of ordering data
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>DOMNode or an array of DOMNodes to add.
===getComponentizedValue()===
===getComponentizedValue()===
Componentizes the given $db_value based on component
Componentizes the given $db_value based on component
*Signature: public function getComponentizedValue($db_value,$forms,$component)
*Signature: public function getComponentizedValue($db_value,$forms,$component)
*Returns: [http://www.php.net/manual/en/language.types.string.php string ] The componentized db_value
*Parameters:
Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $db_value <br/>The non-componentized value
* [http://www.php.net/manual/en/language.types.string.php string ] $db_value<br/>The non-componentized value
** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of stirng. The form names which we wish to componentize.
* [http://www.php.net/manual/en/language.types.array.php array ] $forms<br/>of stirng. The form names which we wish to componentize.
** [http://www.php.net/manual/en/language.types.string.php string ] $component <br/>The component we wish to encode
* [http://www.php.net/manual/en/language.types.string.php string ] $component<br/>The component we wish to encode
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>The componentized db_value
===getDBValue()===
===getDBValue()===
Return the DB value for this form field.
Return the DB value for this form field.
Line 51: Line 49:
===getDefaultDisplayStyle()===
===getDefaultDisplayStyle()===
*Signature: public function getDefaultDisplayStyle($type)
*Signature: public function getDefaultDisplayStyle($type)
Parameters:
*Parameters:
*$type  
*$type  
===getDisplayValue()===
===getDisplayValue()===
Returns the value of this field as a human readable format.
Returns the value of this field as a human readable format.
entry for this field.
*Signature: public function getDisplayValue($entry)
*Signature: public function getDisplayValue($entry)
*Parameters:
** [[Class: I2CE_Entry | I2CE_Entry]] $entry <br/>If a I2CE_Entry object has been passed to this method then it will return the value for that entry assuming it's an entry for this field.
***Default Value: false
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
Parameters:
* [[Class: I2CE_Entry | I2CE_Entry]] $entry<br/>If a I2CE_Entry object has been passed to this method then it will return the value for that entry assuming it's an
**Default Value: false
===getFromDB()===
===getFromDB()===
Return the value of this field from the database format for the given type.
Return the value of this field from the database format for the given type.
*Signature: public function getFromDB($value)
*Signature: public function getFromDB($value)
Parameters:
*Parameters:
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
===getMappedForm()===
===getMappedForm()===
Get the form that this field maps to
Get the form that this field maps to
Line 71: Line 68:
*Returns: string.
*Returns: string.
===getMappedID()===
===getMappedID()===
Get the id of the form that this field maps to
Get the id of the form that this field maps to If not set, returns 0.
If not set, returns 0.
*Signature: public function getMappedID()
*Signature: public function getMappedID()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
Line 78: Line 74:
Componentizes the given $db_value based on component
Componentizes the given $db_value based on component
*Signature: public function getSQLComponentization($db_ref,$forms,$component)
*Signature: public function getSQLComponentization($db_ref,$forms,$component)
*Returns: [http://www.php.net/manual/en/language.types.string.php string ] The componentized db_value
*Parameters:
Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $db_ref <br/>The reference to the data
* [http://www.php.net/manual/en/language.types.string.php string ] $db_ref<br/>The reference to the data
** [http://www.php.net/manual/en/language.types.array.php array ] $forms <br/>of stirng. The form names which we wish to componentize.
* [http://www.php.net/manual/en/language.types.array.php array ] $forms<br/>of stirng. The form names which we wish to componentize.
** [http://www.php.net/manual/en/language.types.string.php string ] $component <br/>The component we wish to encode
* [http://www.php.net/manual/en/language.types.string.php string ] $component<br/>The component we wish to encode
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>The componentized db_value
===getValue()===
===getValue()===
Return the native value for this form field.
Return the native value for this form field.
Line 98: Line 94:
Sets the value of this field from the posted form.
Sets the value of this field from the posted form.
*Signature: public function setFromPost($post)
*Signature: public function setFromPost($post)
Parameters:
*Parameters:
* [http://www.php.net/manual/en/language.types.array.php array ] $post<br/>The $_POST array holding the values for this form.
** [http://www.php.net/manual/en/language.types.array.php array ] $post <br/>The $_POST array holding the values for this form.
==Inherited Variables==
==Inherited Variables==
===$name===
===$name===

Revision as of 22:40, 16 October 2009

This article desrcibes the class I2CE_FormField_MAP.

Class for defining all the database fields used by a I2CE_Form object.

Methods

checkStyle_tree()

Check to see if the tree style is allowed.

  • Signature: public function checkStyle_tree()
  • Returns: boolean

create_DOMEditable_list()

Creates a drop down list of options.

  • Signature: protected function create_DOMEditable_list($node,$template,$form_node,$fields,$forms,$limits,$orders)
  • Parameters:
  • $form_node
  • $fields
    • array $forms
      The selectable forms for this map. Order does not matter
    • array $limits
      An array, indexed by form name, of limiting data
    • array $orders
      An array, indexed by form name, of ordering data
  • Returns: mixed
    DOMNode or an array of DOMNodes to add.

create_DOMEditable_tree()

Creates a selectable auto-suggest tree view of the options

  • Signature: protected function create_DOMEditable_tree($node,$template,$form_node,$fields,$forms,$limits,$orders)
  • Parameters:
  • $form_node
  • $fields
    • array $forms
      The selectable forms for this map. Order does not matter
    • array $limits
      An array, indexed by form name, of limiting data
    • array $orders
      An array, indexed by form name, of ordering data
  • Returns: mixed
    DOMNode or an array of DOMNodes to add.

getComponentizedValue()

Componentizes the given $db_value based on component

  • Signature: public function getComponentizedValue($db_value,$forms,$component)
  • Parameters:
    • string $db_value
      The non-componentized value
    • array $forms
      of stirng. The form names which we wish to componentize.
    • string $component
      The component we wish to encode
  • Returns: string
    The componentized db_value

getDBValue()

Return the DB value for this form field.

  • Signature: public function getDBValue()
  • Returns: string

getDefaultDisplayStyle()

  • Signature: public function getDefaultDisplayStyle($type)
  • Parameters:
  • $type

getDisplayValue()

Returns the value of this field as a human readable format.

  • Signature: public function getDisplayValue($entry)
  • Parameters:
    • I2CE_Entry $entry
      If a I2CE_Entry object has been passed to this method then it will return the value for that entry assuming it's an entry for this field.
      • Default Value: false
  • Returns: mixed

getFromDB()

Return the value of this field from the database format for the given type.

  • Signature: public function getFromDB($value)
  • Parameters:

getMappedForm()

Get the form that this field maps to

  • Signature: public function getMappedForm()
  • Returns: string.

getMappedID()

Get the id of the form that this field maps to If not set, returns 0.

  • Signature: public function getMappedID()
  • Returns: string

getSQLComponentization()

Componentizes the given $db_value based on component

  • Signature: public function getSQLComponentization($db_ref,$forms,$component)
  • Parameters:
    • string $db_ref
      The reference to the data
    • array $forms
      of stirng. The form names which we wish to componentize.
    • string $component
      The component we wish to encode
  • Returns: string
    The componentized db_value

getValue()

Return the native value for this form field.

  • Signature: public function getValue()
  • Returns: array

isValid()

Checks to see if the current value for this is set and valid.

  • Signature: public function isValid()
  • Returns: boolean

issetValue()

Checks to see if the value has been set.

  • Signature: public function issetValue()
  • Returns: boolean

setFromPost()

Sets the value of this field from the posted form.

  • Signature: public function setFromPost($post)
  • Parameters:
    • array $post
      The $_POST array holding the values for this form.

Inherited Variables

$name

Theis protected variable is inherited from I2CE_FormField->$name

$options

Theis protected variable is inherited from I2CE_FormField->$options

$value

Theis protected variable is inherited from I2CE_FormField->$value

$headers

Theis protected variable is inherited from I2CE_FormField->$headers

$href

Theis protected variable is inherited from I2CE_FormField->$href

$form

Theis protected variable is inherited from I2CE_FormField->$form

$history

Theis protected variable is inherited from I2CE_FormField->$history

$history_idx

Theis protected variable is inherited from I2CE_FormField->$history_idx

$attributes

Theis protected variable is inherited from I2CE_FormField->$attributes

$invalid

Theis protected variable is inherited from I2CE_FormField->$invalid

Inherited Fuzzy Methods

generateLimit_in()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_in()

generateLimit_equals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_equals()

generateLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_greaterthan()

generateLimit_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lessthan()

generateLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_greaterthan_equals()

generateLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lessthan_equals()

generateLimit_between()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_between()

generateLimit_like()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_like()

generateLimit_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_lowerlike()

generateLimit_contains()

This method is inherited from I2CE_FormField_DB_STRING->generateLimit_contains()

checkLimit_in()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_in()

checkLimitString_in()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_in()

getLimitMenu_in()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_in()

processLimitMenu_in()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_in()

checkLimit_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_equals()

checkLimitString_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_equals()

getLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_equals()

processLimitMenu_equals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_equals()

checkLimit_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_greaterthan()

checkLimitString_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_greaterthan()

getLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_greaterthan()

processLimitMenu_greaterthan()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_greaterthan()

checkLimit_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lessthan()

checkLimitString_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lessthan()

getLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lessthan()

processLimitMenu_lessthan()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lessthan()

checkLimit_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_greaterthan_equals()

checkLimitString_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_greaterthan_equals()

getLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_greaterthan_equals()

processLimitMenu_greaterthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_greaterthan_equals()

checkLimit_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lessthan_equals()

checkLimitString_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lessthan_equals()

getLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lessthan_equals()

processLimitMenu_lessthan_equals()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lessthan_equals()

checkLimit_between()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_between()

checkLimitString_between()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_between()

getLimitMenu_between()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_between()

processLimitMenu_between()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_between()

checkLimit_like()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_like()

checkLimitString_like()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_like()

getLimitMenu_like()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_like()

processLimitMenu_like()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_like()

checkLimit_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_lowerlike()

checkLimitString_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_lowerlike()

getLimitMenu_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_lowerlike()

processLimitMenu_lowerlike()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_lowerlike()

checkLimit_contains()

This method is inherited from I2CE_FormField_DB_STRING->checkLimit_contains()

checkLimitString_contains()

This method is inherited from I2CE_FormField_DB_STRING->checkLimitString_contains()

getLimitMenu_contains()

This method is inherited from I2CE_FormField_DB_STRING->getLimitMenu_contains()

processLimitMenu_contains()

This method is inherited from I2CE_FormField_DB_STRING->processLimitMenu_contains()

cachedTableReference()

This method is inherited from I2CE_FormField->cachedTableReference()

isNumeric()

This method is inherited from I2CE_FormField->isNumeric()

getLimitStyles()

This method is inherited from I2CE_FormField->getLimitStyles()

generateLimit()

This method is inherited from I2CE_FormField->generateLimit()

generateLimit_null()

This method is inherited from I2CE_FormField->generateLimit_null()

generateLimit_not_null()

This method is inherited from I2CE_FormField->generateLimit_not_null()

generateLimit_null_not_null()

This method is inherited from I2CE_FormField->generateLimit_null_not_null()

checkLimit_null()

This method is inherited from I2CE_FormField->checkLimit_null()

checkLimit_not_null()

This method is inherited from I2CE_FormField->checkLimit_not_null()

checkLimit_null_not_null()

This method is inherited from I2CE_FormField->checkLimit_null_not_null()

checkLimitString_null()

This method is inherited from I2CE_FormField->checkLimitString_null()

checkLimitString_not_null()

This method is inherited from I2CE_FormField->checkLimitString_not_null()

checkLimitString_null_not_null()

This method is inherited from I2CE_FormField->checkLimitString_null_not_null()

getLimitMenu_null()

This method is inherited from I2CE_FormField->getLimitMenu_null()

getLimitMenu_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_not_null()

getLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->getLimitMenu_null_not_null()

processLimitMenu_null()

This method is inherited from I2CE_FormField->processLimitMenu_null()

processLimitMenu_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_not_null()

processLimitMenu_null_not_null()

This method is inherited from I2CE_FormField->processLimitMenu_null_not_null()

generateLimit_max_parent()

This method is inherited from I2CE_FormField->generateLimit_max_parent()

generateLimit_min_parent()

This method is inherited from I2CE_FormField->generateLimit_min_parent()

generateLimit_max_parent_form()

This method is inherited from I2CE_FormField->generateLimit_max_parent_form()

generateLimit_min_parent_form()

This method is inherited from I2CE_FormField->generateLimit_min_parent_form()

getLimitMenu_max_parent()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent()

getLimitMenu_min_parent()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent()

getLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_max_parent_form()

getLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->getLimitMenu_min_parent_form()

processLimitMenu_max_parent()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent()

processLimitMenu_min_parent()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent()

processLimitMenu_max_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_max_parent_form()

processLimitMenu_min_parent_form()

This method is inherited from I2CE_FormField->processLimitMenu_min_parent_form()

save()

This method is inherited from I2CE_FormField->save()

populateHistory()

This method is inherited from I2CE_FormField->populateHistory()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_FormField_MAP&oldid=7678"