xajax-0.6-beta1.zip_xajax comet

<?php /* File: xajaxResponse.inc.php Contains the response class. Title: xajax response class Please see <copyright.inc.php> for a detailed description, copyright and license information. */ /* @package xajax @version $Id: xajaxResponse.inc.php 361 2007-05-24 12:48:14Z calltoconstruct $ @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White & J. Max Wilson @license http://www.xajaxproject.org/bsd_license.txt BSD License */ /* Class: xajaxResponse Collect commands to be sent back to the browser in response to a xajax request. Commands are encoded and packaged in a format that is acceptable to the response handler from the javascript library running on the client side. Common commands include: - <xajaxResponse->assign>: Assign a value to an elements property. - <xajaxResponse->append>: Append a value on to an elements property. - <xajaxResponse->script>: Execute a portion of javascript code. - <xajaxResponse->call>: Execute an existing javascript function. - <xajaxResponse->alert>: Display an alert dialog to the user. Elements are identified by the value of the HTML id attribute. If you do not see your updates occuring on the browser side, ensure that you are using the correct id in your response. */ class xajaxResponse { /* Array: aCommands Stores the commands that will be sent to the browser in the response. */ public $aCommands; /* String: sCharacterEncoding The name of the encoding method you wish to use when dealing with special characters. See <xajax->setEncoding> for more information. */ private $sCharacterEncoding; /* Boolean: bOutputEntities Convert special characters to the HTML equivellent. See also <xajax->bOutputEntities> and <xajax->configure>. */ private $bOutputEntities; /* Mixed: returnValue A string, array or integer value to be returned to the caller when using 'synchronous' mode requests. See <xajax->setMode> for details. */ private $returnValue; /* Object: objPluginManager A reference to the global plugin manager. */ private $objPluginManager; // sorry but this config is static atm private $sContentType = 'application/json'; //'text/xml'; /* Constructor: xajaxResponse Create and initialize a xajaxResponse object. */ public function __construct() { //SkipDebug if (0 < func_num_args()) { $objLanguageManager = xajaxLanguageManager::getInstance(); trigger_error( $objLanguageManager->getText('XJXRSP:EDERR:01') , E_USER_ERROR ); } //EndSkipDebug $this->aCommands = array(); $objResponseManager = xajaxResponseManager::getInstance(); $this->sCharacterEncoding = $objResponseManager->getCharacterEncoding(); $this->bOutputEntities = $objResponseManager->getOutputEntities(); $this->setResponseType($objResponseManager->getConfiguration('responseType')); $this->objPluginManager = xajaxPluginManager::getInstance(); } function getResponseType() { return $this->sResponseType; } function setResponseType($sResponseType) { if (NULL == $sResponseType) return; $this->sResponseType = $sResponseType ; if ('XML' == $sResponseType) { $this->setContentType('text/xml'); } elseif ('JSON' == $sResponseType) { $this->setContentType('application/json'); } } /* Function: setCharacterEncoding Overrides the default character encoding (or the one specified in the constructor) to the specified character encoding. Parameters: sCharacterEncoding - (string): The encoding method to use for this response. See also, <xajaxResponse->xajaxResponse>() Returns: object - The xajaxResponse object. */ public function setCharacterEncoding($sCharacterEncoding) { $this->sCharacterEncoding = $sCharacterEncoding; return $this; } /* Function: setOutputEntities Convert special characters to their HTML equivellent automatically (only works if the mb_string extension is available). Parameters: bOption - (boolean): Convert special characters Returns: object - The xajaxResponse object. */ public function setOutputEntities($bOutputEntities) { $this->bOutputEntities = (boolean)$bOutputEntities; return $this; } /* Function: plugin Provides access to registered response plugins. If you are using PHP 4 or 5, pass the plugin name as the first argument, the plugin method name as the second argument and subsequent arguments (if any) to be passed along to the plugin. Optionally, if you use PHP 5, you can pass just the plugin name as the first argument and the plugin object will be returned. You can then access the methods of the plugin directly. Parameters: sName - (string): Name of the plugin. sFunction - (string, optional): The name of the method to call. arg1...argn - (mixed, optional): Additional arguments to pass on to the plugin function. Returns: object - The plugin specified by sName. */ public function plugin() { $aArgs = func_get_args(); $nArgs = func_num_args(); //SkipDebug if (false == (0 < $nArgs)) { $objLanguageManager = xajaxLanguageManager::getInstance(); trigger_error( $objLanguageManager->getText('XJXRSP:MPERR:01') , E_USER_ERROR ); } //EndSkipDebug $sName = array_shift($aArgs); $objPlugin = $this->objPluginManager->getResponsePlugin($sName); if (false === $objPlugin) { $bReturn = false; return $bReturn; } $objPlugin->setResponse($this); if (0 < count($aArgs)) { $sMethod = array_shift($aArgs); $aFunction = array($objPlugin, $sMethod); call_user_func_array($aFunction, $aArgs); } return $objPlugin; } /* Function: __get Magic function for PHP 5. Used to permit plugins to be called as if they where native members of the xajaxResponse instance. Parameters: sPluginName - (string): The name of the plugin. Returns: object - The plugin specified by sPluginName. */ public function __get($sPluginName) { $objPlugin = $this->plugin($sPluginName); return $objPlugin; } /* Function: confirmCommands Response command that prompts user with [ok] [cancel] style message box. If the user clicks cancel, the specified number of response commands following this one, will be skipped. Parameters: iCmdNumber - (integer): The number of commands to skip upon cancel. sMessage - (string): The message to display to the user. Returns: object : The xajaxResponse object. */ public function confirmCommands($iCmdNumber, $sMessage) { return $this->addCommand( array( 'cmd'=>'cc', 'id'=>$iCmdNumber ), $sMessage ); } /* Function: assign Response command indicating that the specified value should be assigned to the given element's attribute. Parameters: sTarget - (string): The id of the html element on the browser. sAttribute - (string): The property to be assigned. sData - (string): The value to be assigned to the property. Returns: object : The <xajaxResponse> object. */ public function assign($sTarget,$sAttribute,$sData) { return $this->addCommand( array( 'cmd'=>'as', 'id'=>$sTarget, 'prop'=>$sAttribute ), $sData ); } /* Function: append Response command that indicates the specified data should be appended to the given element's property. Parameters: sTarget - (string): The id of the element to be updated. sAttribute - (string): The name of