Class: I2CE PageFormCSV (4.1.7)

For other versions, see Class: I2CE_PageFormCSV (versions) .

This article describes the abstract class I2CE_PageFormCSV .

• Extends the class: I2CE_PageFormBase.
• Child Classes:
  • iHRIS_PageUploadTraining
• Location: Part of the module forms in the package I2CE 4.1.7-release
• Source: Defined in the file modules/Forms/lib/I2CE_PageFormCSV.php on line 33
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: v4.1.6

@filesource Class I2CE_PageFormCSV

Variables

$files

The list of any CSV files uploaded to this page.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 38
• Type: protected array $files

$current

The current row for the given upload key

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 43
• Type: protected array $current

$invalid

Set if the CSV file is invalid

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 48
• Type: protected boolean $invalid

$cache

A cached of looked up values for a form.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 53
• Type: protected array $cache

Methods

__construct()

Create a new instance of a form page. This will call the constructor for all Page objects and then set up some additional member variables for forms. @param string $title The title for this page. @param string $defaultHTMLFile The default HTML file for this page. @param mixed $access The role required to access this page. @param array $files The list of template files to load for this page.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 65
• Signature: public function __construct($args,$request_remainder,$get,$post)
• Parameters:
  • $args
  • $request_remainder
  • $get
    • Default Value: null
  • $post
    • Default Value: null

hasInvalid()

Checks to see if any of the forms on this page have invalid messages

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 229
• Signature: public function hasInvalid()
• Returns: boolean

loadObjects()

Create and load any necessary objects for this form. Since this is from a file upload the form doesn't need to be set on the template, but this can be overridden if necessary.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 97
• Signature: protected function loadObjects()
• Returns: boolean

lookupList()

Lookup a list form by name and return the id

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 239
• Signature: protected function lookupList($form,$name,$field)
• Parameters:
  • string $form
  • string $name
  • string $field
    Defaults to 'name' field.
    • Default Value: 'name'

processHeaderRow()

Process the header row if it exists for the given key.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 121
• Signature: protected function processHeaderRow($key)
• Parameters:
  • string $key
• Returns: boolean;

processRow()

Process the next row for the given key

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 140
• Signature: protected function processRow($key)
• Parameters:
  • string $key
• Returns: boolean

save()

Save the objects to the database. Save the default object being edited Most saving will be handled by the processRow functions. @global array

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 210
• Signature: protected function save()

saveRow()

Save the current row of the given key.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 176
• Signature: abstract protected function saveRow($key)
• Parameters:
  • string $key
• Returns: boolean

setForm()

Set the I2CE_Form object in the page template. Since this is from a file upload the form doesn't need to be set on the template, but this can be overridden if necessary.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 86
• Signature: protected function setForm()

validate()

Run the validation methods for all the objects being edited. If this is a form submit then run the validation methods for the default object being edited. The default method calls the  ::validate() validate method on the object.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 185
• Signature: protected function validate()

validateRow()

Validate the current row of the given key.

• Defined in i2ce/modules/Forms/lib/I2CE_PageFormCSV.php on line 169
• Signature: abstract protected function validateRow($key)
• Parameters:
  • string $key
• Returns: boolean

Inherited Methods

invalidMessage()

This public method is inherited from I2CE_PageFormBase->invalidMessage()

usesConfirmPage()

This public method is inherited from I2CE_PageFormBase->usesConfirmPage()

action()

This protected method is inherited from I2CE_PageFormBase->action()

action_display()

This protected method is inherited from I2CE_PageFormBase->action_display()

action_save()

This protected method is inherited from I2CE_PageFormBase->action_save()

canSave()

This protected method is inherited from I2CE_PageFormBase->canSave()

checkActionPermission()

This protected method is inherited from I2CE_PageFormBase->checkActionPermission()

displayControls()

This protected method is inherited from I2CE_PageFormBase->displayControls()

initPage()

This protected method is inherited from I2CE_PageFormBase->initPage()

isConfirm()

This protected method is inherited from I2CE_PageFormBase->isConfirm()

isEdit()

This protected method is inherited from I2CE_PageFormBase->isEdit()

isEditing()

