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

Class: legacyXajaxResponse

Source Location: /pem-includes/xajax/xajax_core/legacy.inc.php

Class Overview

xajaxResponse
   |
   --legacyXajaxResponse

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::addCommand()
Adds a commmand to the array of all commands
xajaxResponse::addEvent()
Adds an event command message to the response.
xajaxResponse::addHandler()
Adds a handler command message to the response.
xajaxResponse::addPluginCommand()
Used internally by the response plugin system
xajaxResponse::alert()
Adds an alert command message to the response.
xajaxResponse::append()
Adds an append command message to the response.
xajaxResponse::assign()
Adds an assign command message to the response.
xajaxResponse::call()
Adds a Javascript function call command message to the response.
xajaxResponse::clear()
Adds a clear command message to the response.
xajaxResponse::confirmCommands()
Adds a confirm commands command message to the response.
xajaxResponse::create()
Adds a create element command message to the response.
xajaxResponse::createInput()
Adds a create input command message to the response.
xajaxResponse::getCommandCount()
Returns the number of commands current in the response
xajaxResponse::getContentType()
Returns the content type of the response (typically "text/xml").
xajaxResponse::getOutput()
Returns the output of the response suitable for sending to a Web browser (i. e., XML or JSON)
xajaxResponse::includeCSS()
Adds an include CSS command message to the response.
xajaxResponse::includeScript()
Adds an include script command message to the response.
xajaxResponse::includeScriptOnce()
Adds an include script once command message to the response.
xajaxResponse::insert()
Adds a insert element command message to the response.
xajaxResponse::insertAfter()
Adds a insert element command message to the response.
xajaxResponse::insertInput()
Adds an insert input command message to the response.
xajaxResponse::insertInputAfter()
Adds an insert input command message to the response.
xajaxResponse::loadCommands()
Adds the commands of the provided response to this response object
xajaxResponse::plugin()
Provides access to the xajaxResponse plugin system. If you use PHP 4 or 5, pass the plugin name as the first argument, the plugin's method name as the second argument, and subsequent arguments (if any) after that.
xajaxResponse::prepend()
Adds an prepend command message to the response.
xajaxResponse::redirect()
Uses the addScript() method to add a Javascript redirect to another URL.
xajaxResponse::remove()
Adds a remove element command message to the response.
xajaxResponse::removeCSS()
Adds a remove CSS command message to the response.
xajaxResponse::removeHandler()
Adds a remove handler command message to the response.
xajaxResponse::removeScript()
Removes a script reference so the browser can unload the .js file
xajaxResponse::replace()
Adds a replace command message to the response.
xajaxResponse::script()
Adds a Javascript command message to the response.
xajaxResponse::setCharEncoding()
Sets the character encoding for the response based on $sEncoding, which
xajaxResponse::setOutputEntities()
If true, tells the response object to convert special characters to HTML entities automatically (only works if the mb_string extension is available).
xajaxResponse::setReturnValue()
Stores a value (or array) that will be passed back as part of the response.
xajaxResponse::waitFor()
Adds a wait for command message to the response
xajaxResponse::waitForCSS()
Adds a wait For CSS command message to the response.
xajaxResponse::_getReturnValue()
returns an xml encoded string containing the return value to send
xajaxResponse::__get()
Internal function for PHP5 only. Used to permit plugins to be called as if they were native member variables of the xajaxResponse class.

Class Details

[line 2]
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 23 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 addAlert [line 11]

void addAlert( )



[ Top ]

method addAppend [line 7]

void addAppend( )



[ Top ]

method addAssign [line 6]

void addAssign( )



[ Top ]

method addClear [line 10]

void addClear( )



[ Top ]

method addConfirmCommands [line 5]

void addConfirmCommands( )



[ Top ]

method addCreate [line 16]

void addCreate( )



[ Top ]

method addCreateInput [line 19]

void addCreateInput( )



[ Top ]

method addIncludeCSS [line 24]

void addIncludeCSS( )



[ Top ]

method addIncludeScript [line 23]

void addIncludeScript( )



[ Top ]

method addInsert [line 17]

void addInsert( )



[ Top ]

method addInsertAfter [line 18]

void addInsertAfter( )



[ Top ]

method addInsertInput [line 20]

void addInsertInput( )



[ Top ]

method addInsertInputAfter [line 21]

void addInsertInputAfter( )



[ Top ]

method addPrepend [line 8]

void addPrepend( )



[ Top ]

method addRedirect [line 12]

void addRedirect( )



[ Top ]

method addRemove [line 15]

void addRemove( )



[ Top ]

method addRemoveHandler [line 22]

void addRemoveHandler( )



[ Top ]

method addReplace [line 9]

void addReplace( )



[ Top ]

method addScript [line 13]

void addScript( )



[ Top ]

method addScriptCall [line 14]

void addScriptCall( )



[ Top ]

method getXML [line 25]

void &getXML( )



[ Top ]

method outputEntitiesOff [line 4]

void outputEntitiesOff( )



[ Top ]

method outputEntitiesOn [line 3]

void outputEntitiesOn( )



[ Top ]


Documentation generated on Tue, 21 Aug 2007 14:49:44 -0500 by phpDocumentor 1.4.0a2