xajax
[ class tree: xajax ] [ index: xajax ] [ all elements ]

Class: customXajaxResponse

Source Location: /main/inc/lib/xajax/tests/customResponseClassTest.php

Class Overview

xajaxResponse
   |
   --customXajaxResponse

The xajaxResponse class is used to create responses to be sent back to your Web page. A response contains one or more command messages for updating your page.


Methods


Inherited Variables

Inherited Methods

Class: xajaxResponse

xajaxResponse::xajaxResponse()
The constructor's main job is to set the character encoding for the response.
xajaxResponse::addAlert()
Adds an alert command message to the XML response.
xajaxResponse::addAppend()
Adds an append command message to the XML response.
xajaxResponse::addAssign()
Adds an assign command message to the XML response.
xajaxResponse::addClear()
Adds a clear command message to the XML response.
xajaxResponse::addConfirmCommands()
Adds a confirm commands command message to the XML response.
xajaxResponse::addCreate()
Adds a create element command message to the XML response.
xajaxResponse::addCreateInput()
Adds a create input command message to the XML response.
xajaxResponse::addEvent()
Adds an event command message to the XML response.
xajaxResponse::addHandler()
Adds a handler command message to the XML response.
xajaxResponse::addIncludeScript()
Adds an include script command message to the XML response.
xajaxResponse::addInsert()
Adds a insert element command message to the XML response.
xajaxResponse::addInsertAfter()
Adds a insert element command message to the XML response.
xajaxResponse::addInsertInput()
Adds an insert input command message to the XML response.
xajaxResponse::addInsertInputAfter()
Adds an insert input command message to the XML response.
xajaxResponse::addPrepend()
Adds an prepend command message to the XML response.
xajaxResponse::addRedirect()
Uses the addScript() method to add a Javascript redirect to another URL.
xajaxResponse::addRemove()
Adds a remove element command message to the XML response.
xajaxResponse::addRemoveHandler()
Adds a remove handler command message to the XML response.
xajaxResponse::addReplace()
Adds a replace command message to the XML response.
xajaxResponse::addScript()
Adds a Javascript command message to the XML response.
xajaxResponse::addScriptCall()
Adds a Javascript function call command message to the XML response.
xajaxResponse::getXML()
Returns the XML to be returned from your function to the xajax processor on your page. Since xajax 0.2, you can also return an xajaxResponse object from your function directly, and xajax will automatically request the XML using this method call.
xajaxResponse::loadXML()
Adds the commands of the provided response XML output to this response object
xajaxResponse::outputEntitiesOff()
Tells the response object to output special characters intact. (default
xajaxResponse::outputEntitiesOn()
Tells the response object to convert special characters to HTML entities automatically (only works if the mb_string extension is available).
xajaxResponse::setCharEncoding()
Sets the character encoding for the response based on $sEncoding, which
xajaxResponse::_buildObjXml()
Recursively serializes a data structure in XML so it can be sent to the client. It could be thought of as the opposite of xajax::_parseObjXml().
xajaxResponse::_cmdXML()
Generates XML from command data

Class Details

[line 5]
The xajaxResponse class is used to create responses to be sent back to your Web page. A response contains one or more command messages for updating your page.

Currently xajax supports 21 kinds of command messages, including some common ones such as:

  • Assign - sets the specified attribute of an element in your page
  • Append - appends data to the end of the specified attribute of an element in your page
  • Prepend - prepends data to the beginning of the specified attribute of an element in your page
  • Replace - searches for and replaces data in the specified attribute of an element in your page
  • Script - runs the supplied JavaScript code
  • Alert - shows an alert box with the supplied message text

Note: elements are identified by their HTML id, so if you don't see your browser HTML display changing from the request, make sure you're using the right id names in your response.




[ Top ]


Class Methods


method addCreateOption [line 7]

void addCreateOption( $sSelectId, $sOptionId, $sOptionText, $sOptionValue)



Parameters:

   $sSelectId  
   $sOptionId  
   $sOptionText  
   $sOptionValue  

[ Top ]


Documentation generated on Thu, 12 Jun 2008 13:17:28 -0500 by phpDocumentor 1.4.1