This protected method is inherited from I2CE_PageFormBase->isEditing()

isSave()

This protected method is inherited from I2CE_PageFormBase->isSave()

setDisplayData()

This protected method is inherited from I2CE_PageFormBase->setDisplayData()

setEditing()

This protected method is inherited from I2CE_PageFormBase->setEditing()

_flattenRequestVars()

This public method is inherited from I2CE_Page->_flattenRequestVars()

display()

This public method is inherited from I2CE_Page->display()

fixupRequestVariables()

This public method is inherited from I2CE_Page->fixupRequestVariables()

flattenRequestVars()

This public method is inherited from I2CE_Page->flattenRequestVars()

get()

This public method is inherited from I2CE_Page->get()

getAccessedBaseURL()

This public method is inherited from I2CE_Page->getAccessedBaseURL()

getTemplate()

This public method is inherited from I2CE_Page->getTemplate()

getTitle()

This public method is inherited from I2CE_Page->getTitle()

getURLRoot()

This public method is inherited from I2CE_Page->getURLRoot()

getUser()

This public method is inherited from I2CE_Page->getUser()

get_exists()

This public method is inherited from I2CE_Page->get_exists()

hasPermission()

This public method is inherited from I2CE_Page->hasPermission()

isGet()

This public method is inherited from I2CE_Page->isGet()

isPost()

This public method is inherited from I2CE_Page->isPost()

module()

This public method is inherited from I2CE_Page->module()

page()

This public method is inherited from I2CE_Page->page()

pageRemainder()

This public method is inherited from I2CE_Page->pageRemainder()

pageRoot()

This public method is inherited from I2CE_Page->pageRoot()

post()

This public method is inherited from I2CE_Page->post()

post_exists()

This public method is inherited from I2CE_Page->post_exists()

redirect()

This public method is inherited from I2CE_Page->redirect()

request()

This public method is inherited from I2CE_Page->request()

request_exists()

This public method is inherited from I2CE_Page->request_exists()

rewrittenURLs()

This public method is inherited from I2CE_Page->rewrittenURLs()

session_req()

This public method is inherited from I2CE_Page->session_req()

session_req_exists()

This public method is inherited from I2CE_Page->session_req_exists()

setAccess()

This public method is inherited from I2CE_Page->setAccess()

setIsPost()

This public method is inherited from I2CE_Page->setIsPost()

setRedirect()

This public method is inherited from I2CE_Page->setRedirect()

_display()

This protected method is inherited from I2CE_Page->_display()

actionCommandLine()

This protected method is inherited from I2CE_Page->actionCommandLine()

displayCommandLine()

This protected method is inherited from I2CE_Page->displayCommandLine()

displayWeb()

This protected method is inherited from I2CE_Page->displayWeb()

getAccess()

This protected method is inherited from I2CE_Page->getAccess()

initializeTemplate()

This protected method is inherited from I2CE_Page->initializeTemplate()

loadHTMLTemplates()

This protected method is inherited from I2CE_Page->loadHTMLTemplates()

setActiveMenu()

This protected method is inherited from I2CE_Page->setActiveMenu()

setupGetPost()

This protected method is inherited from I2CE_Page->setupGetPost()

_hasMethod()

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

Inherited Variables

$editing

Theis protected variable is inherited from I2CE_PageFormBase->$editing

$factory

Theis protected variable is inherited from I2CE_PageFormBase->$factory

$button_templates

Theis protected variable is inherited from I2CE_PageFormBase->$button_templates

$checked_validation

Theis protected variable is inherited from I2CE_PageFormBase->$checked_validation

$usesConfimPage

Theis protected variable is inherited from I2CE_PageFormBase->$usesConfimPage

$template

Theis protected variable is inherited from I2CE_Page->$template

$defaultHTMLFile

Theis protected variable is inherited from I2CE_Page->$defaultHTMLFile

$role

Theis protected variable is inherited from I2CE_Page->$role

$user

Theis protected variable is inherited from I2CE_Page->$user

$redirect

Theis protected variable is inherited from I2CE_Page->$redirect

$post

Theis protected variable is inherited from I2CE_Page->$post

$get

