Class: I2CE WebService Lists (Development)

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

This article describes the class I2CE_WebService_Lists .

• Extends the class: I2CE_WebService.
• Location: Part of the module web-services-lists in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/modules/Lists/modules/WebServicesLists/lib/I2CE_WebService_Lists.php on line 32

Methods

action()

Perform any actions

• Defined in i2ce/modules/Forms/modules/Lists/modules/WebServicesLists/lib/I2CE_WebService_Lists.php on line 170
• Signature: protected function action()
• Returns: boolean
  true on sucess

action_field()

Perform the field action.

• Defined in i2ce/modules/Forms/modules/Lists/modules/WebServicesLists/lib/I2CE_WebService_Lists.php on line 337
• Signature: protected function action_field()
• Returns: boolean

addOrCombineFieldLimit()

Add or combine the given limit to the given limit array

• Defined in i2ce/modules/Forms/modules/Lists/modules/WebServicesLists/lib/I2CE_WebService_Lists.php on line 84
• Signature: static protected function addOrCombineFieldLimit($limits,$key,$field,$value,$style,$operator)
• Parameters:
  • array &$limits
  • string $key
  • string $field
  • string $value
  • string $style
    defaults to equals
    • Default Value: 'equals'
  • string $operator
    How to combine limits if needed, defaults to 'AND'
    • Default Value: 'AND'

combineFormLimits()

Combine two sets of limits that are associated to a form into one limit/where array.

• Defined in i2ce/modules/Forms/modules/Lists/modules/WebServicesLists/lib/I2CE_WebService_Lists.php on line 42
• Signature: static public function combineFormLimits($limits,$add_limits,$operator)
• Parameters:
  • array $limits
  • array $add_limits
  • string $operator
    How to combine the limits, defaults to AND
    • Default Value: 'AND'
• Returns: array

explodeLimitField()

Split the given formfield on the last + for use in limits to match the form from getDisplayFields

• Defined in i2ce/modules/Forms/modules/Lists/modules/WebServicesLists/lib/I2CE_WebService_Lists.php on line 107
• Signature: static protected function explodeLimitField($formfield)
• Parameters:
  • string $formfield
• Returns: array
  return $form and $field as an array.

getCurrentListLimits()

Get the limits to be used for the current list based on any potentially "lower" limits to avoid excess choices with nothing below.

• Defined in i2ce/modules/Forms/modules/Lists/modules/WebServicesLists/lib/I2CE_WebService_Lists.php on line 122
• Signature: protected function getCurrentListLimits($form_limits,$list,$form_fields)
• Parameters:
  • array $form_limits
  • string $list
  • array $form_fields
• Returns: array

removeHidden()

Remove the hidden signifier for displayed fields, e.g. [region], from the array

• Defined in i2ce/modules/Forms/modules/Lists/modules/WebServicesLists/lib/I2CE_WebService_Lists.php on line 68
• Signature: static protected function removeHidden($value,$key)
• Parameters:
  • string &$value
  • mixed $key

Inherited Methods

__construct()

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

display()

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

hasError()

This public method is inherited from I2CE_WebService->hasError()

setRedirect()

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

actionCommandLine()

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

displayCommandLine()

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

displayWeb()

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

forceInitializeTemplate()

This protected method is inherited from I2CE_WebService->forceInitializeTemplate()

initializeTemplate()

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

processDataLoop_xml()

This protected method is inherited from I2CE_WebService->processDataLoop_xml()

processData_json()

This protected method is inherited from I2CE_WebService->processData_json()

processData_xml()

This protected method is inherited from I2CE_WebService->processData_xml()

processError()

This protected method is inherited from I2CE_WebService->processError()

setError()

This protected method is inherited from I2CE_WebService->setError()

_flattenRequestVars()

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

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

_display()

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

getAccess()

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

initPage()

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

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

$data

Theis protected variable is inherited from I2CE_WebService->$data

$config

Theis protected variable is inherited from I2CE_WebService->$config

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

setForm()

This method is inherited from I2CE_Page->setForm()

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

addAjaxLoad()

This method is inherited from I2CE_Page->addAjaxLoad()

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