* 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.
*
* @package chamilo.include.xajax
*/
class xajaxResponse
{
/**#@+
* @access protected
*/
/**
* @var string internal XML storage
*/
var $xml;
/**
* @var string the encoding type to use
*/
var $sEncoding;
/**
* @var boolean if special characters in the XML should be converted to
* entities
*/
var $bOutputEntities;
/**#@-*/
/**
* The constructor's main job is to set the character encoding for the
* response.
*
* Note: to change the character encoding for all of the
* responses, set the XAJAX_DEFAULT_ENCODING constant before you
* instantiate xajax.
*
* @param string contains the character encoding string to use
* @param boolean lets you set if you want special characters in the output
* converted to HTML entities
*
*/
public function __construct($sEncoding = XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities = false)
{
$this->setCharEncoding($sEncoding);
$this->bOutputEntities = $bOutputEntities;
}
/**
* Sets the character encoding for the response based on $sEncoding, which
* is a string containing the character encoding to use. You don't need to
* use this method normally, since the character encoding for the response
* gets set automatically based on the XAJAX_DEFAULT_CHAR_ENCODING
* constant.
*
* @param string
*/
public function setCharEncoding($sEncoding)
{
$this->sEncoding = $sEncoding;
}
/**
* Tells the response object to convert special characters to HTML entities
* automatically (only works if the mb_string extension is available).
*/
function outputEntitiesOn()
{
$this->bOutputEntities = true;
}
/**
* Tells the response object to output special characters intact. (default
* behavior)
*/
public function outputEntitiesOff()
{
$this->bOutputEntities = false;
}
/**
* Adds a confirm commands command message to the XML response.
*
* Usage: $objResponse->addConfirmCommands(1, "Do you want to preview the new data?");
*
* @param integer the number of commands to skip if the user presses
* Cancel in the browsers's confirm dialog
* @param string the message to show in the browser's confirm dialog
*/
public function addConfirmCommands($iCmdNumber, $sMessage)
{
$this->xml .= $this->_cmdXML(array("n" => "cc", "t" => $iCmdNumber), $sMessage);
}
/**
* Adds an assign command message to the XML response.
*
* Usage: $objResponse->addAssign("contentDiv", "innerHTML", "Some Text");
*
* @param string contains the id of an HTML element
* @param string the part of the element you wish to modify ("innerHTML",
* "value", etc.)
* @param string the data you want to set the attribute to
*/
public function addAssign($sTarget, $sAttribute, $sData)
{
$this->xml .= $this->_cmdXML(array("n" => "as", "t" => $sTarget, "p" => $sAttribute), $sData);
}
/**
* Adds an append command message to the XML response.
*
* Usage: $objResponse->addAppend("contentDiv", "innerHTML", "Some New Text");
*
* @param string contains the id of an HTML element
* @param string the part of the element you wish to modify ("innerHTML",
* "value", etc.)
* @param string the data you want to append to the end of the attribute
*/
public function addAppend($sTarget, $sAttribute, $sData)
{
$this->xml .= $this->_cmdXML(array("n" => "ap", "t" => $sTarget, "p" => $sAttribute), $sData);
}
/**
* Adds an prepend command message to the XML response.
*
* Usage: $objResponse->addPrepend("contentDiv", "innerHTML", "Some Starting Text");
*
* @param string contains the id of an HTML element
* @param string the part of the element you wish to modify ("innerHTML",
* "value", etc.)
* @param string the data you want to prepend to the beginning of the
* attribute
*/
public function addPrepend($sTarget, $sAttribute, $sData)
{
$this->xml .= $this->_cmdXML(array("n" => "pp", "t" => $sTarget, "p" => $sAttribute), $sData);
}
/**
* Adds a replace command message to the XML response.
*
* Usage: $objResponse->addReplace("contentDiv", "innerHTML", "text", "text");
*
* @param string contains the id of an HTML element
* @param string the part of the element you wish to modify ("innerHTML",
* "value", etc.)
* @param string the string to search for
* @param string the string to replace the search string when found in the
* attribute
*/
public function addReplace($sTarget, $sAttribute, $sSearch, $sData)
{
$sDta = "$r1 = $objResponse1->getXML();
* $objResponse2->loadXML($r1);
* return $objResponse2->getXML();
*
* @param string the response XML (returned from a getXML() method) to add
* to the end of this response object
*/
public function loadXML($mXML)
{
if (is_a($mXML, "xajaxResponse")) {
$mXML = $mXML->getXML();
}
$sNewXML = "";
$iStartPos = strpos($mXML, "") + 5;
$sNewXML = substr($mXML, $iStartPos);
$iEndPos = strpos($sNewXML, "");
$sNewXML = substr($sNewXML, 0, $iEndPos);
$this->xml .= $sNewXML;
}
/**
* Generates XML from command data
*
* @access private
* @param array associative array of attributes
* @param string data
* @return string XML command
*/
public function _cmdXML($aAttributes, $sData)
{
if ($this->bOutputEntities) {
// An adaptation for the Dokeos LMS, 22-AUG-2009.
if (function_exists('api_convert_encoding')) {
$sData = call_user_func_array(
'api_convert_encoding',
array(&$sData, 'HTML-ENTITIES', $this->sEncoding)
);
} //if (function_exists('mb_convert_encoding')) {
elseif (function_exists('mb_convert_encoding')) {
//
$sData = call_user_func_array('mb_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding));
} else {
trigger_error(
"The xajax XML response output could not be converted to HTML entities because the mb_convert_encoding function is not available",
E_USER_NOTICE
);
}
}
$xml = " $sValue) {
$xml .= " $sAttribute=\"$sValue\"";
}
if ($sData !== null && !stristr($sData, '";
} else {
if ($sData !== null) {
$xml .= ">$sData";
} else {
$xml .= ">";
}
}
return $xml;
}
/**
* Recursively serializes a data structure in XML so it can be sent to
* the client. It could be thought of as the opposite of
* {@link xajax::_parseObjXml()}.
*
* @access private
* @param mixed data structure to serialize to XML
* @return string serialized XML
*/
public function _buildObjXml($var)
{
if (gettype($var) == "object") {
$var = get_object_vars($var);
}
if (!is_array($var)) {
return "";
} else {
$data = "";
foreach ($var as $key => $value) {
$data .= "";
$data .= "".htmlspecialchars($key)."";
$data .= "".$this->_buildObjXml($value)."";
$data .= "";
}
$data .= "";
return $data;
}
}
}