Theis protected variable is inherited from I2CE_Page->$get

$page_root

Theis protected variable is inherited from I2CE_Page->$page_root

$page_remainder

Theis protected variable is inherited from I2CE_Page->$page_remainder

$args

Theis protected variable is inherited from I2CE_Page->$args

$request_remainder

Theis protected variable is inherited from I2CE_Page->$request_remainder

$permissionParser

Theis protected variable is inherited from I2CE_Page->$permissionParser

$root_url

Theis protected variable is inherited from I2CE_Page->$root_url

$page

Theis protected variable is inherited from I2CE_Page->$page

$module

Theis protected variable is inherited from I2CE_Page->$module

$is_post

Theis protected variable is inherited from I2CE_Page->$is_post

$session_req

Theis protected variable is inherited from I2CE_Page->$session_req

Inherited Fuzzy Methods

launchBackgroundProcess()

This method is inherited from I2CE_Page->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is inherited from I2CE_Page->launchBackgroundPHPScript()

launchBackgroundPage()

This method is inherited from I2CE_Page->launchBackgroundPage()

addColorPickerTriple()

This method is inherited from I2CE_Page->addColorPickerTriple()

addReportSelector()

This method is inherited from I2CE_Page->addReportSelector()

addDatePicker()

This method is inherited from I2CE_Page->addDatePicker()

selectOptionsImmediate()

This method is inherited from I2CE_Page->selectOptionsImmediate()

setDisplayData()

This method is inherited from I2CE_Page->setDisplayData()

setDisplayDataImmediate()

This method is inherited from I2CE_Page->setDisplayDataImmediate()

addFormWorm()

This method is inherited from I2CE_Page->addFormWorm()

getClassValue()

This method is inherited from I2CE_Page->getClassValue()

loadClassValues()

This method is inherited from I2CE_Page->loadClassValues()

setClassValue()

This method is inherited from I2CE_Page->setClassValue()

setClassValues()

This method is inherited from I2CE_Page->setClassValues()

useDropDown()

This method is inherited from I2CE_Page->useDropDown()

addOption()

This method is inherited from I2CE_Page->addOption()

addOptions()

This method is inherited from I2CE_Page->addOptions()

addAutoCompleteInputTreeById()

This method is inherited from I2CE_Page->addAutoCompleteInputTreeById()

addAutoCompleteInputTree()

This method is inherited from I2CE_Page->addAutoCompleteInputTree()

getForm()

This method is inherited from I2CE_Page->getForm()

getField()

This method is inherited from I2CE_Page->getField()

setReview()

This method is inherited from I2CE_Page->setReview()

isReview()

This method is inherited from I2CE_Page->isReview()

makeJumper()

This method is inherited from I2CE_Page->makeJumper()

makeScalingJumper()

This method is inherited from I2CE_Page->makeScalingJumper()

menuSelect()

This method is inherited from I2CE_Page->menuSelect()

addUpdateSelect()

This method is inherited from I2CE_Page->addUpdateSelect()

addAjaxUpdate()

This method is inherited from I2CE_Page->addAjaxUpdate()

addAjaxToggle()

This method is inherited from I2CE_Page->addAjaxToggle()

addAjaxRequestFunction()

This method is inherited from I2CE_Page->addAjaxRequestFunction()

addAjaxCompleteFunction()

This method is inherited from I2CE_Page->addAjaxCompleteFunction()

addAjaxToggleOnFunction()

This method is inherited from I2CE_Page->addAjaxToggleOnFunction()

addAjaxToggleOffFunction()

This method is inherited from I2CE_Page->addAjaxToggleOffFunction()

hasAjax()

This method is inherited from I2CE_Page->hasAjax()

setDataTypePriority()

This method is inherited from I2CE_Page->setDataTypePriority()

setData()

This method is inherited from I2CE_Page->setData()

getData()

This method is inherited from I2CE_Page->getData()

getDefaultData()

This method is inherited from I2CE_Page->getDefaultData()

removeData()

This method is inherited from I2CE_Page->removeData()

getDataNames()

This method is inherited from I2CE_Page->getDataNames()

ensureNode()

This method is inherited from I2CE_Page->ensureNode()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()