Class: I2CE WebService (Development)

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

This article describes the class I2CE_WebService .

• Extends the class: I2CE_Page.
• Child Classes:
  • I2CE_WebService_Lists
• Location: Part of the module web-services in the package I2CE 4.1-dev
• Source: Defined in the file modules/WebServices/lib/I2CE_WebService.php on line 34

Variables

$err_msgs

The list of error message types to look up in magic data for translations to be displayed.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 39
• Type: private array $err_msgs

$data

The data to return from this web service.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 44
• Type: protected array $data

$config

The configuration for this module.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 49
• Type: protected I2CE_MagicDataNode $config

Methods

__construct()

Create a new instance of this web service page.

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

action()

Perform any actions

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 182
• Signature: protected function action()
• Returns: boolean.
  true on sucess

actionCommandLine()

The business method if this page is called from the commmand line

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 243
• Signature: protected function actionCommandLine($args,$request_remainder)
• Parameters:
  • array $args
    the array of unix style command line arguments Arguements are link that in: http://us3.php.net/manual/en/features.commandline.php#78651 If we were called as: index.php --page=/module/page/some/thing/else --long -AB 2 -C -D 'ostrich' --eggs==good Then $request_remainder = array('some','thing','else') and $args = array('long'=>true, 'A'=>true, 'B'=>2, 'C'=>true, 'D'=>'ostrich', 'eggs'=>'good')
  • array $request_remainder
    the remainder of the request after the page specfication.

display()

Calls the appropriate action for the page. Then it processes the results as appropriate. This will check to make sure the page can be seen by this user and if not send an error message.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 124
• Signature: public function display($supress_output)
• Parameters:
  • boolean $supress_output
    defaults to false. set to true to supress the output of a webpage
    • Default Value: false

displayCommandLine()

Main display method for command line interface

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 190
• Signature: protected function displayCommandLine()

displayWeb()

Main display method for web interface

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 203
• Signature: protected function displayWeb($supress_output)
• Parameters:
  • boolean $supress_output
    defaults to false. set to true to supress the output of a webpage
    • Default Value: false

forceInitializeTemplate()

Force the parent to initialize the template now as we need it.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 173
• Signature: protected function forceInitializeTemplate()

hasError()

Check to see if there are any errors on this page.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 98
• Signature: public function hasError()
• Returns: boolean

initializeTemplate()

Don't initialize the template unless needed later.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 166
• Signature: protected function initializeTemplate()

processDataLoop_xml()

Loop through the passed array and recursively add all data to the XML template

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 286
• Signature: protected function processDataLoop_xml($data,$parent)
• Parameters:
  • array &$data
  • &$parent

processData_json()

Process the results data as a json array and output it.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 256
• Signature: protected function processData_json($supress_output)
• Parameters:
  • boolean $supress_output
    • Default Value: false
• Returns: boolean

processData_xml()

Process the results data as xml and output it.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 269
• Signature: protected function processData_xml($supress_output)
• Parameters:
  • boolean $supress_output
    • Default Value: false
• Returns: boolean

processError()

Process the errors and replace the data with the error.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 90
• Signature: protected function processError()

setError()

Add an error message to the results. If it's not available in magic data then it can't be added.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 69
• Signature: protected function setError($err_msg,$args)
• Parameters:
  • string $err_msg
  • array $args
    Any values to replace in the message.
    • Default Value: null

setRedirect()

setRedirect shouldn't really be used for web services so give a warning and then call the parent.

• Defined in i2ce/modules/WebServices/lib/I2CE_WebService.php on line 110
• Signature: public function setRedirect($url)
• Parameters:
  • string $url

Inherited Methods

_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

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