Class: I2CE FormField INT LIST

From IHRIS Wiki
Revision as of 13:09, 19 October 2009 by Litlfred (talk | contribs)

This article describes the class I2CE_FormField_INT_LIST.

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

Methods

getDBValue()

  • Signature: public function getDBValue()

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 @param integer $type The type of the field to be returned.

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

getValue()

  • Signature: public function getValue()

isValid()

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

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

processDOMEditable()

  • Signature: public function processDOMEditable($node,$template,$form_node)
  • Parameters:
    • $node
    • $template
    • $form_node

setFromDB()

Sets the value of this field from the database format.

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

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.

setValueLookup()

Sets the value of this mapped field from a lookup value. Any linked fields should be known at this point so this should find the correct value.

  • Signature: public function setValueLookup($lookup_value)
  • Parameters:
  • Returns: boolean
    Returns true if the value has been set to something