Class: I2CE Module Lists

This article describes the class I2CE_Module_Lists.

• Extends the class: I2CE_Module.
• Parent Classses: I2CE_Module I2CE_Fuzzy
• Location: Part of the module Lists in the package I2CE
• Source: Defined in the file modules/Forms/modules/Lists/lib/I2CE_Module_Lists.php
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v3.2.3

@filesource Class I2CE_Module_Lists

Methods

action_initialize()

Method called when the module is enabled for the first time. @param boolean -- returns true on success. false on error.

• Signature: public function action_initialize()

deleteMappedValues()

Deletes id's of a list with field matchin a given value. Intended to be called after rempaFields has been succesfully called.

• Signature: static public function deleteMappedValues($list,$evals,$lookup_field)
• Parameters:
  • string $list
    the list form.
  • array $evals
    an array when keys the new id you want the value to be. the values are the values we lookup on the form name
  • string $lookup_field
    the name of the list field to lookup on. Defaults to 'name'
    • Default Value: 'name'
• Returns: voolean.
  true on success

getHooks()

• Signature: static public function getHooks()

remapFields()

Remaps the list values of the given list based on the field to lookup on for the form @param string $mapped_field. the mapped field of $form. The Defaults to null in which case then mapped field that is used is the $list

• Signature: static public function remapFields($list,$evals,$forms,$lookup_field)
• Parameters:
  • string $list
    the list form.
  • array $evals
    an array when keys the new id you want the value to be. the values are the values we lookup on the form name. If a list instance with the new id does not exist it creates it.
  • array $forms
    an array of string keys are forms values are mapped fields. Defulats to false in which case we do not try to update any form.
    • Default Value: false
  • string $lookup_field
    the name of the list field to lookup on. Defaults to 'name'
    • Default Value: 'name'
• Returns: boolean.
  true on success

upgrade()

Upgrade module method

• Signature: public function upgrade($old_vers,$new_vers)
• Parameters:
  • $old_vers
  • $new_vers

validate_formfield()

Hooked Function to check if a field is unique

• Signature: public function validate_formfield($field_obj)
• Parameters:
  • I2CE_FormField $field_obj
• Returns: boolean

Inherited Methods

__construct()

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

action_configure()

This public method is inherited from I2CE_Module->action_configure()

action_disable()

This public method is inherited from I2CE_Module->action_disable()

action_enable()

This public method is inherited from I2CE_Module->action_enable()

conflict_external()

This public method is inherited from I2CE_Module->conflict_external()

getCLIHooks()

This public method is inherited from I2CE_Module->getCLIHooks()

getCLIMethods()

This public method is inherited from I2CE_Module->getCLIMethods()

getConfig()

This public method is inherited from I2CE_Module->getConfig()

getMethods()

This public method is inherited from I2CE_Module->getMethods()

post_update()

This public method is inherited from I2CE_Module->post_update()

pre_upgrade()

This public method is inherited from I2CE_Module->pre_upgrade()

requirement_external()

This public method is inherited from I2CE_Module->requirement_external()

_hasMethod()

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

Inherited Fuzzy Methods

launchBackgroundProcess()

This method is inherited from I2CE_Module->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is inherited from I2CE_Module->launchBackgroundPHPScript()

launchBackgroundPage()

This method is inherited from I2CE_Module->launchBackgroundPage()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()