@@ -67,521 +67,521 @@ |
||
| 67 | 67 | */ |
| 68 | 68 | class xajaxResponse |
| 69 | 69 | { |
| 70 | - /**#@+ |
|
| 70 | + /**#@+ |
|
| 71 | 71 | * @access protected |
| 72 | 72 | */ |
| 73 | - /** |
|
| 74 | - * @var string internal XML storage |
|
| 75 | - */ |
|
| 76 | - var $xml; |
|
| 77 | - /** |
|
| 78 | - * @var string the encoding type to use |
|
| 79 | - */ |
|
| 80 | - var $sEncoding; |
|
| 81 | - /** |
|
| 82 | - * @var boolean if special characters in the XML should be converted to |
|
| 83 | - * entities |
|
| 84 | - */ |
|
| 85 | - var $bOutputEntities; |
|
| 86 | - |
|
| 87 | - /**#@-*/ |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * The constructor's main job is to set the character encoding for the |
|
| 91 | - * response. |
|
| 92 | - * |
|
| 93 | - * <i>Note:</i> to change the character encoding for all of the |
|
| 94 | - * responses, set the XAJAX_DEFAULT_ENCODING constant before you |
|
| 95 | - * instantiate xajax. |
|
| 96 | - * |
|
| 97 | - * @param string contains the character encoding string to use |
|
| 98 | - * @param boolean lets you set if you want special characters in the output |
|
| 99 | - * converted to HTML entities |
|
| 100 | - * |
|
| 101 | - */ |
|
| 102 | - public function __construct($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false) |
|
| 103 | - { |
|
| 104 | - $this->setCharEncoding($sEncoding); |
|
| 105 | - $this->bOutputEntities = $bOutputEntities; |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * Sets the character encoding for the response based on $sEncoding, which |
|
| 110 | - * is a string containing the character encoding to use. You don't need to |
|
| 111 | - * use this method normally, since the character encoding for the response |
|
| 112 | - * gets set automatically based on the XAJAX_DEFAULT_CHAR_ENCODING |
|
| 113 | - * constant. |
|
| 114 | - * |
|
| 115 | - * @param string |
|
| 116 | - */ |
|
| 117 | - function setCharEncoding($sEncoding) |
|
| 118 | - { |
|
| 119 | - $this->sEncoding = $sEncoding; |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Tells the response object to convert special characters to HTML entities |
|
| 124 | - * automatically (only works if the mb_string extension is available). |
|
| 125 | - */ |
|
| 126 | - function outputEntitiesOn() |
|
| 127 | - { |
|
| 128 | - $this->bOutputEntities = true; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * Tells the response object to output special characters intact. (default |
|
| 133 | - * behavior) |
|
| 134 | - */ |
|
| 135 | - function outputEntitiesOff() |
|
| 136 | - { |
|
| 137 | - $this->bOutputEntities = false; |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * Adds a confirm commands command message to the XML response. |
|
| 142 | - * |
|
| 143 | - * <i>Usage:</i> <kbd>$objResponse->addConfirmCommands(1, "Do you want to preview the new data?");</kbd> |
|
| 144 | - * |
|
| 145 | - * @param integer the number of commands to skip if the user presses |
|
| 146 | - * Cancel in the browsers's confirm dialog |
|
| 147 | - * @param string the message to show in the browser's confirm dialog |
|
| 148 | - */ |
|
| 149 | - function addConfirmCommands($iCmdNumber, $sMessage) |
|
| 150 | - { |
|
| 151 | - $this->xml .= $this->_cmdXML(array("n"=>"cc","t"=>$iCmdNumber),$sMessage); |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * Adds an assign command message to the XML response. |
|
| 156 | - * |
|
| 157 | - * <i>Usage:</i> <kbd>$objResponse->addAssign("contentDiv", "innerHTML", "Some Text");</kbd> |
|
| 158 | - * |
|
| 159 | - * @param string contains the id of an HTML element |
|
| 160 | - * @param string the part of the element you wish to modify ("innerHTML", |
|
| 161 | - * "value", etc.) |
|
| 162 | - * @param string the data you want to set the attribute to |
|
| 163 | - */ |
|
| 164 | - function addAssign($sTarget,$sAttribute,$sData) |
|
| 165 | - { |
|
| 166 | - $this->xml .= $this->_cmdXML(array("n"=>"as","t"=>$sTarget,"p"=>$sAttribute),$sData); |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * Adds an append command message to the XML response. |
|
| 171 | - * |
|
| 172 | - * <i>Usage:</i> <kbd>$objResponse->addAppend("contentDiv", "innerHTML", "Some New Text");</kbd> |
|
| 173 | - * |
|
| 174 | - * @param string contains the id of an HTML element |
|
| 175 | - * @param string the part of the element you wish to modify ("innerHTML", |
|
| 176 | - * "value", etc.) |
|
| 177 | - * @param string the data you want to append to the end of the attribute |
|
| 178 | - */ |
|
| 179 | - function addAppend($sTarget,$sAttribute,$sData) |
|
| 180 | - { |
|
| 181 | - $this->xml .= $this->_cmdXML(array("n"=>"ap","t"=>$sTarget,"p"=>$sAttribute),$sData); |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - /** |
|
| 185 | - * Adds an prepend command message to the XML response. |
|
| 186 | - * |
|
| 187 | - * <i>Usage:</i> <kbd>$objResponse->addPrepend("contentDiv", "innerHTML", "Some Starting Text");</kbd> |
|
| 188 | - * |
|
| 189 | - * @param string contains the id of an HTML element |
|
| 190 | - * @param string the part of the element you wish to modify ("innerHTML", |
|
| 191 | - * "value", etc.) |
|
| 192 | - * @param string the data you want to prepend to the beginning of the |
|
| 193 | - * attribute |
|
| 194 | - */ |
|
| 195 | - function addPrepend($sTarget,$sAttribute,$sData) |
|
| 196 | - { |
|
| 197 | - $this->xml .= $this->_cmdXML(array("n"=>"pp","t"=>$sTarget,"p"=>$sAttribute),$sData); |
|
| 198 | - } |
|
| 199 | - |
|
| 200 | - /** |
|
| 201 | - * Adds a replace command message to the XML response. |
|
| 202 | - * |
|
| 203 | - * <i>Usage:</i> <kbd>$objResponse->addReplace("contentDiv", "innerHTML", "text", "<b>text</b>");</kbd> |
|
| 204 | - * |
|
| 205 | - * @param string contains the id of an HTML element |
|
| 206 | - * @param string the part of the element you wish to modify ("innerHTML", |
|
| 207 | - * "value", etc.) |
|
| 208 | - * @param string the string to search for |
|
| 209 | - * @param string the string to replace the search string when found in the |
|
| 210 | - * attribute |
|
| 211 | - */ |
|
| 212 | - function addReplace($sTarget,$sAttribute,$sSearch,$sData) |
|
| 213 | - { |
|
| 214 | - $sDta = "<s><![CDATA[$sSearch]]></s><r><![CDATA[$sData]]></r>"; |
|
| 215 | - $this->xml .= $this->_cmdXML(array("n"=>"rp","t"=>$sTarget,"p"=>$sAttribute),$sDta); |
|
| 216 | - } |
|
| 217 | - |
|
| 218 | - /** |
|
| 219 | - * Adds a clear command message to the XML response. |
|
| 220 | - * |
|
| 221 | - * <i>Usage:</i> <kbd>$objResponse->addClear("contentDiv", "innerHTML");</kbd> |
|
| 222 | - * |
|
| 223 | - * @param string contains the id of an HTML element |
|
| 224 | - * @param string the part of the element you wish to clear ("innerHTML", |
|
| 225 | - * "value", etc.) |
|
| 226 | - */ |
|
| 227 | - function addClear($sTarget,$sAttribute) |
|
| 228 | - { |
|
| 229 | - $this->addAssign($sTarget,$sAttribute,''); |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - /** |
|
| 233 | - * Adds an alert command message to the XML response. |
|
| 234 | - * |
|
| 235 | - * <i>Usage:</i> <kbd>$objResponse->addAlert("This is important information");</kbd> |
|
| 236 | - * |
|
| 237 | - * @param string the text to be displayed in the Javascript alert box |
|
| 238 | - */ |
|
| 239 | - function addAlert($sMsg) |
|
| 240 | - { |
|
| 241 | - $this->xml .= $this->_cmdXML(array("n"=>"al"),$sMsg); |
|
| 242 | - } |
|
| 243 | - |
|
| 244 | - /** |
|
| 245 | - * Uses the addScript() method to add a Javascript redirect to another URL. |
|
| 246 | - * |
|
| 247 | - * <i>Usage:</i> <kbd>$objResponse->addRedirect("http://www.xajaxproject.org");</kbd> |
|
| 248 | - * |
|
| 249 | - * @param string the URL to redirect the client browser to |
|
| 250 | - */ |
|
| 251 | - function addRedirect($sURL) |
|
| 252 | - { |
|
| 253 | - //we need to parse the query part so that the values are rawurlencode()'ed |
|
| 254 | - //can't just use parse_url() cos we could be dealing with a relative URL which |
|
| 255 | - // parse_url() can't deal with. |
|
| 256 | - $queryStart = strpos($sURL, '?', strrpos($sURL, '/')); |
|
| 257 | - if ($queryStart !== FALSE) |
|
| 258 | - { |
|
| 259 | - $queryStart++; |
|
| 260 | - $queryEnd = strpos($sURL, '#', $queryStart); |
|
| 261 | - if ($queryEnd === FALSE) |
|
| 262 | - $queryEnd = strlen($sURL); |
|
| 263 | - $queryPart = substr($sURL, $queryStart, $queryEnd-$queryStart); |
|
| 73 | + /** |
|
| 74 | + * @var string internal XML storage |
|
| 75 | + */ |
|
| 76 | + var $xml; |
|
| 77 | + /** |
|
| 78 | + * @var string the encoding type to use |
|
| 79 | + */ |
|
| 80 | + var $sEncoding; |
|
| 81 | + /** |
|
| 82 | + * @var boolean if special characters in the XML should be converted to |
|
| 83 | + * entities |
|
| 84 | + */ |
|
| 85 | + var $bOutputEntities; |
|
| 86 | + |
|
| 87 | + /**#@-*/ |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * The constructor's main job is to set the character encoding for the |
|
| 91 | + * response. |
|
| 92 | + * |
|
| 93 | + * <i>Note:</i> to change the character encoding for all of the |
|
| 94 | + * responses, set the XAJAX_DEFAULT_ENCODING constant before you |
|
| 95 | + * instantiate xajax. |
|
| 96 | + * |
|
| 97 | + * @param string contains the character encoding string to use |
|
| 98 | + * @param boolean lets you set if you want special characters in the output |
|
| 99 | + * converted to HTML entities |
|
| 100 | + * |
|
| 101 | + */ |
|
| 102 | + public function __construct($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false) |
|
| 103 | + { |
|
| 104 | + $this->setCharEncoding($sEncoding); |
|
| 105 | + $this->bOutputEntities = $bOutputEntities; |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * Sets the character encoding for the response based on $sEncoding, which |
|
| 110 | + * is a string containing the character encoding to use. You don't need to |
|
| 111 | + * use this method normally, since the character encoding for the response |
|
| 112 | + * gets set automatically based on the XAJAX_DEFAULT_CHAR_ENCODING |
|
| 113 | + * constant. |
|
| 114 | + * |
|
| 115 | + * @param string |
|
| 116 | + */ |
|
| 117 | + function setCharEncoding($sEncoding) |
|
| 118 | + { |
|
| 119 | + $this->sEncoding = $sEncoding; |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Tells the response object to convert special characters to HTML entities |
|
| 124 | + * automatically (only works if the mb_string extension is available). |
|
| 125 | + */ |
|
| 126 | + function outputEntitiesOn() |
|
| 127 | + { |
|
| 128 | + $this->bOutputEntities = true; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * Tells the response object to output special characters intact. (default |
|
| 133 | + * behavior) |
|
| 134 | + */ |
|
| 135 | + function outputEntitiesOff() |
|
| 136 | + { |
|
| 137 | + $this->bOutputEntities = false; |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * Adds a confirm commands command message to the XML response. |
|
| 142 | + * |
|
| 143 | + * <i>Usage:</i> <kbd>$objResponse->addConfirmCommands(1, "Do you want to preview the new data?");</kbd> |
|
| 144 | + * |
|
| 145 | + * @param integer the number of commands to skip if the user presses |
|
| 146 | + * Cancel in the browsers's confirm dialog |
|
| 147 | + * @param string the message to show in the browser's confirm dialog |
|
| 148 | + */ |
|
| 149 | + function addConfirmCommands($iCmdNumber, $sMessage) |
|
| 150 | + { |
|
| 151 | + $this->xml .= $this->_cmdXML(array("n"=>"cc","t"=>$iCmdNumber),$sMessage); |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * Adds an assign command message to the XML response. |
|
| 156 | + * |
|
| 157 | + * <i>Usage:</i> <kbd>$objResponse->addAssign("contentDiv", "innerHTML", "Some Text");</kbd> |
|
| 158 | + * |
|
| 159 | + * @param string contains the id of an HTML element |
|
| 160 | + * @param string the part of the element you wish to modify ("innerHTML", |
|
| 161 | + * "value", etc.) |
|
| 162 | + * @param string the data you want to set the attribute to |
|
| 163 | + */ |
|
| 164 | + function addAssign($sTarget,$sAttribute,$sData) |
|
| 165 | + { |
|
| 166 | + $this->xml .= $this->_cmdXML(array("n"=>"as","t"=>$sTarget,"p"=>$sAttribute),$sData); |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * Adds an append command message to the XML response. |
|
| 171 | + * |
|
| 172 | + * <i>Usage:</i> <kbd>$objResponse->addAppend("contentDiv", "innerHTML", "Some New Text");</kbd> |
|
| 173 | + * |
|
| 174 | + * @param string contains the id of an HTML element |
|
| 175 | + * @param string the part of the element you wish to modify ("innerHTML", |
|
| 176 | + * "value", etc.) |
|
| 177 | + * @param string the data you want to append to the end of the attribute |
|
| 178 | + */ |
|
| 179 | + function addAppend($sTarget,$sAttribute,$sData) |
|
| 180 | + { |
|
| 181 | + $this->xml .= $this->_cmdXML(array("n"=>"ap","t"=>$sTarget,"p"=>$sAttribute),$sData); |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + /** |
|
| 185 | + * Adds an prepend command message to the XML response. |
|
| 186 | + * |
|
| 187 | + * <i>Usage:</i> <kbd>$objResponse->addPrepend("contentDiv", "innerHTML", "Some Starting Text");</kbd> |
|
| 188 | + * |
|
| 189 | + * @param string contains the id of an HTML element |
|
| 190 | + * @param string the part of the element you wish to modify ("innerHTML", |
|
| 191 | + * "value", etc.) |
|
| 192 | + * @param string the data you want to prepend to the beginning of the |
|
| 193 | + * attribute |
|
| 194 | + */ |
|
| 195 | + function addPrepend($sTarget,$sAttribute,$sData) |
|
| 196 | + { |
|
| 197 | + $this->xml .= $this->_cmdXML(array("n"=>"pp","t"=>$sTarget,"p"=>$sAttribute),$sData); |
|
| 198 | + } |
|
| 199 | + |
|
| 200 | + /** |
|
| 201 | + * Adds a replace command message to the XML response. |
|
| 202 | + * |
|
| 203 | + * <i>Usage:</i> <kbd>$objResponse->addReplace("contentDiv", "innerHTML", "text", "<b>text</b>");</kbd> |
|
| 204 | + * |
|
| 205 | + * @param string contains the id of an HTML element |
|
| 206 | + * @param string the part of the element you wish to modify ("innerHTML", |
|
| 207 | + * "value", etc.) |
|
| 208 | + * @param string the string to search for |
|
| 209 | + * @param string the string to replace the search string when found in the |
|
| 210 | + * attribute |
|
| 211 | + */ |
|
| 212 | + function addReplace($sTarget,$sAttribute,$sSearch,$sData) |
|
| 213 | + { |
|
| 214 | + $sDta = "<s><![CDATA[$sSearch]]></s><r><![CDATA[$sData]]></r>"; |
|
| 215 | + $this->xml .= $this->_cmdXML(array("n"=>"rp","t"=>$sTarget,"p"=>$sAttribute),$sDta); |
|
| 216 | + } |
|
| 217 | + |
|
| 218 | + /** |
|
| 219 | + * Adds a clear command message to the XML response. |
|
| 220 | + * |
|
| 221 | + * <i>Usage:</i> <kbd>$objResponse->addClear("contentDiv", "innerHTML");</kbd> |
|
| 222 | + * |
|
| 223 | + * @param string contains the id of an HTML element |
|
| 224 | + * @param string the part of the element you wish to clear ("innerHTML", |
|
| 225 | + * "value", etc.) |
|
| 226 | + */ |
|
| 227 | + function addClear($sTarget,$sAttribute) |
|
| 228 | + { |
|
| 229 | + $this->addAssign($sTarget,$sAttribute,''); |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + /** |
|
| 233 | + * Adds an alert command message to the XML response. |
|
| 234 | + * |
|
| 235 | + * <i>Usage:</i> <kbd>$objResponse->addAlert("This is important information");</kbd> |
|
| 236 | + * |
|
| 237 | + * @param string the text to be displayed in the Javascript alert box |
|
| 238 | + */ |
|
| 239 | + function addAlert($sMsg) |
|
| 240 | + { |
|
| 241 | + $this->xml .= $this->_cmdXML(array("n"=>"al"),$sMsg); |
|
| 242 | + } |
|
| 243 | + |
|
| 244 | + /** |
|
| 245 | + * Uses the addScript() method to add a Javascript redirect to another URL. |
|
| 246 | + * |
|
| 247 | + * <i>Usage:</i> <kbd>$objResponse->addRedirect("http://www.xajaxproject.org");</kbd> |
|
| 248 | + * |
|
| 249 | + * @param string the URL to redirect the client browser to |
|
| 250 | + */ |
|
| 251 | + function addRedirect($sURL) |
|
| 252 | + { |
|
| 253 | + //we need to parse the query part so that the values are rawurlencode()'ed |
|
| 254 | + //can't just use parse_url() cos we could be dealing with a relative URL which |
|
| 255 | + // parse_url() can't deal with. |
|
| 256 | + $queryStart = strpos($sURL, '?', strrpos($sURL, '/')); |
|
| 257 | + if ($queryStart !== FALSE) |
|
| 258 | + { |
|
| 259 | + $queryStart++; |
|
| 260 | + $queryEnd = strpos($sURL, '#', $queryStart); |
|
| 261 | + if ($queryEnd === FALSE) |
|
| 262 | + $queryEnd = strlen($sURL); |
|
| 263 | + $queryPart = substr($sURL, $queryStart, $queryEnd-$queryStart); |
|
| 264 | 264 | $queryParts = array(); |
| 265 | - parse_str($queryPart, $queryParts); |
|
| 266 | - $newQueryPart = ""; |
|
| 267 | - foreach($queryParts as $key => $value) |
|
| 268 | - { |
|
| 269 | - $newQueryPart .= rawurlencode($key).'='.rawurlencode($value).ini_get('arg_separator.output'); |
|
| 270 | - } |
|
| 271 | - $sURL = str_replace($queryPart, $newQueryPart, $sURL); |
|
| 272 | - } |
|
| 273 | - $this->addScript('window.location = "'.$sURL.'";'); |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - /** |
|
| 277 | - * Adds a Javascript command message to the XML response. |
|
| 278 | - * |
|
| 279 | - * <i>Usage:</i> <kbd>$objResponse->addScript("var x = prompt('get some text');");</kbd> |
|
| 280 | - * |
|
| 281 | - * @param string contains Javascript code to be executed |
|
| 282 | - */ |
|
| 283 | - function addScript($sJS) |
|
| 284 | - { |
|
| 285 | - $this->xml .= $this->_cmdXML(array("n"=>"js"),$sJS); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Adds a Javascript function call command message to the XML response. |
|
| 290 | - * |
|
| 291 | - * <i>Usage:</i> <kbd>$objResponse->addScriptCall("myJSFunction", "arg 1", "arg 2", 12345);</kbd> |
|
| 292 | - * |
|
| 293 | - * @param string $sFunc the name of a Javascript function |
|
| 294 | - * @param mixed $args,... optional arguments to pass to the Javascript function |
|
| 295 | - */ |
|
| 296 | - function addScriptCall() { |
|
| 297 | - $arguments = func_get_args(); |
|
| 298 | - $sFunc = array_shift($arguments); |
|
| 299 | - $sData = $this->_buildObjXml($arguments); |
|
| 300 | - $this->xml .= $this->_cmdXML(array("n"=>"jc","t"=>$sFunc),$sData); |
|
| 301 | - } |
|
| 302 | - |
|
| 303 | - /** |
|
| 304 | - * Adds a remove element command message to the XML response. |
|
| 305 | - * |
|
| 306 | - * <i>Usage:</i> <kbd>$objResponse->addRemove("Div2");</kbd> |
|
| 307 | - * |
|
| 308 | - * @param string contains the id of an HTML element to be removed |
|
| 309 | - */ |
|
| 310 | - function addRemove($sTarget) |
|
| 311 | - { |
|
| 312 | - $this->xml .= $this->_cmdXML(array("n"=>"rm","t"=>$sTarget),''); |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - /** |
|
| 316 | - * Adds a create element command message to the XML response. |
|
| 317 | - * |
|
| 318 | - * <i>Usage:</i> <kbd>$objResponse->addCreate("parentDiv", "h3", "myid");</kbd> |
|
| 319 | - * |
|
| 320 | - * @param string contains the id of an HTML element to to which the new |
|
| 321 | - * element will be appended. |
|
| 322 | - * @param string the tag to be added |
|
| 323 | - * @param string the id to be assigned to the new element |
|
| 324 | - * @param string deprecated, use the addCreateInput() method instead |
|
| 325 | - */ |
|
| 326 | - function addCreate($sParent, $sTag, $sId, $sType="") |
|
| 327 | - { |
|
| 328 | - if ($sType) |
|
| 329 | - { |
|
| 330 | - trigger_error("The \$sType parameter of addCreate has been deprecated. Use the addCreateInput() method instead.", E_USER_WARNING); |
|
| 331 | - return; |
|
| 332 | - } |
|
| 333 | - $this->xml .= $this->_cmdXML(array("n"=>"ce","t"=>$sParent,"p"=>$sId),$sTag); |
|
| 334 | - } |
|
| 335 | - |
|
| 336 | - /** |
|
| 337 | - * Adds a insert element command message to the XML response. |
|
| 338 | - * |
|
| 339 | - * <i>Usage:</i> <kbd>$objResponse->addInsert("childDiv", "h3", "myid");</kbd> |
|
| 340 | - * |
|
| 341 | - * @param string contains the id of the child before which the new element |
|
| 342 | - * will be inserted |
|
| 343 | - * @param string the tag to be added |
|
| 344 | - * @param string the id to be assigned to the new element |
|
| 345 | - */ |
|
| 346 | - function addInsert($sBefore, $sTag, $sId) |
|
| 347 | - { |
|
| 348 | - $this->xml .= $this->_cmdXML(array("n"=>"ie","t"=>$sBefore,"p"=>$sId),$sTag); |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - /** |
|
| 352 | - * Adds a insert element command message to the XML response. |
|
| 353 | - * |
|
| 354 | - * <i>Usage:</i> <kbd>$objResponse->addInsertAfter("childDiv", "h3", "myid");</kbd> |
|
| 355 | - * |
|
| 356 | - * @param string contains the id of the child after which the new element |
|
| 357 | - * will be inserted |
|
| 358 | - * @param string the tag to be added |
|
| 359 | - * @param string the id to be assigned to the new element |
|
| 360 | - */ |
|
| 361 | - function addInsertAfter($sAfter, $sTag, $sId) |
|
| 362 | - { |
|
| 363 | - $this->xml .= $this->_cmdXML(array("n"=>"ia","t"=>$sAfter,"p"=>$sId),$sTag); |
|
| 364 | - } |
|
| 365 | - |
|
| 366 | - /** |
|
| 367 | - * Adds a create input command message to the XML response. |
|
| 368 | - * |
|
| 369 | - * <i>Usage:</i> <kbd>$objResponse->addCreateInput("form1", "text", "username", "input1");</kbd> |
|
| 370 | - * |
|
| 371 | - * @param string contains the id of an HTML element to which the new input |
|
| 372 | - * will be appended |
|
| 373 | - * @param string the type of input to be created (text, radio, checkbox, |
|
| 374 | - * etc.) |
|
| 375 | - * @param string the name to be assigned to the new input and the variable |
|
| 376 | - * name when it is submitted |
|
| 377 | - * @param string the id to be assigned to the new input |
|
| 378 | - */ |
|
| 379 | - function addCreateInput($sParent, $sType, $sName, $sId) |
|
| 380 | - { |
|
| 381 | - $this->xml .= $this->_cmdXML(array("n"=>"ci","t"=>$sParent,"p"=>$sId,"c"=>$sType),$sName); |
|
| 382 | - } |
|
| 383 | - |
|
| 384 | - /** |
|
| 385 | - * Adds an insert input command message to the XML response. |
|
| 386 | - * |
|
| 387 | - * <i>Usage:</i> <kbd>$objResponse->addInsertInput("input5", "text", "username", "input1");</kbd> |
|
| 388 | - * |
|
| 389 | - * @param string contains the id of the child before which the new element |
|
| 390 | - * will be inserted |
|
| 391 | - * @param string the type of input to be created (text, radio, checkbox, |
|
| 392 | - * etc.) |
|
| 393 | - * @param string the name to be assigned to the new input and the variable |
|
| 394 | - * name when it is submitted |
|
| 395 | - * @param string the id to be assigned to the new input |
|
| 396 | - */ |
|
| 397 | - function addInsertInput($sBefore, $sType, $sName, $sId) |
|
| 398 | - { |
|
| 399 | - $this->xml .= $this->_cmdXML(array("n"=>"ii","t"=>$sBefore,"p"=>$sId,"c"=>$sType),$sName); |
|
| 400 | - } |
|
| 401 | - |
|
| 402 | - /** |
|
| 403 | - * Adds an insert input command message to the XML response. |
|
| 404 | - * |
|
| 405 | - * <i>Usage:</i> <kbd>$objResponse->addInsertInputAfter("input7", "text", "email", "input2");</kbd> |
|
| 406 | - * |
|
| 407 | - * @param string contains the id of the child after which the new element |
|
| 408 | - * will be inserted |
|
| 409 | - * @param string the type of input to be created (text, radio, checkbox, |
|
| 410 | - * etc.) |
|
| 411 | - * @param string the name to be assigned to the new input and the variable |
|
| 412 | - * name when it is submitted |
|
| 413 | - * @param string the id to be assigned to the new input |
|
| 414 | - */ |
|
| 415 | - function addInsertInputAfter($sAfter, $sType, $sName, $sId) |
|
| 416 | - { |
|
| 417 | - $this->xml .= $this->_cmdXML(array("n"=>"iia","t"=>$sAfter,"p"=>$sId,"c"=>$sType),$sName); |
|
| 418 | - } |
|
| 419 | - |
|
| 420 | - /** |
|
| 421 | - * Adds an event command message to the XML response. |
|
| 422 | - * |
|
| 423 | - * <i>Usage:</i> <kbd>$objResponse->addEvent("contentDiv", "onclick", "alert(\'Hello World\');");</kbd> |
|
| 424 | - * |
|
| 425 | - * @param string contains the id of an HTML element |
|
| 426 | - * @param string the event you wish to set ("onclick", "onmouseover", etc.) |
|
| 427 | - * @param string the Javascript string you want the event to invoke |
|
| 428 | - */ |
|
| 429 | - function addEvent($sTarget,$sEvent,$sScript) |
|
| 430 | - { |
|
| 431 | - $this->xml .= $this->_cmdXML(array("n"=>"ev","t"=>$sTarget,"p"=>$sEvent),$sScript); |
|
| 432 | - } |
|
| 433 | - |
|
| 434 | - /** |
|
| 435 | - * Adds a handler command message to the XML response. |
|
| 436 | - * |
|
| 437 | - * <i>Usage:</i> <kbd>$objResponse->addHandler("contentDiv", "onclick", "content_click");</kbd> |
|
| 438 | - * |
|
| 439 | - * @param string contains the id of an HTML element |
|
| 440 | - * @param string the event you wish to set ("onclick", "onmouseover", etc.) |
|
| 441 | - * @param string the name of a Javascript function that will handle the |
|
| 442 | - * event. Multiple handlers can be added for the same event |
|
| 443 | - */ |
|
| 444 | - function addHandler($sTarget,$sEvent,$sHandler) |
|
| 445 | - { |
|
| 446 | - $this->xml .= $this->_cmdXML(array("n"=>"ah","t"=>$sTarget,"p"=>$sEvent),$sHandler); |
|
| 447 | - } |
|
| 448 | - |
|
| 449 | - /** |
|
| 450 | - * Adds a remove handler command message to the XML response. |
|
| 451 | - * |
|
| 452 | - * <i>Usage:</i> <kbd>$objResponse->addRemoveHandler("contentDiv", "onclick", "content_click");</kbd> |
|
| 453 | - * |
|
| 454 | - * @param string contains the id of an HTML element |
|
| 455 | - * @param string the event you wish to remove ("onclick", "onmouseover", |
|
| 456 | - * etc.) |
|
| 457 | - * @param string the name of a Javascript handler function that you want to |
|
| 458 | - * remove |
|
| 459 | - */ |
|
| 460 | - function addRemoveHandler($sTarget,$sEvent,$sHandler) |
|
| 461 | - { |
|
| 462 | - $this->xml .= $this->_cmdXML(array("n"=>"rh","t"=>$sTarget,"p"=>$sEvent),$sHandler); |
|
| 463 | - } |
|
| 464 | - |
|
| 465 | - /** |
|
| 466 | - * Adds an include script command message to the XML response. |
|
| 467 | - * |
|
| 468 | - * <i>Usage:</i> <kbd>$objResponse->addIncludeScript("functions.js");</kbd> |
|
| 469 | - * |
|
| 470 | - * @param string URL of the Javascript file to include |
|
| 471 | - */ |
|
| 472 | - function addIncludeScript($sFileName) |
|
| 473 | - { |
|
| 474 | - $this->xml .= $this->_cmdXML(array("n"=>"in"),$sFileName); |
|
| 475 | - } |
|
| 476 | - |
|
| 477 | - /** |
|
| 478 | - * Returns the XML to be returned from your function to the xajax processor |
|
| 479 | - * on your page. Since xajax 0.2, you can also return an xajaxResponse |
|
| 480 | - * object from your function directly, and xajax will automatically request |
|
| 481 | - * the XML using this method call. |
|
| 482 | - * |
|
| 483 | - * <i>Usage:</i> <kbd>return $objResponse->getXML();</kbd> |
|
| 484 | - * |
|
| 485 | - * @return string response XML data |
|
| 486 | - */ |
|
| 487 | - function getXML() |
|
| 488 | - { |
|
| 489 | - $sXML = "<?xml version=\"1.0\""; |
|
| 490 | - if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0) |
|
| 491 | - $sXML .= " encoding=\"".$this->sEncoding."\""; |
|
| 492 | - $sXML .= " ?"."><xjx>" . $this->xml . "</xjx>"; |
|
| 493 | - |
|
| 494 | - return $sXML; |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - /** |
|
| 498 | - * Adds the commands of the provided response XML output to this response |
|
| 499 | - * object |
|
| 500 | - * |
|
| 501 | - * <i>Usage:</i> |
|
| 502 | - * <code>$r1 = $objResponse1->getXML(); |
|
| 503 | - * $objResponse2->loadXML($r1); |
|
| 504 | - * return $objResponse2->getXML();</code> |
|
| 505 | - * |
|
| 506 | - * @param string the response XML (returned from a getXML() method) to add |
|
| 507 | - * to the end of this response object |
|
| 508 | - */ |
|
| 509 | - function loadXML($mXML) |
|
| 510 | - { |
|
| 511 | - if (is_a($mXML, "xajaxResponse")) { |
|
| 512 | - $mXML = $mXML->getXML(); |
|
| 513 | - } |
|
| 514 | - $sNewXML = ""; |
|
| 515 | - $iStartPos = strpos($mXML, "<xjx>") + 5; |
|
| 516 | - $sNewXML = substr($mXML, $iStartPos); |
|
| 517 | - $iEndPos = strpos($sNewXML, "</xjx>"); |
|
| 518 | - $sNewXML = substr($sNewXML, 0, $iEndPos); |
|
| 519 | - $this->xml .= $sNewXML; |
|
| 520 | - } |
|
| 521 | - |
|
| 522 | - /** |
|
| 523 | - * Generates XML from command data |
|
| 524 | - * |
|
| 525 | - * @access private |
|
| 526 | - * @param array associative array of attributes |
|
| 527 | - * @param string data |
|
| 528 | - * @return string XML command |
|
| 529 | - */ |
|
| 530 | - function _cmdXML($aAttributes, $sData) |
|
| 531 | - { |
|
| 532 | - if ($this->bOutputEntities) { |
|
| 533 | - // An adaptation for the Dokeos LMS, 22-AUG-2009. |
|
| 534 | - if (function_exists('api_convert_encoding')) { |
|
| 535 | - $sData = call_user_func_array('api_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding)); |
|
| 536 | - } |
|
| 537 | - //if (function_exists('mb_convert_encoding')) { |
|
| 538 | - elseif (function_exists('mb_convert_encoding')) { |
|
| 539 | - // |
|
| 540 | - $sData = call_user_func_array('mb_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding)); |
|
| 541 | - } |
|
| 542 | - else { |
|
| 543 | - 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); |
|
| 544 | - } |
|
| 545 | - } |
|
| 546 | - $xml = "<cmd"; |
|
| 547 | - foreach($aAttributes as $sAttribute => $sValue) |
|
| 548 | - $xml .= " $sAttribute=\"$sValue\""; |
|
| 549 | - if ($sData !== null && !stristr($sData,'<![CDATA[')) |
|
| 550 | - $xml .= "><![CDATA[$sData]]></cmd>"; |
|
| 551 | - else if ($sData !== null) |
|
| 552 | - $xml .= ">$sData</cmd>"; |
|
| 553 | - else |
|
| 554 | - $xml .= "></cmd>"; |
|
| 555 | - |
|
| 556 | - return $xml; |
|
| 557 | - } |
|
| 558 | - |
|
| 559 | - /** |
|
| 560 | - * Recursively serializes a data structure in XML so it can be sent to |
|
| 561 | - * the client. It could be thought of as the opposite of |
|
| 562 | - * {@link xajax::_parseObjXml()}. |
|
| 563 | - * |
|
| 564 | - * @access private |
|
| 565 | - * @param mixed data structure to serialize to XML |
|
| 566 | - * @return string serialized XML |
|
| 567 | - */ |
|
| 568 | - function _buildObjXml($var) { |
|
| 569 | - if (gettype($var) == "object") $var = get_object_vars($var); |
|
| 570 | - if (!is_array($var)) { |
|
| 571 | - return "<![CDATA[$var]]>"; |
|
| 572 | - } |
|
| 573 | - else { |
|
| 574 | - $data = "<xjxobj>"; |
|
| 575 | - foreach ($var as $key => $value) { |
|
| 576 | - $data .= "<e>"; |
|
| 577 | - $data .= "<k>" . htmlspecialchars($key) . "</k>"; |
|
| 578 | - $data .= "<v>" . $this->_buildObjXml($value) . "</v>"; |
|
| 579 | - $data .= "</e>"; |
|
| 580 | - } |
|
| 581 | - $data .= "</xjxobj>"; |
|
| 582 | - return $data; |
|
| 583 | - } |
|
| 584 | - } |
|
| 265 | + parse_str($queryPart, $queryParts); |
|
| 266 | + $newQueryPart = ""; |
|
| 267 | + foreach($queryParts as $key => $value) |
|
| 268 | + { |
|
| 269 | + $newQueryPart .= rawurlencode($key).'='.rawurlencode($value).ini_get('arg_separator.output'); |
|
| 270 | + } |
|
| 271 | + $sURL = str_replace($queryPart, $newQueryPart, $sURL); |
|
| 272 | + } |
|
| 273 | + $this->addScript('window.location = "'.$sURL.'";'); |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + /** |
|
| 277 | + * Adds a Javascript command message to the XML response. |
|
| 278 | + * |
|
| 279 | + * <i>Usage:</i> <kbd>$objResponse->addScript("var x = prompt('get some text');");</kbd> |
|
| 280 | + * |
|
| 281 | + * @param string contains Javascript code to be executed |
|
| 282 | + */ |
|
| 283 | + function addScript($sJS) |
|
| 284 | + { |
|
| 285 | + $this->xml .= $this->_cmdXML(array("n"=>"js"),$sJS); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Adds a Javascript function call command message to the XML response. |
|
| 290 | + * |
|
| 291 | + * <i>Usage:</i> <kbd>$objResponse->addScriptCall("myJSFunction", "arg 1", "arg 2", 12345);</kbd> |
|
| 292 | + * |
|
| 293 | + * @param string $sFunc the name of a Javascript function |
|
| 294 | + * @param mixed $args,... optional arguments to pass to the Javascript function |
|
| 295 | + */ |
|
| 296 | + function addScriptCall() { |
|
| 297 | + $arguments = func_get_args(); |
|
| 298 | + $sFunc = array_shift($arguments); |
|
| 299 | + $sData = $this->_buildObjXml($arguments); |
|
| 300 | + $this->xml .= $this->_cmdXML(array("n"=>"jc","t"=>$sFunc),$sData); |
|
| 301 | + } |
|
| 302 | + |
|
| 303 | + /** |
|
| 304 | + * Adds a remove element command message to the XML response. |
|
| 305 | + * |
|
| 306 | + * <i>Usage:</i> <kbd>$objResponse->addRemove("Div2");</kbd> |
|
| 307 | + * |
|
| 308 | + * @param string contains the id of an HTML element to be removed |
|
| 309 | + */ |
|
| 310 | + function addRemove($sTarget) |
|
| 311 | + { |
|
| 312 | + $this->xml .= $this->_cmdXML(array("n"=>"rm","t"=>$sTarget),''); |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + /** |
|
| 316 | + * Adds a create element command message to the XML response. |
|
| 317 | + * |
|
| 318 | + * <i>Usage:</i> <kbd>$objResponse->addCreate("parentDiv", "h3", "myid");</kbd> |
|
| 319 | + * |
|
| 320 | + * @param string contains the id of an HTML element to to which the new |
|
| 321 | + * element will be appended. |
|
| 322 | + * @param string the tag to be added |
|
| 323 | + * @param string the id to be assigned to the new element |
|
| 324 | + * @param string deprecated, use the addCreateInput() method instead |
|
| 325 | + */ |
|
| 326 | + function addCreate($sParent, $sTag, $sId, $sType="") |
|
| 327 | + { |
|
| 328 | + if ($sType) |
|
| 329 | + { |
|
| 330 | + trigger_error("The \$sType parameter of addCreate has been deprecated. Use the addCreateInput() method instead.", E_USER_WARNING); |
|
| 331 | + return; |
|
| 332 | + } |
|
| 333 | + $this->xml .= $this->_cmdXML(array("n"=>"ce","t"=>$sParent,"p"=>$sId),$sTag); |
|
| 334 | + } |
|
| 335 | + |
|
| 336 | + /** |
|
| 337 | + * Adds a insert element command message to the XML response. |
|
| 338 | + * |
|
| 339 | + * <i>Usage:</i> <kbd>$objResponse->addInsert("childDiv", "h3", "myid");</kbd> |
|
| 340 | + * |
|
| 341 | + * @param string contains the id of the child before which the new element |
|
| 342 | + * will be inserted |
|
| 343 | + * @param string the tag to be added |
|
| 344 | + * @param string the id to be assigned to the new element |
|
| 345 | + */ |
|
| 346 | + function addInsert($sBefore, $sTag, $sId) |
|
| 347 | + { |
|
| 348 | + $this->xml .= $this->_cmdXML(array("n"=>"ie","t"=>$sBefore,"p"=>$sId),$sTag); |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + /** |
|
| 352 | + * Adds a insert element command message to the XML response. |
|
| 353 | + * |
|
| 354 | + * <i>Usage:</i> <kbd>$objResponse->addInsertAfter("childDiv", "h3", "myid");</kbd> |
|
| 355 | + * |
|
| 356 | + * @param string contains the id of the child after which the new element |
|
| 357 | + * will be inserted |
|
| 358 | + * @param string the tag to be added |
|
| 359 | + * @param string the id to be assigned to the new element |
|
| 360 | + */ |
|
| 361 | + function addInsertAfter($sAfter, $sTag, $sId) |
|
| 362 | + { |
|
| 363 | + $this->xml .= $this->_cmdXML(array("n"=>"ia","t"=>$sAfter,"p"=>$sId),$sTag); |
|
| 364 | + } |
|
| 365 | + |
|
| 366 | + /** |
|
| 367 | + * Adds a create input command message to the XML response. |
|
| 368 | + * |
|
| 369 | + * <i>Usage:</i> <kbd>$objResponse->addCreateInput("form1", "text", "username", "input1");</kbd> |
|
| 370 | + * |
|
| 371 | + * @param string contains the id of an HTML element to which the new input |
|
| 372 | + * will be appended |
|
| 373 | + * @param string the type of input to be created (text, radio, checkbox, |
|
| 374 | + * etc.) |
|
| 375 | + * @param string the name to be assigned to the new input and the variable |
|
| 376 | + * name when it is submitted |
|
| 377 | + * @param string the id to be assigned to the new input |
|
| 378 | + */ |
|
| 379 | + function addCreateInput($sParent, $sType, $sName, $sId) |
|
| 380 | + { |
|
| 381 | + $this->xml .= $this->_cmdXML(array("n"=>"ci","t"=>$sParent,"p"=>$sId,"c"=>$sType),$sName); |
|
| 382 | + } |
|
| 383 | + |
|
| 384 | + /** |
|
| 385 | + * Adds an insert input command message to the XML response. |
|
| 386 | + * |
|
| 387 | + * <i>Usage:</i> <kbd>$objResponse->addInsertInput("input5", "text", "username", "input1");</kbd> |
|
| 388 | + * |
|
| 389 | + * @param string contains the id of the child before which the new element |
|
| 390 | + * will be inserted |
|
| 391 | + * @param string the type of input to be created (text, radio, checkbox, |
|
| 392 | + * etc.) |
|
| 393 | + * @param string the name to be assigned to the new input and the variable |
|
| 394 | + * name when it is submitted |
|
| 395 | + * @param string the id to be assigned to the new input |
|
| 396 | + */ |
|
| 397 | + function addInsertInput($sBefore, $sType, $sName, $sId) |
|
| 398 | + { |
|
| 399 | + $this->xml .= $this->_cmdXML(array("n"=>"ii","t"=>$sBefore,"p"=>$sId,"c"=>$sType),$sName); |
|
| 400 | + } |
|
| 401 | + |
|
| 402 | + /** |
|
| 403 | + * Adds an insert input command message to the XML response. |
|
| 404 | + * |
|
| 405 | + * <i>Usage:</i> <kbd>$objResponse->addInsertInputAfter("input7", "text", "email", "input2");</kbd> |
|
| 406 | + * |
|
| 407 | + * @param string contains the id of the child after which the new element |
|
| 408 | + * will be inserted |
|
| 409 | + * @param string the type of input to be created (text, radio, checkbox, |
|
| 410 | + * etc.) |
|
| 411 | + * @param string the name to be assigned to the new input and the variable |
|
| 412 | + * name when it is submitted |
|
| 413 | + * @param string the id to be assigned to the new input |
|
| 414 | + */ |
|
| 415 | + function addInsertInputAfter($sAfter, $sType, $sName, $sId) |
|
| 416 | + { |
|
| 417 | + $this->xml .= $this->_cmdXML(array("n"=>"iia","t"=>$sAfter,"p"=>$sId,"c"=>$sType),$sName); |
|
| 418 | + } |
|
| 419 | + |
|
| 420 | + /** |
|
| 421 | + * Adds an event command message to the XML response. |
|
| 422 | + * |
|
| 423 | + * <i>Usage:</i> <kbd>$objResponse->addEvent("contentDiv", "onclick", "alert(\'Hello World\');");</kbd> |
|
| 424 | + * |
|
| 425 | + * @param string contains the id of an HTML element |
|
| 426 | + * @param string the event you wish to set ("onclick", "onmouseover", etc.) |
|
| 427 | + * @param string the Javascript string you want the event to invoke |
|
| 428 | + */ |
|
| 429 | + function addEvent($sTarget,$sEvent,$sScript) |
|
| 430 | + { |
|
| 431 | + $this->xml .= $this->_cmdXML(array("n"=>"ev","t"=>$sTarget,"p"=>$sEvent),$sScript); |
|
| 432 | + } |
|
| 433 | + |
|
| 434 | + /** |
|
| 435 | + * Adds a handler command message to the XML response. |
|
| 436 | + * |
|
| 437 | + * <i>Usage:</i> <kbd>$objResponse->addHandler("contentDiv", "onclick", "content_click");</kbd> |
|
| 438 | + * |
|
| 439 | + * @param string contains the id of an HTML element |
|
| 440 | + * @param string the event you wish to set ("onclick", "onmouseover", etc.) |
|
| 441 | + * @param string the name of a Javascript function that will handle the |
|
| 442 | + * event. Multiple handlers can be added for the same event |
|
| 443 | + */ |
|
| 444 | + function addHandler($sTarget,$sEvent,$sHandler) |
|
| 445 | + { |
|
| 446 | + $this->xml .= $this->_cmdXML(array("n"=>"ah","t"=>$sTarget,"p"=>$sEvent),$sHandler); |
|
| 447 | + } |
|
| 448 | + |
|
| 449 | + /** |
|
| 450 | + * Adds a remove handler command message to the XML response. |
|
| 451 | + * |
|
| 452 | + * <i>Usage:</i> <kbd>$objResponse->addRemoveHandler("contentDiv", "onclick", "content_click");</kbd> |
|
| 453 | + * |
|
| 454 | + * @param string contains the id of an HTML element |
|
| 455 | + * @param string the event you wish to remove ("onclick", "onmouseover", |
|
| 456 | + * etc.) |
|
| 457 | + * @param string the name of a Javascript handler function that you want to |
|
| 458 | + * remove |
|
| 459 | + */ |
|
| 460 | + function addRemoveHandler($sTarget,$sEvent,$sHandler) |
|
| 461 | + { |
|
| 462 | + $this->xml .= $this->_cmdXML(array("n"=>"rh","t"=>$sTarget,"p"=>$sEvent),$sHandler); |
|
| 463 | + } |
|
| 464 | + |
|
| 465 | + /** |
|
| 466 | + * Adds an include script command message to the XML response. |
|
| 467 | + * |
|
| 468 | + * <i>Usage:</i> <kbd>$objResponse->addIncludeScript("functions.js");</kbd> |
|
| 469 | + * |
|
| 470 | + * @param string URL of the Javascript file to include |
|
| 471 | + */ |
|
| 472 | + function addIncludeScript($sFileName) |
|
| 473 | + { |
|
| 474 | + $this->xml .= $this->_cmdXML(array("n"=>"in"),$sFileName); |
|
| 475 | + } |
|
| 476 | + |
|
| 477 | + /** |
|
| 478 | + * Returns the XML to be returned from your function to the xajax processor |
|
| 479 | + * on your page. Since xajax 0.2, you can also return an xajaxResponse |
|
| 480 | + * object from your function directly, and xajax will automatically request |
|
| 481 | + * the XML using this method call. |
|
| 482 | + * |
|
| 483 | + * <i>Usage:</i> <kbd>return $objResponse->getXML();</kbd> |
|
| 484 | + * |
|
| 485 | + * @return string response XML data |
|
| 486 | + */ |
|
| 487 | + function getXML() |
|
| 488 | + { |
|
| 489 | + $sXML = "<?xml version=\"1.0\""; |
|
| 490 | + if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0) |
|
| 491 | + $sXML .= " encoding=\"".$this->sEncoding."\""; |
|
| 492 | + $sXML .= " ?"."><xjx>" . $this->xml . "</xjx>"; |
|
| 493 | + |
|
| 494 | + return $sXML; |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + /** |
|
| 498 | + * Adds the commands of the provided response XML output to this response |
|
| 499 | + * object |
|
| 500 | + * |
|
| 501 | + * <i>Usage:</i> |
|
| 502 | + * <code>$r1 = $objResponse1->getXML(); |
|
| 503 | + * $objResponse2->loadXML($r1); |
|
| 504 | + * return $objResponse2->getXML();</code> |
|
| 505 | + * |
|
| 506 | + * @param string the response XML (returned from a getXML() method) to add |
|
| 507 | + * to the end of this response object |
|
| 508 | + */ |
|
| 509 | + function loadXML($mXML) |
|
| 510 | + { |
|
| 511 | + if (is_a($mXML, "xajaxResponse")) { |
|
| 512 | + $mXML = $mXML->getXML(); |
|
| 513 | + } |
|
| 514 | + $sNewXML = ""; |
|
| 515 | + $iStartPos = strpos($mXML, "<xjx>") + 5; |
|
| 516 | + $sNewXML = substr($mXML, $iStartPos); |
|
| 517 | + $iEndPos = strpos($sNewXML, "</xjx>"); |
|
| 518 | + $sNewXML = substr($sNewXML, 0, $iEndPos); |
|
| 519 | + $this->xml .= $sNewXML; |
|
| 520 | + } |
|
| 521 | + |
|
| 522 | + /** |
|
| 523 | + * Generates XML from command data |
|
| 524 | + * |
|
| 525 | + * @access private |
|
| 526 | + * @param array associative array of attributes |
|
| 527 | + * @param string data |
|
| 528 | + * @return string XML command |
|
| 529 | + */ |
|
| 530 | + function _cmdXML($aAttributes, $sData) |
|
| 531 | + { |
|
| 532 | + if ($this->bOutputEntities) { |
|
| 533 | + // An adaptation for the Dokeos LMS, 22-AUG-2009. |
|
| 534 | + if (function_exists('api_convert_encoding')) { |
|
| 535 | + $sData = call_user_func_array('api_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding)); |
|
| 536 | + } |
|
| 537 | + //if (function_exists('mb_convert_encoding')) { |
|
| 538 | + elseif (function_exists('mb_convert_encoding')) { |
|
| 539 | + // |
|
| 540 | + $sData = call_user_func_array('mb_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding)); |
|
| 541 | + } |
|
| 542 | + else { |
|
| 543 | + 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); |
|
| 544 | + } |
|
| 545 | + } |
|
| 546 | + $xml = "<cmd"; |
|
| 547 | + foreach($aAttributes as $sAttribute => $sValue) |
|
| 548 | + $xml .= " $sAttribute=\"$sValue\""; |
|
| 549 | + if ($sData !== null && !stristr($sData,'<![CDATA[')) |
|
| 550 | + $xml .= "><![CDATA[$sData]]></cmd>"; |
|
| 551 | + else if ($sData !== null) |
|
| 552 | + $xml .= ">$sData</cmd>"; |
|
| 553 | + else |
|
| 554 | + $xml .= "></cmd>"; |
|
| 555 | + |
|
| 556 | + return $xml; |
|
| 557 | + } |
|
| 558 | + |
|
| 559 | + /** |
|
| 560 | + * Recursively serializes a data structure in XML so it can be sent to |
|
| 561 | + * the client. It could be thought of as the opposite of |
|
| 562 | + * {@link xajax::_parseObjXml()}. |
|
| 563 | + * |
|
| 564 | + * @access private |
|
| 565 | + * @param mixed data structure to serialize to XML |
|
| 566 | + * @return string serialized XML |
|
| 567 | + */ |
|
| 568 | + function _buildObjXml($var) { |
|
| 569 | + if (gettype($var) == "object") $var = get_object_vars($var); |
|
| 570 | + if (!is_array($var)) { |
|
| 571 | + return "<![CDATA[$var]]>"; |
|
| 572 | + } |
|
| 573 | + else { |
|
| 574 | + $data = "<xjxobj>"; |
|
| 575 | + foreach ($var as $key => $value) { |
|
| 576 | + $data .= "<e>"; |
|
| 577 | + $data .= "<k>" . htmlspecialchars($key) . "</k>"; |
|
| 578 | + $data .= "<v>" . $this->_buildObjXml($value) . "</v>"; |
|
| 579 | + $data .= "</e>"; |
|
| 580 | + } |
|
| 581 | + $data .= "</xjxobj>"; |
|
| 582 | + return $data; |
|
| 583 | + } |
|
| 584 | + } |
|
| 585 | 585 | |
| 586 | 586 | }// end class xajaxResponse |
| 587 | 587 | ?> |
@@ -47,7 +47,7 @@ discard block |
||
| 47 | 47 | */ |
| 48 | 48 | if (!defined ('XAJAX_DEFAULT_CHAR_ENCODING')) |
| 49 | 49 | { |
| 50 | - define ('XAJAX_DEFAULT_CHAR_ENCODING', 'utf-8' ); |
|
| 50 | + define ('XAJAX_DEFAULT_CHAR_ENCODING', 'utf-8' ); |
|
| 51 | 51 | } |
| 52 | 52 | |
| 53 | 53 | /** |
@@ -55,11 +55,11 @@ discard block |
||
| 55 | 55 | */ |
| 56 | 56 | if (!defined ('XAJAX_GET')) |
| 57 | 57 | { |
| 58 | - define ('XAJAX_GET', 0); |
|
| 58 | + define ('XAJAX_GET', 0); |
|
| 59 | 59 | } |
| 60 | 60 | if (!defined ('XAJAX_POST')) |
| 61 | 61 | { |
| 62 | - define ('XAJAX_POST', 1); |
|
| 62 | + define ('XAJAX_POST', 1); |
|
| 63 | 63 | } |
| 64 | 64 | |
| 65 | 65 | /** |
@@ -72,1145 +72,1145 @@ discard block |
||
| 72 | 72 | */ |
| 73 | 73 | class xajax |
| 74 | 74 | { |
| 75 | - /**#@+ |
|
| 75 | + /**#@+ |
|
| 76 | 76 | * @access protected |
| 77 | 77 | */ |
| 78 | - /** |
|
| 79 | - * @var array Array of PHP functions that will be callable through javascript wrappers |
|
| 80 | - */ |
|
| 81 | - var $aFunctions; |
|
| 82 | - /** |
|
| 83 | - * @var array Array of object callbacks that will allow Javascript to call PHP methods (key=function name) |
|
| 84 | - */ |
|
| 85 | - var $aObjects; |
|
| 86 | - /** |
|
| 87 | - * @var array Array of RequestTypes to be used with each function (key=function name) |
|
| 88 | - */ |
|
| 89 | - var $aFunctionRequestTypes; |
|
| 90 | - /** |
|
| 91 | - * @var array Array of Include Files for any external functions (key=function name) |
|
| 92 | - */ |
|
| 93 | - var $aFunctionIncludeFiles; |
|
| 94 | - /** |
|
| 95 | - * @var string Name of the PHP function to call if no callable function was found |
|
| 96 | - */ |
|
| 97 | - var $sCatchAllFunction; |
|
| 98 | - /** |
|
| 99 | - * @var string Name of the PHP function to call before any other function |
|
| 100 | - */ |
|
| 101 | - var $sPreFunction; |
|
| 102 | - /** |
|
| 103 | - * @var string The URI for making requests to the xajax object |
|
| 104 | - */ |
|
| 105 | - var $sRequestURI; |
|
| 106 | - /** |
|
| 107 | - * @var string The prefix to prepend to the javascript wraper function name |
|
| 108 | - */ |
|
| 109 | - var $sWrapperPrefix; |
|
| 110 | - /** |
|
| 111 | - * @var boolean Show debug messages (default false) |
|
| 112 | - */ |
|
| 113 | - var $bDebug; |
|
| 114 | - /** |
|
| 115 | - * @var boolean Show messages in the client browser's status bar (default false) |
|
| 116 | - */ |
|
| 117 | - var $bStatusMessages; |
|
| 118 | - /** |
|
| 119 | - * @var boolean Allow xajax to exit after processing a request (default true) |
|
| 120 | - */ |
|
| 121 | - var $bExitAllowed; |
|
| 122 | - /** |
|
| 123 | - * @var boolean Use wait cursor in browser (default true) |
|
| 124 | - */ |
|
| 125 | - var $bWaitCursor; |
|
| 126 | - /** |
|
| 127 | - * @var boolean Use an special xajax error handler so the errors are sent to the browser properly (default false) |
|
| 128 | - */ |
|
| 129 | - var $bErrorHandler; |
|
| 130 | - /** |
|
| 131 | - * @var string Specify what, if any, file xajax should log errors to (and more information in a future release) |
|
| 132 | - */ |
|
| 133 | - var $sLogFile; |
|
| 134 | - /** |
|
| 135 | - * @var boolean Clean all output buffers before outputting response (default false) |
|
| 136 | - */ |
|
| 137 | - var $bCleanBuffer; |
|
| 138 | - /** |
|
| 139 | - * @var string String containing the character encoding used |
|
| 140 | - */ |
|
| 141 | - var $sEncoding; |
|
| 142 | - /** |
|
| 143 | - * @var boolean Decode input request args from UTF-8 (default false) |
|
| 144 | - */ |
|
| 145 | - var $bDecodeUTF8Input; |
|
| 146 | - /** |
|
| 147 | - * @var boolean Convert special characters to HTML entities (default false) |
|
| 148 | - */ |
|
| 149 | - var $bOutputEntities; |
|
| 150 | - /** |
|
| 151 | - * @var array Array for parsing complex objects |
|
| 152 | - */ |
|
| 153 | - var $aObjArray; |
|
| 154 | - /** |
|
| 155 | - * @var integer Position in $aObjArray |
|
| 156 | - */ |
|
| 157 | - var $iPos; |
|
| 158 | - |
|
| 159 | - /**#@-*/ |
|
| 160 | - |
|
| 161 | - /** |
|
| 162 | - * Constructor. You can set some extra xajax options right away or use |
|
| 163 | - * individual methods later to set options. |
|
| 164 | - * |
|
| 165 | - * @param string defaults to the current browser URI |
|
| 166 | - * @param string defaults to "xajax_"; |
|
| 167 | - * @param string defaults to XAJAX_DEFAULT_CHAR_ENCODING defined above |
|
| 168 | - * @param boolean defaults to false |
|
| 169 | - */ |
|
| 170 | - public function __construct($sRequestURI="",$sWrapperPrefix="xajax_",$sEncoding=XAJAX_DEFAULT_CHAR_ENCODING,$bDebug=false) |
|
| 171 | - { |
|
| 172 | - $this->aFunctions = array(); |
|
| 173 | - $this->aObjects = array(); |
|
| 174 | - $this->aFunctionIncludeFiles = array(); |
|
| 175 | - $this->sRequestURI = $sRequestURI; |
|
| 176 | - if ($this->sRequestURI == "") |
|
| 177 | - $this->sRequestURI = $this->_detectURI(); |
|
| 178 | - $this->sWrapperPrefix = $sWrapperPrefix; |
|
| 179 | - $this->bDebug = $bDebug; |
|
| 180 | - $this->bStatusMessages = false; |
|
| 181 | - $this->bWaitCursor = true; |
|
| 182 | - $this->bExitAllowed = true; |
|
| 183 | - $this->bErrorHandler = false; |
|
| 184 | - $this->sLogFile = ""; |
|
| 185 | - $this->bCleanBuffer = false; |
|
| 186 | - $this->setCharEncoding($sEncoding); |
|
| 187 | - $this->bDecodeUTF8Input = false; |
|
| 188 | - $this->bOutputEntities = false; |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - /** |
|
| 192 | - * Sets the URI to which requests will be made. |
|
| 193 | - * <i>Usage:</i> <kbd>$xajax->setRequestURI("http://www.xajaxproject.org");</kbd> |
|
| 194 | - * |
|
| 195 | - * @param string the URI (can be absolute or relative) of the PHP script |
|
| 196 | - * that will be accessed when an xajax request occurs |
|
| 197 | - */ |
|
| 198 | - function setRequestURI($sRequestURI) |
|
| 199 | - { |
|
| 200 | - $this->sRequestURI = $sRequestURI; |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - /** |
|
| 204 | - * Sets the prefix that will be appended to the Javascript wrapper |
|
| 205 | - * functions (default is "xajax_"). |
|
| 206 | - * |
|
| 207 | - * @param string |
|
| 208 | - */ |
|
| 209 | - // |
|
| 210 | - function setWrapperPrefix($sPrefix) |
|
| 211 | - { |
|
| 212 | - $this->sWrapperPrefix = $sPrefix; |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - /** |
|
| 216 | - * Enables debug messages for xajax. |
|
| 217 | - * */ |
|
| 218 | - function debugOn() |
|
| 219 | - { |
|
| 220 | - $this->bDebug = true; |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - /** |
|
| 224 | - * Disables debug messages for xajax (default behavior). |
|
| 225 | - */ |
|
| 226 | - function debugOff() |
|
| 227 | - { |
|
| 228 | - $this->bDebug = false; |
|
| 229 | - } |
|
| 230 | - |
|
| 231 | - /** |
|
| 232 | - * Enables messages in the browser's status bar for xajax. |
|
| 233 | - */ |
|
| 234 | - function statusMessagesOn() |
|
| 235 | - { |
|
| 236 | - $this->bStatusMessages = true; |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - /** |
|
| 240 | - * Disables messages in the browser's status bar for xajax (default behavior). |
|
| 241 | - */ |
|
| 242 | - function statusMessagesOff() |
|
| 243 | - { |
|
| 244 | - $this->bStatusMessages = false; |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - /** |
|
| 248 | - * Enables the wait cursor to be displayed in the browser (default behavior). |
|
| 249 | - */ |
|
| 250 | - function waitCursorOn() |
|
| 251 | - { |
|
| 252 | - $this->bWaitCursor = true; |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - /** |
|
| 256 | - * Disables the wait cursor to be displayed in the browser. |
|
| 257 | - */ |
|
| 258 | - function waitCursorOff() |
|
| 259 | - { |
|
| 260 | - $this->bWaitCursor = false; |
|
| 261 | - } |
|
| 262 | - |
|
| 263 | - /** |
|
| 264 | - * Enables xajax to exit immediately after processing a request and |
|
| 265 | - * sending the response back to the browser (default behavior). |
|
| 266 | - */ |
|
| 267 | - function exitAllowedOn() |
|
| 268 | - { |
|
| 269 | - $this->bExitAllowed = true; |
|
| 270 | - } |
|
| 271 | - |
|
| 272 | - /** |
|
| 273 | - * Disables xajax's default behavior of exiting immediately after |
|
| 274 | - * processing a request and sending the response back to the browser. |
|
| 275 | - */ |
|
| 276 | - function exitAllowedOff() |
|
| 277 | - { |
|
| 278 | - $this->bExitAllowed = false; |
|
| 279 | - } |
|
| 280 | - |
|
| 281 | - /** |
|
| 282 | - * Turns on xajax's error handling system so that PHP errors that occur |
|
| 283 | - * during a request are trapped and pushed to the browser in the form of |
|
| 284 | - * a Javascript alert. |
|
| 285 | - */ |
|
| 286 | - function errorHandlerOn() |
|
| 287 | - { |
|
| 288 | - $this->bErrorHandler = true; |
|
| 289 | - } |
|
| 290 | - |
|
| 291 | - /** |
|
| 292 | - * Turns off xajax's error handling system (default behavior). |
|
| 293 | - */ |
|
| 294 | - function errorHandlerOff() |
|
| 295 | - { |
|
| 296 | - $this->bErrorHandler = false; |
|
| 297 | - } |
|
| 298 | - |
|
| 299 | - /** |
|
| 300 | - * Specifies a log file that will be written to by xajax during a request |
|
| 301 | - * (used only by the error handling system at present). If you don't invoke |
|
| 302 | - * this method, or you pass in "", then no log file will be written to. |
|
| 303 | - * <i>Usage:</i> <kbd>$xajax->setLogFile("/xajax_logs/errors.log");</kbd> |
|
| 304 | - */ |
|
| 305 | - function setLogFile($sFilename) |
|
| 306 | - { |
|
| 307 | - $this->sLogFile = $sFilename; |
|
| 308 | - } |
|
| 309 | - |
|
| 310 | - /** |
|
| 311 | - * Causes xajax to clean out all output buffers before outputting a |
|
| 312 | - * response (default behavior). |
|
| 313 | - */ |
|
| 314 | - function cleanBufferOn() |
|
| 315 | - { |
|
| 316 | - $this->bCleanBuffer = true; |
|
| 317 | - } |
|
| 318 | - /** |
|
| 319 | - * Turns off xajax's output buffer cleaning. |
|
| 320 | - */ |
|
| 321 | - function cleanBufferOff() |
|
| 322 | - { |
|
| 323 | - $this->bCleanBuffer = false; |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - /** |
|
| 327 | - * Sets the character encoding for the HTTP output based on |
|
| 328 | - * <kbd>$sEncoding</kbd>, which is a string containing the character |
|
| 329 | - * encoding to use. You don't need to use this method normally, since the |
|
| 330 | - * character encoding for the response gets set automatically based on the |
|
| 331 | - * <kbd>XAJAX_DEFAULT_CHAR_ENCODING</kbd> constant. |
|
| 332 | - * <i>Usage:</i> <kbd>$xajax->setCharEncoding("utf-8");</kbd> |
|
| 333 | - * |
|
| 334 | - * @param string the encoding type to use (utf-8, iso-8859-1, etc.) |
|
| 335 | - */ |
|
| 336 | - function setCharEncoding($sEncoding) |
|
| 337 | - { |
|
| 338 | - $this->sEncoding = $sEncoding; |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - /** |
|
| 342 | - * Causes xajax to decode the input request args from UTF-8 to the current |
|
| 343 | - * encoding if possible. Either the iconv or mb_string extension must be |
|
| 344 | - * present for optimal functionality. |
|
| 345 | - */ |
|
| 346 | - function decodeUTF8InputOn() |
|
| 347 | - { |
|
| 348 | - $this->bDecodeUTF8Input = true; |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - /** |
|
| 352 | - * Turns off decoding the input request args from UTF-8 (default behavior). |
|
| 353 | - */ |
|
| 354 | - function decodeUTF8InputOff() |
|
| 355 | - { |
|
| 356 | - $this->bDecodeUTF8Input = false; |
|
| 357 | - } |
|
| 358 | - |
|
| 359 | - /** |
|
| 360 | - * Tells the response object to convert special characters to HTML entities |
|
| 361 | - * automatically (only works if the mb_string extension is available). |
|
| 362 | - */ |
|
| 363 | - function outputEntitiesOn() |
|
| 364 | - { |
|
| 365 | - $this->bOutputEntities = true; |
|
| 366 | - } |
|
| 367 | - |
|
| 368 | - /** |
|
| 369 | - * Tells the response object to output special characters intact. (default |
|
| 370 | - * behavior). |
|
| 371 | - */ |
|
| 372 | - function outputEntitiesOff() |
|
| 373 | - { |
|
| 374 | - $this->bOutputEntities = false; |
|
| 375 | - } |
|
| 376 | - |
|
| 377 | - /** |
|
| 378 | - * Registers a PHP function or method to be callable through xajax in your |
|
| 379 | - * Javascript. If you want to register a function, pass in the name of that |
|
| 380 | - * function. If you want to register a static class method, pass in an |
|
| 381 | - * array like so: |
|
| 382 | - * <kbd>array("myFunctionName", "myClass", "myMethod")</kbd> |
|
| 383 | - * For an object instance method, use an object variable for the second |
|
| 384 | - * array element (and in PHP 4 make sure you put an & before the variable |
|
| 385 | - * to pass the object by reference). Note: the function name is what you |
|
| 386 | - * call via Javascript, so it can be anything as long as it doesn't |
|
| 387 | - * conflict with any other registered function name. |
|
| 388 | - * |
|
| 389 | - * <i>Usage:</i> <kbd>$xajax->registerFunction("myFunction");</kbd> |
|
| 390 | - * or: <kbd>$xajax->registerFunction(array("myFunctionName", &$myObject, "myMethod"));</kbd> |
|
| 391 | - * |
|
| 392 | - * @param mixed contains the function name or an object callback array |
|
| 393 | - * @param mixed request type (XAJAX_GET/XAJAX_POST) that should be used |
|
| 394 | - * for this function. Defaults to XAJAX_POST. |
|
| 395 | - */ |
|
| 396 | - function registerFunction($mFunction,$sRequestType=XAJAX_POST) |
|
| 397 | - { |
|
| 398 | - if (is_array($mFunction)) { |
|
| 399 | - $this->aFunctions[$mFunction[0]] = 1; |
|
| 400 | - $this->aFunctionRequestTypes[$mFunction[0]] = $sRequestType; |
|
| 401 | - $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1); |
|
| 402 | - } |
|
| 403 | - else { |
|
| 404 | - $this->aFunctions[$mFunction] = 1; |
|
| 405 | - $this->aFunctionRequestTypes[$mFunction] = $sRequestType; |
|
| 406 | - } |
|
| 407 | - } |
|
| 408 | - |
|
| 409 | - /** |
|
| 410 | - * Registers a PHP function to be callable through xajax which is located |
|
| 411 | - * in some other file. If the function is requested the external file will |
|
| 412 | - * be included to define the function before the function is called. |
|
| 413 | - * |
|
| 414 | - * <i>Usage:</i> <kbd>$xajax->registerExternalFunction("myFunction","myFunction.inc.php",XAJAX_POST);</kbd> |
|
| 415 | - * |
|
| 416 | - * @param string contains the function name or an object callback array |
|
| 417 | - * ({@link xajax::registerFunction() see registerFunction} for |
|
| 418 | - * more info on object callback arrays) |
|
| 419 | - * @param string contains the path and filename of the include file |
|
| 420 | - * @param mixed the RequestType (XAJAX_GET/XAJAX_POST) that should be used |
|
| 421 | - * for this function. Defaults to XAJAX_POST. |
|
| 422 | - */ |
|
| 423 | - function registerExternalFunction($mFunction,$sIncludeFile,$sRequestType=XAJAX_POST) |
|
| 424 | - { |
|
| 425 | - $this->registerFunction($mFunction, $sRequestType); |
|
| 426 | - |
|
| 427 | - if (is_array($mFunction)) { |
|
| 428 | - $this->aFunctionIncludeFiles[$mFunction[0]] = $sIncludeFile; |
|
| 429 | - } |
|
| 430 | - else { |
|
| 431 | - $this->aFunctionIncludeFiles[$mFunction] = $sIncludeFile; |
|
| 432 | - } |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - /** |
|
| 436 | - * Registers a PHP function to be called when xajax cannot find the |
|
| 437 | - * function being called via Javascript. Because this is technically |
|
| 438 | - * impossible when using "wrapped" functions, the catch-all feature is |
|
| 439 | - * only useful when you're directly using the xajax.call() Javascript |
|
| 440 | - * method. Use the catch-all feature when you want more dynamic ability to |
|
| 441 | - * intercept unknown calls and handle them in a custom way. |
|
| 442 | - * |
|
| 443 | - * <i>Usage:</i> <kbd>$xajax->registerCatchAllFunction("myCatchAllFunction");</kbd> |
|
| 444 | - * |
|
| 445 | - * @param string contains the function name or an object callback array |
|
| 446 | - * ({@link xajax::registerFunction() see registerFunction} for |
|
| 447 | - * more info on object callback arrays) |
|
| 448 | - */ |
|
| 449 | - function registerCatchAllFunction($mFunction) |
|
| 450 | - { |
|
| 451 | - if (is_array($mFunction)) { |
|
| 452 | - $this->sCatchAllFunction = $mFunction[0]; |
|
| 453 | - $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1); |
|
| 454 | - } |
|
| 455 | - else { |
|
| 456 | - $this->sCatchAllFunction = $mFunction; |
|
| 457 | - } |
|
| 458 | - } |
|
| 459 | - |
|
| 460 | - /** |
|
| 461 | - * Registers a PHP function to be called before xajax calls the requested |
|
| 462 | - * function. xajax will automatically add the request function's response |
|
| 463 | - * to the pre-function's response to create a single response. Another |
|
| 464 | - * feature is the ability to return not just a response, but an array with |
|
| 465 | - * the first element being false (a boolean) and the second being the |
|
| 466 | - * response. In this case, the pre-function's response will be returned to |
|
| 467 | - * the browser without xajax calling the requested function. |
|
| 468 | - * |
|
| 469 | - * <i>Usage:</i> <kbd>$xajax->registerPreFunction("myPreFunction");</kbd> |
|
| 470 | - * |
|
| 471 | - * @param string contains the function name or an object callback array |
|
| 472 | - * ({@link xajax::registerFunction() see registerFunction} for |
|
| 473 | - * more info on object callback arrays) |
|
| 474 | - */ |
|
| 475 | - function registerPreFunction($mFunction) |
|
| 476 | - { |
|
| 477 | - if (is_array($mFunction)) { |
|
| 478 | - $this->sPreFunction = $mFunction[0]; |
|
| 479 | - $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1); |
|
| 480 | - } |
|
| 481 | - else { |
|
| 482 | - $this->sPreFunction = $mFunction; |
|
| 483 | - } |
|
| 484 | - } |
|
| 485 | - |
|
| 486 | - /** |
|
| 487 | - * Returns true if xajax can process the request, false if otherwise. |
|
| 488 | - * You can use this to determine if xajax needs to process the request or |
|
| 489 | - * not. |
|
| 490 | - * |
|
| 491 | - * @return boolean |
|
| 492 | - */ |
|
| 493 | - function canProcessRequests() |
|
| 494 | - { |
|
| 495 | - if ($this->getRequestMode() != -1) return true; |
|
| 496 | - return false; |
|
| 497 | - } |
|
| 498 | - |
|
| 499 | - /** |
|
| 500 | - * Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if |
|
| 501 | - * there is none. |
|
| 502 | - * |
|
| 503 | - * @return mixed |
|
| 504 | - */ |
|
| 505 | - function getRequestMode() |
|
| 506 | - { |
|
| 507 | - if (!empty($_GET["xajax"])) |
|
| 508 | - return XAJAX_GET; |
|
| 509 | - |
|
| 510 | - if (!empty($_POST["xajax"])) |
|
| 511 | - return XAJAX_POST; |
|
| 512 | - |
|
| 513 | - return -1; |
|
| 514 | - } |
|
| 515 | - |
|
| 516 | - /** |
|
| 517 | - * This is the main communications engine of xajax. The engine handles all |
|
| 518 | - * incoming xajax requests, calls the apporiate PHP functions (or |
|
| 519 | - * class/object methods) and passes the XML responses back to the |
|
| 520 | - * Javascript response handler. If your RequestURI is the same as your Web |
|
| 521 | - * page then this function should be called before any headers or HTML has |
|
| 522 | - * been sent. |
|
| 523 | - */ |
|
| 524 | - function processRequests() |
|
| 525 | - { |
|
| 526 | - |
|
| 527 | - $requestMode = -1; |
|
| 528 | - $sFunctionName = ""; |
|
| 529 | - $bFoundFunction = true; |
|
| 530 | - $bFunctionIsCatchAll = false; |
|
| 531 | - $sFunctionNameForSpecial = ""; |
|
| 532 | - $aArgs = array(); |
|
| 533 | - $sPreResponse = ""; |
|
| 534 | - $bEndRequest = false; |
|
| 535 | - $sResponse = ""; |
|
| 536 | - |
|
| 537 | - $requestMode = $this->getRequestMode(); |
|
| 538 | - if ($requestMode == -1) return; |
|
| 539 | - |
|
| 540 | - if ($requestMode == XAJAX_POST) |
|
| 541 | - { |
|
| 542 | - $sFunctionName = $_POST["xajax"]; |
|
| 543 | - |
|
| 544 | - if (!empty($_POST["xajaxargs"])) |
|
| 545 | - $aArgs = $_POST["xajaxargs"]; |
|
| 546 | - } |
|
| 547 | - else |
|
| 548 | - { |
|
| 549 | - header ("Expires: Mon, 26 Jul 1997 05:00:00 GMT"); |
|
| 550 | - header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT"); |
|
| 551 | - header ("Cache-Control: no-cache, must-revalidate"); |
|
| 552 | - header ("Pragma: no-cache"); |
|
| 553 | - |
|
| 554 | - $sFunctionName = $_GET["xajax"]; |
|
| 555 | - |
|
| 556 | - if (!empty($_GET["xajaxargs"])) |
|
| 557 | - $aArgs = $_GET["xajaxargs"]; |
|
| 558 | - } |
|
| 559 | - |
|
| 560 | - // Use xajax error handler if necessary |
|
| 561 | - if ($this->bErrorHandler) { |
|
| 562 | - $GLOBALS['xajaxErrorHandlerText'] = ""; |
|
| 563 | - set_error_handler("xajaxErrorHandler"); |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - if ($this->sPreFunction) { |
|
| 567 | - if (!$this->_isFunctionCallable($this->sPreFunction)) { |
|
| 568 | - $bFoundFunction = false; |
|
| 569 | - $objResponse = new xajaxResponse(); |
|
| 570 | - $objResponse->addAlert("Unknown Pre-Function ". $this->sPreFunction); |
|
| 571 | - $sResponse = $objResponse->getXML(); |
|
| 572 | - } |
|
| 573 | - } |
|
| 574 | - //include any external dependencies associated with this function name |
|
| 575 | - if (array_key_exists($sFunctionName,$this->aFunctionIncludeFiles)) |
|
| 576 | - { |
|
| 577 | - ob_start(); |
|
| 578 | - include_once($this->aFunctionIncludeFiles[$sFunctionName]); |
|
| 579 | - ob_end_clean(); |
|
| 580 | - } |
|
| 581 | - |
|
| 582 | - if ($bFoundFunction) { |
|
| 583 | - $sFunctionNameForSpecial = $sFunctionName; |
|
| 584 | - if (!array_key_exists($sFunctionName, $this->aFunctions)) |
|
| 585 | - { |
|
| 586 | - if ($this->sCatchAllFunction) { |
|
| 587 | - $sFunctionName = $this->sCatchAllFunction; |
|
| 588 | - $bFunctionIsCatchAll = true; |
|
| 589 | - } |
|
| 590 | - else { |
|
| 591 | - $bFoundFunction = false; |
|
| 592 | - $objResponse = new xajaxResponse(); |
|
| 593 | - $objResponse->addAlert("Unknown Function $sFunctionName."); |
|
| 594 | - $sResponse = $objResponse->getXML(); |
|
| 595 | - } |
|
| 596 | - } |
|
| 597 | - else if ($this->aFunctionRequestTypes[$sFunctionName] != $requestMode) |
|
| 598 | - { |
|
| 599 | - $bFoundFunction = false; |
|
| 600 | - $objResponse = new xajaxResponse(); |
|
| 601 | - $objResponse->addAlert("Incorrect Request Type."); |
|
| 602 | - $sResponse = $objResponse->getXML(); |
|
| 603 | - } |
|
| 604 | - } |
|
| 605 | - |
|
| 606 | - if ($bFoundFunction) |
|
| 607 | - { |
|
| 608 | - for ($i = 0; $i < sizeof($aArgs); $i++) |
|
| 609 | - { |
|
| 610 | - // If magic quotes is on, then we need to strip the slashes from the args |
|
| 611 | - if (get_magic_quotes_gpc() == 1 && is_string($aArgs[$i])) { |
|
| 612 | - |
|
| 613 | - $aArgs[$i] = stripslashes($aArgs[$i]); |
|
| 614 | - } |
|
| 615 | - if (stristr($aArgs[$i],"<xjxobj>") != false) |
|
| 616 | - { |
|
| 617 | - $aArgs[$i] = $this->_xmlToArray("xjxobj",$aArgs[$i]); |
|
| 618 | - } |
|
| 619 | - else if (stristr($aArgs[$i],"<xjxquery>") != false) |
|
| 620 | - { |
|
| 621 | - $aArgs[$i] = $this->_xmlToArray("xjxquery",$aArgs[$i]); |
|
| 622 | - } |
|
| 623 | - else if ($this->bDecodeUTF8Input) |
|
| 624 | - { |
|
| 625 | - $aArgs[$i] = $this->_decodeUTF8Data($aArgs[$i]); |
|
| 626 | - } |
|
| 627 | - } |
|
| 628 | - |
|
| 629 | - if ($this->sPreFunction) { |
|
| 630 | - $mPreResponse = $this->_callFunction($this->sPreFunction, array($sFunctionNameForSpecial, $aArgs)); |
|
| 631 | - if (is_array($mPreResponse) && $mPreResponse[0] === false) { |
|
| 632 | - $bEndRequest = true; |
|
| 633 | - $sPreResponse = $mPreResponse[1]; |
|
| 634 | - } |
|
| 635 | - else { |
|
| 636 | - $sPreResponse = $mPreResponse; |
|
| 637 | - } |
|
| 638 | - if (is_a($sPreResponse, "xajaxResponse")) { |
|
| 639 | - $sPreResponse = $sPreResponse->getXML(); |
|
| 640 | - } |
|
| 641 | - if ($bEndRequest) $sResponse = $sPreResponse; |
|
| 642 | - } |
|
| 643 | - |
|
| 644 | - if (!$bEndRequest) { |
|
| 645 | - if (!$this->_isFunctionCallable($sFunctionName)) { |
|
| 646 | - $objResponse = new xajaxResponse(); |
|
| 647 | - $objResponse->addAlert("The Registered Function $sFunctionName Could Not Be Found."); |
|
| 648 | - $sResponse = $objResponse->getXML(); |
|
| 649 | - } |
|
| 650 | - else { |
|
| 651 | - if ($bFunctionIsCatchAll) { |
|
| 652 | - $aArgs = array($sFunctionNameForSpecial, $aArgs); |
|
| 653 | - } |
|
| 654 | - $sResponse = $this->_callFunction($sFunctionName, $aArgs); |
|
| 655 | - } |
|
| 656 | - if (is_a($sResponse, "xajaxResponse")) { |
|
| 657 | - $sResponse = $sResponse->getXML(); |
|
| 658 | - } |
|
| 659 | - if (!is_string($sResponse) || strpos($sResponse, "<xjx>") === FALSE) { |
|
| 660 | - $objResponse = new xajaxResponse(); |
|
| 661 | - $objResponse->addAlert("No XML Response Was Returned By Function $sFunctionName."); |
|
| 662 | - $sResponse = $objResponse->getXML(); |
|
| 663 | - } |
|
| 664 | - else if ($sPreResponse != "") { |
|
| 665 | - $sNewResponse = new xajaxResponse($this->sEncoding, $this->bOutputEntities); |
|
| 666 | - $sNewResponse->loadXML($sPreResponse); |
|
| 667 | - $sNewResponse->loadXML($sResponse); |
|
| 668 | - $sResponse = $sNewResponse->getXML(); |
|
| 669 | - } |
|
| 670 | - } |
|
| 671 | - } |
|
| 672 | - |
|
| 673 | - $sContentHeader = "Content-type: text/xml;"; |
|
| 674 | - if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0) |
|
| 675 | - $sContentHeader .= " charset=".$this->sEncoding; |
|
| 676 | - header($sContentHeader); |
|
| 677 | - if ($this->bErrorHandler && !empty( $GLOBALS['xajaxErrorHandlerText'] )) { |
|
| 678 | - $sErrorResponse = new xajaxResponse(); |
|
| 679 | - $sErrorResponse->addAlert("** PHP Error Messages: **" . $GLOBALS['xajaxErrorHandlerText']); |
|
| 680 | - if ($this->sLogFile) { |
|
| 681 | - $fH = @fopen($this->sLogFile, "a"); |
|
| 682 | - if (!$fH) { |
|
| 683 | - $sErrorResponse->addAlert("** Logging Error **\n\nxajax was unable to write to the error log file:\n" . $this->sLogFile); |
|
| 684 | - } |
|
| 685 | - else { |
|
| 686 | - fwrite($fH, "** xajax Error Log - " . strftime("%b %e %Y %I:%M:%S %p") . " **" . $GLOBALS['xajaxErrorHandlerText'] . "\n\n\n"); |
|
| 687 | - fclose($fH); |
|
| 688 | - } |
|
| 689 | - } |
|
| 690 | - |
|
| 691 | - $sErrorResponse->loadXML($sResponse); |
|
| 692 | - $sResponse = $sErrorResponse->getXML(); |
|
| 693 | - |
|
| 694 | - } |
|
| 695 | - if ($this->bCleanBuffer) while (@ob_end_clean()); |
|
| 696 | - print $sResponse; |
|
| 697 | - if ($this->bErrorHandler) restore_error_handler(); |
|
| 698 | - |
|
| 699 | - if ($this->bExitAllowed) |
|
| 700 | - exit(); |
|
| 701 | - } |
|
| 702 | - |
|
| 703 | - /** |
|
| 704 | - * Prints the xajax Javascript header and wrapper code into your page by |
|
| 705 | - * printing the output of the getJavascript() method. It should only be |
|
| 706 | - * called between the <pre><head> </head></pre> tags in your HTML page. |
|
| 707 | - * Remember, if you only want to obtain the result of this function, use |
|
| 708 | - * {@link xajax::getJavascript()} instead. |
|
| 709 | - * |
|
| 710 | - * <i>Usage:</i> |
|
| 711 | - * <code> |
|
| 712 | - * <head> |
|
| 713 | - * ... |
|
| 714 | - * < ?php $xajax->printJavascript(); ? > |
|
| 715 | - * </code> |
|
| 716 | - * |
|
| 717 | - * @param string the relative address of the folder where xajax has been |
|
| 718 | - * installed. For instance, if your PHP file is |
|
| 719 | - * "http://www.myserver.com/myfolder/mypage.php" |
|
| 720 | - * and xajax was installed in |
|
| 721 | - * "http://www.myserver.com/anotherfolder", then $sJsURI |
|
| 722 | - * should be set to "../anotherfolder". Defaults to assuming |
|
| 723 | - * xajax is in the same folder as your PHP file. |
|
| 724 | - * @param string the relative folder/file pair of the xajax Javascript |
|
| 725 | - * engine located within the xajax installation folder. |
|
| 726 | - * Defaults to xajax_js/xajax.js. |
|
| 727 | - */ |
|
| 728 | - function printJavascript($sJsURI="", $sJsFile=NULL) |
|
| 729 | - { |
|
| 730 | - print $this->getJavascript($sJsURI, $sJsFile); |
|
| 731 | - } |
|
| 732 | - |
|
| 733 | - /** |
|
| 734 | - * Returns the xajax Javascript code that should be added to your HTML page |
|
| 735 | - * between the <kbd><head> </head></kbd> tags. |
|
| 736 | - * |
|
| 737 | - * <i>Usage:</i> |
|
| 738 | - * <code> |
|
| 739 | - * < ?php $xajaxJSHead = $xajax->getJavascript(); ? > |
|
| 740 | - * <head> |
|
| 741 | - * ... |
|
| 742 | - * < ?php echo $xajaxJSHead; ? > |
|
| 743 | - * </code> |
|
| 744 | - * |
|
| 745 | - * @param string the relative address of the folder where xajax has been |
|
| 746 | - * installed. For instance, if your PHP file is |
|
| 747 | - * "http://www.myserver.com/myfolder/mypage.php" |
|
| 748 | - * and xajax was installed in |
|
| 749 | - * "http://www.myserver.com/anotherfolder", then $sJsURI |
|
| 750 | - * should be set to "../anotherfolder". Defaults to assuming |
|
| 751 | - * xajax is in the same folder as your PHP file. |
|
| 752 | - * @param string the relative folder/file pair of the xajax Javascript |
|
| 753 | - * engine located within the xajax installation folder. |
|
| 754 | - * Defaults to xajax_js/xajax.js. |
|
| 755 | - * @return string |
|
| 756 | - */ |
|
| 757 | - function getJavascript($sJsURI="", $sJsFile=NULL) |
|
| 758 | - { |
|
| 759 | - $html = $this->getJavascriptConfig(); |
|
| 760 | - $html .= $this->getJavascriptInclude($sJsURI, $sJsFile); |
|
| 761 | - |
|
| 762 | - return $html; |
|
| 763 | - } |
|
| 764 | - |
|
| 765 | - /** |
|
| 766 | - * Returns a string containing inline Javascript that sets up the xajax |
|
| 767 | - * runtime (typically called internally by xajax from get/printJavascript). |
|
| 768 | - * |
|
| 769 | - * @return string |
|
| 770 | - */ |
|
| 771 | - function getJavascriptConfig() |
|
| 772 | - { |
|
| 773 | - $html = "\t<script type=\"text/javascript\">\n"; |
|
| 774 | - $html .= "var xajaxRequestUri=\"".$this->sRequestURI."\";\n"; |
|
| 775 | - $html .= "var xajaxDebug=".($this->bDebug?"true":"false").";\n"; |
|
| 776 | - $html .= "var xajaxStatusMessages=".($this->bStatusMessages?"true":"false").";\n"; |
|
| 777 | - $html .= "var xajaxWaitCursor=".($this->bWaitCursor?"true":"false").";\n"; |
|
| 778 | - $html .= "var xajaxDefinedGet=".XAJAX_GET.";\n"; |
|
| 779 | - $html .= "var xajaxDefinedPost=".XAJAX_POST.";\n"; |
|
| 780 | - $html .= "var xajaxLoaded=false;\n"; |
|
| 781 | - |
|
| 782 | - foreach($this->aFunctions as $sFunction => $bExists) { |
|
| 783 | - $html .= $this->_wrap($sFunction,$this->aFunctionRequestTypes[$sFunction]); |
|
| 784 | - } |
|
| 785 | - |
|
| 786 | - $html .= "\t</script>\n"; |
|
| 787 | - return $html; |
|
| 788 | - } |
|
| 789 | - |
|
| 790 | - /** |
|
| 791 | - * Returns a string containing a Javascript include of the xajax.js file |
|
| 792 | - * along with a check to see if the file loaded after six seconds |
|
| 793 | - * (typically called internally by xajax from get/printJavascript). |
|
| 794 | - * |
|
| 795 | - * @param string the relative address of the folder where xajax has been |
|
| 796 | - * installed. For instance, if your PHP file is |
|
| 797 | - * "http://www.myserver.com/myfolder/mypage.php" |
|
| 798 | - * and xajax was installed in |
|
| 799 | - * "http://www.myserver.com/anotherfolder", then $sJsURI |
|
| 800 | - * should be set to "../anotherfolder". Defaults to assuming |
|
| 801 | - * xajax is in the same folder as your PHP file. |
|
| 802 | - * @param string the relative folder/file pair of the xajax Javascript |
|
| 803 | - * engine located within the xajax installation folder. |
|
| 804 | - * Defaults to xajax_js/xajax.js. |
|
| 805 | - * @return string |
|
| 806 | - */ |
|
| 807 | - function getJavascriptInclude($sJsURI="", $sJsFile=NULL) |
|
| 808 | - { |
|
| 809 | - if ($sJsFile == NULL) $sJsFile = "xajax_js/xajax.js"; |
|
| 810 | - |
|
| 811 | - if ($sJsURI != "" && substr($sJsURI, -1) != "/") $sJsURI .= "/"; |
|
| 812 | - |
|
| 813 | - $html = "\t<script type=\"text/javascript\" src=\"" . $sJsURI . $sJsFile . "\"></script>\n"; |
|
| 814 | - $html .= "\t<script type=\"text/javascript\">\n"; |
|
| 815 | - $html .= "window.setTimeout(function () { if (!xajaxLoaded) { alert('Error: the xajax Javascript file could not be included. Perhaps the URL is incorrect?\\nURL: {$sJsURI}{$sJsFile}'); } }, 6000);\n"; |
|
| 816 | - $html .= "\t</script>\n"; |
|
| 817 | - return $html; |
|
| 818 | - } |
|
| 819 | - |
|
| 820 | - /** |
|
| 821 | - * This method can be used to create a new xajax.js file out of the |
|
| 822 | - * xajax_uncompressed.js file (which will only happen if xajax.js doesn't |
|
| 823 | - * already exist on the filesystem). |
|
| 824 | - * |
|
| 825 | - * @param string an optional argument containing the full server file path |
|
| 826 | - * of xajax.js. |
|
| 827 | - */ |
|
| 828 | - function autoCompressJavascript($sJsFullFilename=NULL) |
|
| 829 | - { |
|
| 830 | - $sJsFile = "xajax_js/xajax.js"; |
|
| 831 | - |
|
| 832 | - if ($sJsFullFilename) { |
|
| 833 | - $realJsFile = $sJsFullFilename; |
|
| 834 | - } |
|
| 835 | - else { |
|
| 836 | - $realPath = realpath(dirname(__FILE__)); |
|
| 837 | - $realJsFile = $realPath . "/". $sJsFile; |
|
| 838 | - } |
|
| 839 | - |
|
| 840 | - // Create a compressed file if necessary |
|
| 841 | - if (!file_exists($realJsFile)) { |
|
| 842 | - $srcFile = str_replace(".js", "_uncompressed.js", $realJsFile); |
|
| 843 | - if (!file_exists($srcFile)) { |
|
| 844 | - trigger_error("The xajax uncompressed Javascript file could not be found in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR); |
|
| 845 | - } |
|
| 846 | - require(dirname(__FILE__)."/xajaxCompress.php"); |
|
| 847 | - $javaScript = implode('', file($srcFile)); |
|
| 848 | - $compressedScript = xajaxCompressJavascript($javaScript); |
|
| 849 | - $fH = @fopen($realJsFile, "w"); |
|
| 850 | - if (!$fH) { |
|
| 851 | - trigger_error("The xajax compressed javascript file could not be written in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR); |
|
| 852 | - } |
|
| 853 | - else { |
|
| 854 | - fwrite($fH, $compressedScript); |
|
| 855 | - fclose($fH); |
|
| 856 | - } |
|
| 857 | - } |
|
| 858 | - } |
|
| 859 | - |
|
| 860 | - /** |
|
| 861 | - * Returns the current URL based upon the SERVER vars. |
|
| 862 | - * |
|
| 863 | - * @access private |
|
| 864 | - * @return string |
|
| 865 | - */ |
|
| 866 | - function _detectURI() { |
|
| 867 | - $aURL = array(); |
|
| 868 | - |
|
| 869 | - // Try to get the request URL |
|
| 870 | - if (!empty($_SERVER['REQUEST_URI'])) { |
|
| 871 | - $aURL = parse_url($_SERVER['REQUEST_URI']); |
|
| 872 | - } |
|
| 873 | - |
|
| 874 | - // Fill in the empty values |
|
| 875 | - if (empty($aURL['scheme'])) { |
|
| 876 | - if (!empty($_SERVER['HTTP_SCHEME'])) { |
|
| 877 | - $aURL['scheme'] = $_SERVER['HTTP_SCHEME']; |
|
| 878 | - } else { |
|
| 879 | - $aURL['scheme'] = (!empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off') ? 'https' : 'http'; |
|
| 880 | - } |
|
| 881 | - } |
|
| 882 | - |
|
| 883 | - if (empty($aURL['host'])) { |
|
| 884 | - if (!empty($_SERVER['HTTP_HOST'])) { |
|
| 885 | - if (strpos($_SERVER['HTTP_HOST'], ':') > 0) { |
|
| 886 | - list($aURL['host'], $aURL['port']) = explode(':', $_SERVER['HTTP_HOST']); |
|
| 887 | - } else { |
|
| 888 | - $aURL['host'] = $_SERVER['HTTP_HOST']; |
|
| 889 | - } |
|
| 890 | - } else if (!empty($_SERVER['SERVER_NAME'])) { |
|
| 891 | - $aURL['host'] = $_SERVER['SERVER_NAME']; |
|
| 892 | - } else { |
|
| 893 | - print "xajax Error: xajax failed to automatically identify your Request URI."; |
|
| 894 | - print "Please set the Request URI explicitly when you instantiate the xajax object."; |
|
| 895 | - exit(); |
|
| 896 | - } |
|
| 897 | - } |
|
| 898 | - |
|
| 899 | - if (empty($aURL['port']) && !empty($_SERVER['SERVER_PORT'])) { |
|
| 900 | - $aURL['port'] = $_SERVER['SERVER_PORT']; |
|
| 901 | - } |
|
| 902 | - |
|
| 903 | - if (empty($aURL['path'])) { |
|
| 904 | - if (!empty($_SERVER['PATH_INFO'])) { |
|
| 905 | - $sPath = parse_url($_SERVER['PATH_INFO']); |
|
| 906 | - } else { |
|
| 907 | - $sPath = parse_url(api_get_self()); |
|
| 908 | - } |
|
| 909 | - $aURL['path'] = $sPath['path']; |
|
| 910 | - unset($sPath); |
|
| 911 | - } |
|
| 912 | - |
|
| 913 | - if (!empty($aURL['query'])) { |
|
| 914 | - $aURL['query'] = '?'.$aURL['query']; |
|
| 915 | - } |
|
| 916 | - |
|
| 917 | - // Build the URL: Start with scheme, user and pass |
|
| 918 | - $sURL = $aURL['scheme'].'://'; |
|
| 919 | - if (!empty($aURL['user'])) { |
|
| 920 | - $sURL.= $aURL['user']; |
|
| 921 | - if (!empty($aURL['pass'])) { |
|
| 922 | - $sURL.= ':'.$aURL['pass']; |
|
| 923 | - } |
|
| 924 | - $sURL.= '@'; |
|
| 925 | - } |
|
| 926 | - |
|
| 927 | - // Add the host |
|
| 928 | - $sURL.= $aURL['host']; |
|
| 929 | - |
|
| 930 | - // Add the port if needed |
|
| 931 | - if (!empty($aURL['port']) && (($aURL['scheme'] == 'http' && $aURL['port'] != 80) || ($aURL['scheme'] == 'https' && $aURL['port'] != 443))) { |
|
| 932 | - $sURL.= ':'.$aURL['port']; |
|
| 933 | - } |
|
| 934 | - |
|
| 935 | - // Add the path and the query string |
|
| 936 | - $sURL.= $aURL['path'].@$aURL['query']; |
|
| 937 | - |
|
| 938 | - // Clean up |
|
| 939 | - unset($aURL); |
|
| 940 | - return $sURL; |
|
| 941 | - } |
|
| 942 | - |
|
| 943 | - /** |
|
| 944 | - * Returns true if the function name is associated with an object callback, |
|
| 945 | - * false if not. |
|
| 946 | - * |
|
| 947 | - * @param string the name of the function |
|
| 948 | - * @access private |
|
| 949 | - * @return boolean |
|
| 950 | - */ |
|
| 951 | - function _isObjectCallback($sFunction) |
|
| 952 | - { |
|
| 953 | - if (array_key_exists($sFunction, $this->aObjects)) return true; |
|
| 954 | - return false; |
|
| 955 | - } |
|
| 956 | - |
|
| 957 | - /** |
|
| 958 | - * Returns true if the function or object callback can be called, false if |
|
| 959 | - * not. |
|
| 960 | - * |
|
| 961 | - * @param string the name of the function |
|
| 962 | - * @access private |
|
| 963 | - * @return boolean |
|
| 964 | - */ |
|
| 965 | - function _isFunctionCallable($sFunction) |
|
| 966 | - { |
|
| 967 | - if ($this->_isObjectCallback($sFunction)) { |
|
| 968 | - if (is_object($this->aObjects[$sFunction][0])) { |
|
| 969 | - return method_exists($this->aObjects[$sFunction][0], $this->aObjects[$sFunction][1]); |
|
| 970 | - } |
|
| 971 | - else { |
|
| 972 | - return is_callable($this->aObjects[$sFunction]); |
|
| 973 | - } |
|
| 974 | - } |
|
| 975 | - else { |
|
| 976 | - return function_exists($sFunction); |
|
| 977 | - } |
|
| 978 | - } |
|
| 979 | - |
|
| 980 | - /** |
|
| 981 | - * Calls the function, class method, or object method with the supplied |
|
| 982 | - * arguments. |
|
| 983 | - * |
|
| 984 | - * @param string the name of the function |
|
| 985 | - * @param array arguments to pass to the function |
|
| 986 | - * @access private |
|
| 987 | - * @return mixed the output of the called function or method |
|
| 988 | - */ |
|
| 989 | - function _callFunction($sFunction, $aArgs) |
|
| 990 | - { |
|
| 991 | - if ($this->_isObjectCallback($sFunction)) { |
|
| 992 | - $mReturn = call_user_func_array($this->aObjects[$sFunction], $aArgs); |
|
| 993 | - } |
|
| 994 | - else { |
|
| 995 | - $mReturn = call_user_func_array($sFunction, $aArgs); |
|
| 996 | - } |
|
| 997 | - return $mReturn; |
|
| 998 | - } |
|
| 999 | - |
|
| 1000 | - /** |
|
| 1001 | - * Generates the Javascript wrapper for the specified PHP function. |
|
| 1002 | - * |
|
| 1003 | - * @param string the name of the function |
|
| 1004 | - * @param mixed the request type |
|
| 1005 | - * @access private |
|
| 1006 | - * @return string |
|
| 1007 | - */ |
|
| 1008 | - function _wrap($sFunction,$sRequestType=XAJAX_POST) |
|
| 1009 | - { |
|
| 1010 | - $js = "function ".$this->sWrapperPrefix."$sFunction(){return xajax.call(\"$sFunction\", arguments, ".$sRequestType.");}\n"; |
|
| 1011 | - return $js; |
|
| 1012 | - } |
|
| 1013 | - |
|
| 1014 | - /** |
|
| 1015 | - * Takes a string containing xajax xjxobj XML or xjxquery XML and builds an |
|
| 1016 | - * array representation of it to pass as an argument to the PHP function |
|
| 1017 | - * being called. |
|
| 1018 | - * |
|
| 1019 | - * @param string the root tag of the XML |
|
| 1020 | - * @param string XML to convert |
|
| 1021 | - * @access private |
|
| 1022 | - * @return array |
|
| 1023 | - */ |
|
| 1024 | - function _xmlToArray($rootTag, $sXml) |
|
| 1025 | - { |
|
| 1026 | - $aArray = array(); |
|
| 1027 | - $sXml = str_replace("<$rootTag>","<$rootTag>|~|",$sXml); |
|
| 1028 | - $sXml = str_replace("</$rootTag>","</$rootTag>|~|",$sXml); |
|
| 1029 | - $sXml = str_replace("<e>","<e>|~|",$sXml); |
|
| 1030 | - $sXml = str_replace("</e>","</e>|~|",$sXml); |
|
| 1031 | - $sXml = str_replace("<k>","<k>|~|",$sXml); |
|
| 1032 | - $sXml = str_replace("</k>","|~|</k>|~|",$sXml); |
|
| 1033 | - $sXml = str_replace("<v>","<v>|~|",$sXml); |
|
| 1034 | - $sXml = str_replace("</v>","|~|</v>|~|",$sXml); |
|
| 1035 | - $sXml = str_replace("<q>","<q>|~|",$sXml); |
|
| 1036 | - $sXml = str_replace("</q>","|~|</q>|~|",$sXml); |
|
| 1037 | - |
|
| 1038 | - $this->aObjArray = explode("|~|",$sXml); |
|
| 1039 | - |
|
| 1040 | - $this->iPos = 0; |
|
| 1041 | - $aArray = $this->_parseObjXml($rootTag); |
|
| 1042 | - |
|
| 1043 | - return $aArray; |
|
| 1044 | - } |
|
| 1045 | - |
|
| 1046 | - /** |
|
| 1047 | - * A recursive function that generates an array from the contents of |
|
| 1048 | - * $this->aObjArray. |
|
| 1049 | - * |
|
| 1050 | - * @param string the root tag of the XML |
|
| 1051 | - * @access private |
|
| 1052 | - * @return array |
|
| 1053 | - */ |
|
| 1054 | - function _parseObjXml($rootTag) |
|
| 1055 | - { |
|
| 1056 | - $aArray = array(); |
|
| 1057 | - |
|
| 1058 | - if ($rootTag == "xjxobj") |
|
| 1059 | - { |
|
| 1060 | - while(!stristr($this->aObjArray[$this->iPos],"</xjxobj>")) |
|
| 1061 | - { |
|
| 1062 | - $this->iPos++; |
|
| 1063 | - if(stristr($this->aObjArray[$this->iPos],"<e>")) |
|
| 1064 | - { |
|
| 1065 | - $key = ""; |
|
| 1066 | - $value = null; |
|
| 1067 | - |
|
| 1068 | - $this->iPos++; |
|
| 1069 | - while(!stristr($this->aObjArray[$this->iPos],"</e>")) |
|
| 1070 | - { |
|
| 1071 | - if(stristr($this->aObjArray[$this->iPos],"<k>")) |
|
| 1072 | - { |
|
| 1073 | - $this->iPos++; |
|
| 1074 | - while(!stristr($this->aObjArray[$this->iPos],"</k>")) |
|
| 1075 | - { |
|
| 1076 | - $key .= $this->aObjArray[$this->iPos]; |
|
| 1077 | - $this->iPos++; |
|
| 1078 | - } |
|
| 1079 | - } |
|
| 1080 | - if(stristr($this->aObjArray[$this->iPos],"<v>")) |
|
| 1081 | - { |
|
| 1082 | - $this->iPos++; |
|
| 1083 | - while(!stristr($this->aObjArray[$this->iPos],"</v>")) |
|
| 1084 | - { |
|
| 1085 | - if(stristr($this->aObjArray[$this->iPos],"<xjxobj>")) |
|
| 1086 | - { |
|
| 1087 | - $value = $this->_parseObjXml("xjxobj"); |
|
| 1088 | - $this->iPos++; |
|
| 1089 | - } |
|
| 1090 | - else |
|
| 1091 | - { |
|
| 1092 | - $value .= $this->aObjArray[$this->iPos]; |
|
| 1093 | - if ($this->bDecodeUTF8Input) |
|
| 1094 | - { |
|
| 1095 | - $value = $this->_decodeUTF8Data($value); |
|
| 1096 | - } |
|
| 1097 | - } |
|
| 1098 | - $this->iPos++; |
|
| 1099 | - } |
|
| 1100 | - } |
|
| 1101 | - $this->iPos++; |
|
| 1102 | - } |
|
| 1103 | - |
|
| 1104 | - $aArray[$key]=$value; |
|
| 1105 | - } |
|
| 1106 | - } |
|
| 1107 | - } |
|
| 1108 | - |
|
| 1109 | - if ($rootTag == "xjxquery") |
|
| 1110 | - { |
|
| 1111 | - $sQuery = ""; |
|
| 1112 | - $this->iPos++; |
|
| 1113 | - while(!stristr($this->aObjArray[$this->iPos],"</xjxquery>")) |
|
| 1114 | - { |
|
| 1115 | - if (stristr($this->aObjArray[$this->iPos],"<q>") || stristr($this->aObjArray[$this->iPos],"</q>")) |
|
| 1116 | - { |
|
| 1117 | - $this->iPos++; |
|
| 1118 | - continue; |
|
| 1119 | - } |
|
| 1120 | - $sQuery .= $this->aObjArray[$this->iPos]; |
|
| 1121 | - $this->iPos++; |
|
| 1122 | - } |
|
| 1123 | - |
|
| 1124 | - parse_str($sQuery, $aArray); |
|
| 1125 | - if ($this->bDecodeUTF8Input) |
|
| 1126 | - { |
|
| 1127 | - foreach($aArray as $key => $value) |
|
| 1128 | - { |
|
| 1129 | - $aArray[$key] = $this->_decodeUTF8Data($value); |
|
| 1130 | - } |
|
| 1131 | - } |
|
| 1132 | - // If magic quotes is on, then we need to strip the slashes from the |
|
| 1133 | - // array values because of the parse_str pass which adds slashes |
|
| 1134 | - if (get_magic_quotes_gpc() == 1) { |
|
| 1135 | - $newArray = array(); |
|
| 1136 | - foreach ($aArray as $sKey => $sValue) { |
|
| 1137 | - if (is_string($sValue)) |
|
| 1138 | - $newArray[$sKey] = stripslashes($sValue); |
|
| 1139 | - else |
|
| 1140 | - $newArray[$sKey] = $sValue; |
|
| 1141 | - } |
|
| 1142 | - $aArray = $newArray; |
|
| 1143 | - } |
|
| 1144 | - } |
|
| 1145 | - |
|
| 1146 | - return $aArray; |
|
| 1147 | - } |
|
| 1148 | - |
|
| 1149 | - /** |
|
| 1150 | - * Decodes string data from UTF-8 to the current xajax encoding. |
|
| 1151 | - * |
|
| 1152 | - * @param string data to convert |
|
| 1153 | - * @access private |
|
| 1154 | - * @return string converted data |
|
| 1155 | - */ |
|
| 1156 | - function _decodeUTF8Data($sData) |
|
| 1157 | - { |
|
| 1158 | - $sValue = $sData; |
|
| 1159 | - if ($this->bDecodeUTF8Input) |
|
| 1160 | - { |
|
| 1161 | - $sFuncToUse = NULL; |
|
| 1162 | - |
|
| 1163 | - // An adaptation for the Dokeos LMS, 22-AUG-2009. |
|
| 1164 | - if (function_exists('api_convert_encoding')) |
|
| 1165 | - { |
|
| 1166 | - $sFuncToUse = "api_convert_encoding"; |
|
| 1167 | - } |
|
| 1168 | - //if (function_exists('iconv')) |
|
| 1169 | - elseif (function_exists('iconv')) |
|
| 1170 | - // |
|
| 1171 | - { |
|
| 1172 | - $sFuncToUse = "iconv"; |
|
| 1173 | - } |
|
| 1174 | - else if (function_exists('mb_convert_encoding')) |
|
| 1175 | - { |
|
| 1176 | - $sFuncToUse = "mb_convert_encoding"; |
|
| 1177 | - } |
|
| 1178 | - else if ($this->sEncoding == "ISO-8859-1") |
|
| 1179 | - { |
|
| 1180 | - $sFuncToUse = "utf8_decode"; |
|
| 1181 | - } |
|
| 1182 | - else |
|
| 1183 | - { |
|
| 1184 | - trigger_error("The incoming xajax data could not be converted from UTF-8", E_USER_NOTICE); |
|
| 1185 | - } |
|
| 1186 | - |
|
| 1187 | - if ($sFuncToUse) |
|
| 1188 | - { |
|
| 1189 | - if (is_string($sValue)) |
|
| 1190 | - { |
|
| 1191 | - if ($sFuncToUse == "iconv") |
|
| 1192 | - { |
|
| 1193 | - $sValue = iconv("UTF-8", $this->sEncoding.'//TRANSLIT', $sValue); |
|
| 1194 | - } |
|
| 1195 | - else if ($sFuncToUse == "mb_convert_encoding") |
|
| 1196 | - { |
|
| 1197 | - $sValue = mb_convert_encoding($sValue, $this->sEncoding, "UTF-8"); |
|
| 1198 | - } |
|
| 1199 | - // Added code, an adaptation for the Dokeos LMS, 22-AUG-2009. |
|
| 1200 | - else if ($sFuncToUse == "api_convert_encoding") |
|
| 1201 | - { |
|
| 1202 | - $sValue = api_convert_encoding($sValue, $this->sEncoding, "UTF-8"); |
|
| 1203 | - } |
|
| 1204 | - // |
|
| 1205 | - else |
|
| 1206 | - { |
|
| 1207 | - $sValue = utf8_decode($sValue); |
|
| 1208 | - } |
|
| 1209 | - } |
|
| 1210 | - } |
|
| 1211 | - } |
|
| 1212 | - return $sValue; |
|
| 1213 | - } |
|
| 78 | + /** |
|
| 79 | + * @var array Array of PHP functions that will be callable through javascript wrappers |
|
| 80 | + */ |
|
| 81 | + var $aFunctions; |
|
| 82 | + /** |
|
| 83 | + * @var array Array of object callbacks that will allow Javascript to call PHP methods (key=function name) |
|
| 84 | + */ |
|
| 85 | + var $aObjects; |
|
| 86 | + /** |
|
| 87 | + * @var array Array of RequestTypes to be used with each function (key=function name) |
|
| 88 | + */ |
|
| 89 | + var $aFunctionRequestTypes; |
|
| 90 | + /** |
|
| 91 | + * @var array Array of Include Files for any external functions (key=function name) |
|
| 92 | + */ |
|
| 93 | + var $aFunctionIncludeFiles; |
|
| 94 | + /** |
|
| 95 | + * @var string Name of the PHP function to call if no callable function was found |
|
| 96 | + */ |
|
| 97 | + var $sCatchAllFunction; |
|
| 98 | + /** |
|
| 99 | + * @var string Name of the PHP function to call before any other function |
|
| 100 | + */ |
|
| 101 | + var $sPreFunction; |
|
| 102 | + /** |
|
| 103 | + * @var string The URI for making requests to the xajax object |
|
| 104 | + */ |
|
| 105 | + var $sRequestURI; |
|
| 106 | + /** |
|
| 107 | + * @var string The prefix to prepend to the javascript wraper function name |
|
| 108 | + */ |
|
| 109 | + var $sWrapperPrefix; |
|
| 110 | + /** |
|
| 111 | + * @var boolean Show debug messages (default false) |
|
| 112 | + */ |
|
| 113 | + var $bDebug; |
|
| 114 | + /** |
|
| 115 | + * @var boolean Show messages in the client browser's status bar (default false) |
|
| 116 | + */ |
|
| 117 | + var $bStatusMessages; |
|
| 118 | + /** |
|
| 119 | + * @var boolean Allow xajax to exit after processing a request (default true) |
|
| 120 | + */ |
|
| 121 | + var $bExitAllowed; |
|
| 122 | + /** |
|
| 123 | + * @var boolean Use wait cursor in browser (default true) |
|
| 124 | + */ |
|
| 125 | + var $bWaitCursor; |
|
| 126 | + /** |
|
| 127 | + * @var boolean Use an special xajax error handler so the errors are sent to the browser properly (default false) |
|
| 128 | + */ |
|
| 129 | + var $bErrorHandler; |
|
| 130 | + /** |
|
| 131 | + * @var string Specify what, if any, file xajax should log errors to (and more information in a future release) |
|
| 132 | + */ |
|
| 133 | + var $sLogFile; |
|
| 134 | + /** |
|
| 135 | + * @var boolean Clean all output buffers before outputting response (default false) |
|
| 136 | + */ |
|
| 137 | + var $bCleanBuffer; |
|
| 138 | + /** |
|
| 139 | + * @var string String containing the character encoding used |
|
| 140 | + */ |
|
| 141 | + var $sEncoding; |
|
| 142 | + /** |
|
| 143 | + * @var boolean Decode input request args from UTF-8 (default false) |
|
| 144 | + */ |
|
| 145 | + var $bDecodeUTF8Input; |
|
| 146 | + /** |
|
| 147 | + * @var boolean Convert special characters to HTML entities (default false) |
|
| 148 | + */ |
|
| 149 | + var $bOutputEntities; |
|
| 150 | + /** |
|
| 151 | + * @var array Array for parsing complex objects |
|
| 152 | + */ |
|
| 153 | + var $aObjArray; |
|
| 154 | + /** |
|
| 155 | + * @var integer Position in $aObjArray |
|
| 156 | + */ |
|
| 157 | + var $iPos; |
|
| 158 | + |
|
| 159 | + /**#@-*/ |
|
| 160 | + |
|
| 161 | + /** |
|
| 162 | + * Constructor. You can set some extra xajax options right away or use |
|
| 163 | + * individual methods later to set options. |
|
| 164 | + * |
|
| 165 | + * @param string defaults to the current browser URI |
|
| 166 | + * @param string defaults to "xajax_"; |
|
| 167 | + * @param string defaults to XAJAX_DEFAULT_CHAR_ENCODING defined above |
|
| 168 | + * @param boolean defaults to false |
|
| 169 | + */ |
|
| 170 | + public function __construct($sRequestURI="",$sWrapperPrefix="xajax_",$sEncoding=XAJAX_DEFAULT_CHAR_ENCODING,$bDebug=false) |
|
| 171 | + { |
|
| 172 | + $this->aFunctions = array(); |
|
| 173 | + $this->aObjects = array(); |
|
| 174 | + $this->aFunctionIncludeFiles = array(); |
|
| 175 | + $this->sRequestURI = $sRequestURI; |
|
| 176 | + if ($this->sRequestURI == "") |
|
| 177 | + $this->sRequestURI = $this->_detectURI(); |
|
| 178 | + $this->sWrapperPrefix = $sWrapperPrefix; |
|
| 179 | + $this->bDebug = $bDebug; |
|
| 180 | + $this->bStatusMessages = false; |
|
| 181 | + $this->bWaitCursor = true; |
|
| 182 | + $this->bExitAllowed = true; |
|
| 183 | + $this->bErrorHandler = false; |
|
| 184 | + $this->sLogFile = ""; |
|
| 185 | + $this->bCleanBuffer = false; |
|
| 186 | + $this->setCharEncoding($sEncoding); |
|
| 187 | + $this->bDecodeUTF8Input = false; |
|
| 188 | + $this->bOutputEntities = false; |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + /** |
|
| 192 | + * Sets the URI to which requests will be made. |
|
| 193 | + * <i>Usage:</i> <kbd>$xajax->setRequestURI("http://www.xajaxproject.org");</kbd> |
|
| 194 | + * |
|
| 195 | + * @param string the URI (can be absolute or relative) of the PHP script |
|
| 196 | + * that will be accessed when an xajax request occurs |
|
| 197 | + */ |
|
| 198 | + function setRequestURI($sRequestURI) |
|
| 199 | + { |
|
| 200 | + $this->sRequestURI = $sRequestURI; |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + /** |
|
| 204 | + * Sets the prefix that will be appended to the Javascript wrapper |
|
| 205 | + * functions (default is "xajax_"). |
|
| 206 | + * |
|
| 207 | + * @param string |
|
| 208 | + */ |
|
| 209 | + // |
|
| 210 | + function setWrapperPrefix($sPrefix) |
|
| 211 | + { |
|
| 212 | + $this->sWrapperPrefix = $sPrefix; |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + /** |
|
| 216 | + * Enables debug messages for xajax. |
|
| 217 | + * */ |
|
| 218 | + function debugOn() |
|
| 219 | + { |
|
| 220 | + $this->bDebug = true; |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + /** |
|
| 224 | + * Disables debug messages for xajax (default behavior). |
|
| 225 | + */ |
|
| 226 | + function debugOff() |
|
| 227 | + { |
|
| 228 | + $this->bDebug = false; |
|
| 229 | + } |
|
| 230 | + |
|
| 231 | + /** |
|
| 232 | + * Enables messages in the browser's status bar for xajax. |
|
| 233 | + */ |
|
| 234 | + function statusMessagesOn() |
|
| 235 | + { |
|
| 236 | + $this->bStatusMessages = true; |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + /** |
|
| 240 | + * Disables messages in the browser's status bar for xajax (default behavior). |
|
| 241 | + */ |
|
| 242 | + function statusMessagesOff() |
|
| 243 | + { |
|
| 244 | + $this->bStatusMessages = false; |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + /** |
|
| 248 | + * Enables the wait cursor to be displayed in the browser (default behavior). |
|
| 249 | + */ |
|
| 250 | + function waitCursorOn() |
|
| 251 | + { |
|
| 252 | + $this->bWaitCursor = true; |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + /** |
|
| 256 | + * Disables the wait cursor to be displayed in the browser. |
|
| 257 | + */ |
|
| 258 | + function waitCursorOff() |
|
| 259 | + { |
|
| 260 | + $this->bWaitCursor = false; |
|
| 261 | + } |
|
| 262 | + |
|
| 263 | + /** |
|
| 264 | + * Enables xajax to exit immediately after processing a request and |
|
| 265 | + * sending the response back to the browser (default behavior). |
|
| 266 | + */ |
|
| 267 | + function exitAllowedOn() |
|
| 268 | + { |
|
| 269 | + $this->bExitAllowed = true; |
|
| 270 | + } |
|
| 271 | + |
|
| 272 | + /** |
|
| 273 | + * Disables xajax's default behavior of exiting immediately after |
|
| 274 | + * processing a request and sending the response back to the browser. |
|
| 275 | + */ |
|
| 276 | + function exitAllowedOff() |
|
| 277 | + { |
|
| 278 | + $this->bExitAllowed = false; |
|
| 279 | + } |
|
| 280 | + |
|
| 281 | + /** |
|
| 282 | + * Turns on xajax's error handling system so that PHP errors that occur |
|
| 283 | + * during a request are trapped and pushed to the browser in the form of |
|
| 284 | + * a Javascript alert. |
|
| 285 | + */ |
|
| 286 | + function errorHandlerOn() |
|
| 287 | + { |
|
| 288 | + $this->bErrorHandler = true; |
|
| 289 | + } |
|
| 290 | + |
|
| 291 | + /** |
|
| 292 | + * Turns off xajax's error handling system (default behavior). |
|
| 293 | + */ |
|
| 294 | + function errorHandlerOff() |
|
| 295 | + { |
|
| 296 | + $this->bErrorHandler = false; |
|
| 297 | + } |
|
| 298 | + |
|
| 299 | + /** |
|
| 300 | + * Specifies a log file that will be written to by xajax during a request |
|
| 301 | + * (used only by the error handling system at present). If you don't invoke |
|
| 302 | + * this method, or you pass in "", then no log file will be written to. |
|
| 303 | + * <i>Usage:</i> <kbd>$xajax->setLogFile("/xajax_logs/errors.log");</kbd> |
|
| 304 | + */ |
|
| 305 | + function setLogFile($sFilename) |
|
| 306 | + { |
|
| 307 | + $this->sLogFile = $sFilename; |
|
| 308 | + } |
|
| 309 | + |
|
| 310 | + /** |
|
| 311 | + * Causes xajax to clean out all output buffers before outputting a |
|
| 312 | + * response (default behavior). |
|
| 313 | + */ |
|
| 314 | + function cleanBufferOn() |
|
| 315 | + { |
|
| 316 | + $this->bCleanBuffer = true; |
|
| 317 | + } |
|
| 318 | + /** |
|
| 319 | + * Turns off xajax's output buffer cleaning. |
|
| 320 | + */ |
|
| 321 | + function cleanBufferOff() |
|
| 322 | + { |
|
| 323 | + $this->bCleanBuffer = false; |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + /** |
|
| 327 | + * Sets the character encoding for the HTTP output based on |
|
| 328 | + * <kbd>$sEncoding</kbd>, which is a string containing the character |
|
| 329 | + * encoding to use. You don't need to use this method normally, since the |
|
| 330 | + * character encoding for the response gets set automatically based on the |
|
| 331 | + * <kbd>XAJAX_DEFAULT_CHAR_ENCODING</kbd> constant. |
|
| 332 | + * <i>Usage:</i> <kbd>$xajax->setCharEncoding("utf-8");</kbd> |
|
| 333 | + * |
|
| 334 | + * @param string the encoding type to use (utf-8, iso-8859-1, etc.) |
|
| 335 | + */ |
|
| 336 | + function setCharEncoding($sEncoding) |
|
| 337 | + { |
|
| 338 | + $this->sEncoding = $sEncoding; |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + /** |
|
| 342 | + * Causes xajax to decode the input request args from UTF-8 to the current |
|
| 343 | + * encoding if possible. Either the iconv or mb_string extension must be |
|
| 344 | + * present for optimal functionality. |
|
| 345 | + */ |
|
| 346 | + function decodeUTF8InputOn() |
|
| 347 | + { |
|
| 348 | + $this->bDecodeUTF8Input = true; |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + /** |
|
| 352 | + * Turns off decoding the input request args from UTF-8 (default behavior). |
|
| 353 | + */ |
|
| 354 | + function decodeUTF8InputOff() |
|
| 355 | + { |
|
| 356 | + $this->bDecodeUTF8Input = false; |
|
| 357 | + } |
|
| 358 | + |
|
| 359 | + /** |
|
| 360 | + * Tells the response object to convert special characters to HTML entities |
|
| 361 | + * automatically (only works if the mb_string extension is available). |
|
| 362 | + */ |
|
| 363 | + function outputEntitiesOn() |
|
| 364 | + { |
|
| 365 | + $this->bOutputEntities = true; |
|
| 366 | + } |
|
| 367 | + |
|
| 368 | + /** |
|
| 369 | + * Tells the response object to output special characters intact. (default |
|
| 370 | + * behavior). |
|
| 371 | + */ |
|
| 372 | + function outputEntitiesOff() |
|
| 373 | + { |
|
| 374 | + $this->bOutputEntities = false; |
|
| 375 | + } |
|
| 376 | + |
|
| 377 | + /** |
|
| 378 | + * Registers a PHP function or method to be callable through xajax in your |
|
| 379 | + * Javascript. If you want to register a function, pass in the name of that |
|
| 380 | + * function. If you want to register a static class method, pass in an |
|
| 381 | + * array like so: |
|
| 382 | + * <kbd>array("myFunctionName", "myClass", "myMethod")</kbd> |
|
| 383 | + * For an object instance method, use an object variable for the second |
|
| 384 | + * array element (and in PHP 4 make sure you put an & before the variable |
|
| 385 | + * to pass the object by reference). Note: the function name is what you |
|
| 386 | + * call via Javascript, so it can be anything as long as it doesn't |
|
| 387 | + * conflict with any other registered function name. |
|
| 388 | + * |
|
| 389 | + * <i>Usage:</i> <kbd>$xajax->registerFunction("myFunction");</kbd> |
|
| 390 | + * or: <kbd>$xajax->registerFunction(array("myFunctionName", &$myObject, "myMethod"));</kbd> |
|
| 391 | + * |
|
| 392 | + * @param mixed contains the function name or an object callback array |
|
| 393 | + * @param mixed request type (XAJAX_GET/XAJAX_POST) that should be used |
|
| 394 | + * for this function. Defaults to XAJAX_POST. |
|
| 395 | + */ |
|
| 396 | + function registerFunction($mFunction,$sRequestType=XAJAX_POST) |
|
| 397 | + { |
|
| 398 | + if (is_array($mFunction)) { |
|
| 399 | + $this->aFunctions[$mFunction[0]] = 1; |
|
| 400 | + $this->aFunctionRequestTypes[$mFunction[0]] = $sRequestType; |
|
| 401 | + $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1); |
|
| 402 | + } |
|
| 403 | + else { |
|
| 404 | + $this->aFunctions[$mFunction] = 1; |
|
| 405 | + $this->aFunctionRequestTypes[$mFunction] = $sRequestType; |
|
| 406 | + } |
|
| 407 | + } |
|
| 408 | + |
|
| 409 | + /** |
|
| 410 | + * Registers a PHP function to be callable through xajax which is located |
|
| 411 | + * in some other file. If the function is requested the external file will |
|
| 412 | + * be included to define the function before the function is called. |
|
| 413 | + * |
|
| 414 | + * <i>Usage:</i> <kbd>$xajax->registerExternalFunction("myFunction","myFunction.inc.php",XAJAX_POST);</kbd> |
|
| 415 | + * |
|
| 416 | + * @param string contains the function name or an object callback array |
|
| 417 | + * ({@link xajax::registerFunction() see registerFunction} for |
|
| 418 | + * more info on object callback arrays) |
|
| 419 | + * @param string contains the path and filename of the include file |
|
| 420 | + * @param mixed the RequestType (XAJAX_GET/XAJAX_POST) that should be used |
|
| 421 | + * for this function. Defaults to XAJAX_POST. |
|
| 422 | + */ |
|
| 423 | + function registerExternalFunction($mFunction,$sIncludeFile,$sRequestType=XAJAX_POST) |
|
| 424 | + { |
|
| 425 | + $this->registerFunction($mFunction, $sRequestType); |
|
| 426 | + |
|
| 427 | + if (is_array($mFunction)) { |
|
| 428 | + $this->aFunctionIncludeFiles[$mFunction[0]] = $sIncludeFile; |
|
| 429 | + } |
|
| 430 | + else { |
|
| 431 | + $this->aFunctionIncludeFiles[$mFunction] = $sIncludeFile; |
|
| 432 | + } |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + /** |
|
| 436 | + * Registers a PHP function to be called when xajax cannot find the |
|
| 437 | + * function being called via Javascript. Because this is technically |
|
| 438 | + * impossible when using "wrapped" functions, the catch-all feature is |
|
| 439 | + * only useful when you're directly using the xajax.call() Javascript |
|
| 440 | + * method. Use the catch-all feature when you want more dynamic ability to |
|
| 441 | + * intercept unknown calls and handle them in a custom way. |
|
| 442 | + * |
|
| 443 | + * <i>Usage:</i> <kbd>$xajax->registerCatchAllFunction("myCatchAllFunction");</kbd> |
|
| 444 | + * |
|
| 445 | + * @param string contains the function name or an object callback array |
|
| 446 | + * ({@link xajax::registerFunction() see registerFunction} for |
|
| 447 | + * more info on object callback arrays) |
|
| 448 | + */ |
|
| 449 | + function registerCatchAllFunction($mFunction) |
|
| 450 | + { |
|
| 451 | + if (is_array($mFunction)) { |
|
| 452 | + $this->sCatchAllFunction = $mFunction[0]; |
|
| 453 | + $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1); |
|
| 454 | + } |
|
| 455 | + else { |
|
| 456 | + $this->sCatchAllFunction = $mFunction; |
|
| 457 | + } |
|
| 458 | + } |
|
| 459 | + |
|
| 460 | + /** |
|
| 461 | + * Registers a PHP function to be called before xajax calls the requested |
|
| 462 | + * function. xajax will automatically add the request function's response |
|
| 463 | + * to the pre-function's response to create a single response. Another |
|
| 464 | + * feature is the ability to return not just a response, but an array with |
|
| 465 | + * the first element being false (a boolean) and the second being the |
|
| 466 | + * response. In this case, the pre-function's response will be returned to |
|
| 467 | + * the browser without xajax calling the requested function. |
|
| 468 | + * |
|
| 469 | + * <i>Usage:</i> <kbd>$xajax->registerPreFunction("myPreFunction");</kbd> |
|
| 470 | + * |
|
| 471 | + * @param string contains the function name or an object callback array |
|
| 472 | + * ({@link xajax::registerFunction() see registerFunction} for |
|
| 473 | + * more info on object callback arrays) |
|
| 474 | + */ |
|
| 475 | + function registerPreFunction($mFunction) |
|
| 476 | + { |
|
| 477 | + if (is_array($mFunction)) { |
|
| 478 | + $this->sPreFunction = $mFunction[0]; |
|
| 479 | + $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1); |
|
| 480 | + } |
|
| 481 | + else { |
|
| 482 | + $this->sPreFunction = $mFunction; |
|
| 483 | + } |
|
| 484 | + } |
|
| 485 | + |
|
| 486 | + /** |
|
| 487 | + * Returns true if xajax can process the request, false if otherwise. |
|
| 488 | + * You can use this to determine if xajax needs to process the request or |
|
| 489 | + * not. |
|
| 490 | + * |
|
| 491 | + * @return boolean |
|
| 492 | + */ |
|
| 493 | + function canProcessRequests() |
|
| 494 | + { |
|
| 495 | + if ($this->getRequestMode() != -1) return true; |
|
| 496 | + return false; |
|
| 497 | + } |
|
| 498 | + |
|
| 499 | + /** |
|
| 500 | + * Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if |
|
| 501 | + * there is none. |
|
| 502 | + * |
|
| 503 | + * @return mixed |
|
| 504 | + */ |
|
| 505 | + function getRequestMode() |
|
| 506 | + { |
|
| 507 | + if (!empty($_GET["xajax"])) |
|
| 508 | + return XAJAX_GET; |
|
| 509 | + |
|
| 510 | + if (!empty($_POST["xajax"])) |
|
| 511 | + return XAJAX_POST; |
|
| 512 | + |
|
| 513 | + return -1; |
|
| 514 | + } |
|
| 515 | + |
|
| 516 | + /** |
|
| 517 | + * This is the main communications engine of xajax. The engine handles all |
|
| 518 | + * incoming xajax requests, calls the apporiate PHP functions (or |
|
| 519 | + * class/object methods) and passes the XML responses back to the |
|
| 520 | + * Javascript response handler. If your RequestURI is the same as your Web |
|
| 521 | + * page then this function should be called before any headers or HTML has |
|
| 522 | + * been sent. |
|
| 523 | + */ |
|
| 524 | + function processRequests() |
|
| 525 | + { |
|
| 526 | + |
|
| 527 | + $requestMode = -1; |
|
| 528 | + $sFunctionName = ""; |
|
| 529 | + $bFoundFunction = true; |
|
| 530 | + $bFunctionIsCatchAll = false; |
|
| 531 | + $sFunctionNameForSpecial = ""; |
|
| 532 | + $aArgs = array(); |
|
| 533 | + $sPreResponse = ""; |
|
| 534 | + $bEndRequest = false; |
|
| 535 | + $sResponse = ""; |
|
| 536 | + |
|
| 537 | + $requestMode = $this->getRequestMode(); |
|
| 538 | + if ($requestMode == -1) return; |
|
| 539 | + |
|
| 540 | + if ($requestMode == XAJAX_POST) |
|
| 541 | + { |
|
| 542 | + $sFunctionName = $_POST["xajax"]; |
|
| 543 | + |
|
| 544 | + if (!empty($_POST["xajaxargs"])) |
|
| 545 | + $aArgs = $_POST["xajaxargs"]; |
|
| 546 | + } |
|
| 547 | + else |
|
| 548 | + { |
|
| 549 | + header ("Expires: Mon, 26 Jul 1997 05:00:00 GMT"); |
|
| 550 | + header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT"); |
|
| 551 | + header ("Cache-Control: no-cache, must-revalidate"); |
|
| 552 | + header ("Pragma: no-cache"); |
|
| 553 | + |
|
| 554 | + $sFunctionName = $_GET["xajax"]; |
|
| 555 | + |
|
| 556 | + if (!empty($_GET["xajaxargs"])) |
|
| 557 | + $aArgs = $_GET["xajaxargs"]; |
|
| 558 | + } |
|
| 559 | + |
|
| 560 | + // Use xajax error handler if necessary |
|
| 561 | + if ($this->bErrorHandler) { |
|
| 562 | + $GLOBALS['xajaxErrorHandlerText'] = ""; |
|
| 563 | + set_error_handler("xajaxErrorHandler"); |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + if ($this->sPreFunction) { |
|
| 567 | + if (!$this->_isFunctionCallable($this->sPreFunction)) { |
|
| 568 | + $bFoundFunction = false; |
|
| 569 | + $objResponse = new xajaxResponse(); |
|
| 570 | + $objResponse->addAlert("Unknown Pre-Function ". $this->sPreFunction); |
|
| 571 | + $sResponse = $objResponse->getXML(); |
|
| 572 | + } |
|
| 573 | + } |
|
| 574 | + //include any external dependencies associated with this function name |
|
| 575 | + if (array_key_exists($sFunctionName,$this->aFunctionIncludeFiles)) |
|
| 576 | + { |
|
| 577 | + ob_start(); |
|
| 578 | + include_once($this->aFunctionIncludeFiles[$sFunctionName]); |
|
| 579 | + ob_end_clean(); |
|
| 580 | + } |
|
| 581 | + |
|
| 582 | + if ($bFoundFunction) { |
|
| 583 | + $sFunctionNameForSpecial = $sFunctionName; |
|
| 584 | + if (!array_key_exists($sFunctionName, $this->aFunctions)) |
|
| 585 | + { |
|
| 586 | + if ($this->sCatchAllFunction) { |
|
| 587 | + $sFunctionName = $this->sCatchAllFunction; |
|
| 588 | + $bFunctionIsCatchAll = true; |
|
| 589 | + } |
|
| 590 | + else { |
|
| 591 | + $bFoundFunction = false; |
|
| 592 | + $objResponse = new xajaxResponse(); |
|
| 593 | + $objResponse->addAlert("Unknown Function $sFunctionName."); |
|
| 594 | + $sResponse = $objResponse->getXML(); |
|
| 595 | + } |
|
| 596 | + } |
|
| 597 | + else if ($this->aFunctionRequestTypes[$sFunctionName] != $requestMode) |
|
| 598 | + { |
|
| 599 | + $bFoundFunction = false; |
|
| 600 | + $objResponse = new xajaxResponse(); |
|
| 601 | + $objResponse->addAlert("Incorrect Request Type."); |
|
| 602 | + $sResponse = $objResponse->getXML(); |
|
| 603 | + } |
|
| 604 | + } |
|
| 605 | + |
|
| 606 | + if ($bFoundFunction) |
|
| 607 | + { |
|
| 608 | + for ($i = 0; $i < sizeof($aArgs); $i++) |
|
| 609 | + { |
|
| 610 | + // If magic quotes is on, then we need to strip the slashes from the args |
|
| 611 | + if (get_magic_quotes_gpc() == 1 && is_string($aArgs[$i])) { |
|
| 612 | + |
|
| 613 | + $aArgs[$i] = stripslashes($aArgs[$i]); |
|
| 614 | + } |
|
| 615 | + if (stristr($aArgs[$i],"<xjxobj>") != false) |
|
| 616 | + { |
|
| 617 | + $aArgs[$i] = $this->_xmlToArray("xjxobj",$aArgs[$i]); |
|
| 618 | + } |
|
| 619 | + else if (stristr($aArgs[$i],"<xjxquery>") != false) |
|
| 620 | + { |
|
| 621 | + $aArgs[$i] = $this->_xmlToArray("xjxquery",$aArgs[$i]); |
|
| 622 | + } |
|
| 623 | + else if ($this->bDecodeUTF8Input) |
|
| 624 | + { |
|
| 625 | + $aArgs[$i] = $this->_decodeUTF8Data($aArgs[$i]); |
|
| 626 | + } |
|
| 627 | + } |
|
| 628 | + |
|
| 629 | + if ($this->sPreFunction) { |
|
| 630 | + $mPreResponse = $this->_callFunction($this->sPreFunction, array($sFunctionNameForSpecial, $aArgs)); |
|
| 631 | + if (is_array($mPreResponse) && $mPreResponse[0] === false) { |
|
| 632 | + $bEndRequest = true; |
|
| 633 | + $sPreResponse = $mPreResponse[1]; |
|
| 634 | + } |
|
| 635 | + else { |
|
| 636 | + $sPreResponse = $mPreResponse; |
|
| 637 | + } |
|
| 638 | + if (is_a($sPreResponse, "xajaxResponse")) { |
|
| 639 | + $sPreResponse = $sPreResponse->getXML(); |
|
| 640 | + } |
|
| 641 | + if ($bEndRequest) $sResponse = $sPreResponse; |
|
| 642 | + } |
|
| 643 | + |
|
| 644 | + if (!$bEndRequest) { |
|
| 645 | + if (!$this->_isFunctionCallable($sFunctionName)) { |
|
| 646 | + $objResponse = new xajaxResponse(); |
|
| 647 | + $objResponse->addAlert("The Registered Function $sFunctionName Could Not Be Found."); |
|
| 648 | + $sResponse = $objResponse->getXML(); |
|
| 649 | + } |
|
| 650 | + else { |
|
| 651 | + if ($bFunctionIsCatchAll) { |
|
| 652 | + $aArgs = array($sFunctionNameForSpecial, $aArgs); |
|
| 653 | + } |
|
| 654 | + $sResponse = $this->_callFunction($sFunctionName, $aArgs); |
|
| 655 | + } |
|
| 656 | + if (is_a($sResponse, "xajaxResponse")) { |
|
| 657 | + $sResponse = $sResponse->getXML(); |
|
| 658 | + } |
|
| 659 | + if (!is_string($sResponse) || strpos($sResponse, "<xjx>") === FALSE) { |
|
| 660 | + $objResponse = new xajaxResponse(); |
|
| 661 | + $objResponse->addAlert("No XML Response Was Returned By Function $sFunctionName."); |
|
| 662 | + $sResponse = $objResponse->getXML(); |
|
| 663 | + } |
|
| 664 | + else if ($sPreResponse != "") { |
|
| 665 | + $sNewResponse = new xajaxResponse($this->sEncoding, $this->bOutputEntities); |
|
| 666 | + $sNewResponse->loadXML($sPreResponse); |
|
| 667 | + $sNewResponse->loadXML($sResponse); |
|
| 668 | + $sResponse = $sNewResponse->getXML(); |
|
| 669 | + } |
|
| 670 | + } |
|
| 671 | + } |
|
| 672 | + |
|
| 673 | + $sContentHeader = "Content-type: text/xml;"; |
|
| 674 | + if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0) |
|
| 675 | + $sContentHeader .= " charset=".$this->sEncoding; |
|
| 676 | + header($sContentHeader); |
|
| 677 | + if ($this->bErrorHandler && !empty( $GLOBALS['xajaxErrorHandlerText'] )) { |
|
| 678 | + $sErrorResponse = new xajaxResponse(); |
|
| 679 | + $sErrorResponse->addAlert("** PHP Error Messages: **" . $GLOBALS['xajaxErrorHandlerText']); |
|
| 680 | + if ($this->sLogFile) { |
|
| 681 | + $fH = @fopen($this->sLogFile, "a"); |
|
| 682 | + if (!$fH) { |
|
| 683 | + $sErrorResponse->addAlert("** Logging Error **\n\nxajax was unable to write to the error log file:\n" . $this->sLogFile); |
|
| 684 | + } |
|
| 685 | + else { |
|
| 686 | + fwrite($fH, "** xajax Error Log - " . strftime("%b %e %Y %I:%M:%S %p") . " **" . $GLOBALS['xajaxErrorHandlerText'] . "\n\n\n"); |
|
| 687 | + fclose($fH); |
|
| 688 | + } |
|
| 689 | + } |
|
| 690 | + |
|
| 691 | + $sErrorResponse->loadXML($sResponse); |
|
| 692 | + $sResponse = $sErrorResponse->getXML(); |
|
| 693 | + |
|
| 694 | + } |
|
| 695 | + if ($this->bCleanBuffer) while (@ob_end_clean()); |
|
| 696 | + print $sResponse; |
|
| 697 | + if ($this->bErrorHandler) restore_error_handler(); |
|
| 698 | + |
|
| 699 | + if ($this->bExitAllowed) |
|
| 700 | + exit(); |
|
| 701 | + } |
|
| 702 | + |
|
| 703 | + /** |
|
| 704 | + * Prints the xajax Javascript header and wrapper code into your page by |
|
| 705 | + * printing the output of the getJavascript() method. It should only be |
|
| 706 | + * called between the <pre><head> </head></pre> tags in your HTML page. |
|
| 707 | + * Remember, if you only want to obtain the result of this function, use |
|
| 708 | + * {@link xajax::getJavascript()} instead. |
|
| 709 | + * |
|
| 710 | + * <i>Usage:</i> |
|
| 711 | + * <code> |
|
| 712 | + * <head> |
|
| 713 | + * ... |
|
| 714 | + * < ?php $xajax->printJavascript(); ? > |
|
| 715 | + * </code> |
|
| 716 | + * |
|
| 717 | + * @param string the relative address of the folder where xajax has been |
|
| 718 | + * installed. For instance, if your PHP file is |
|
| 719 | + * "http://www.myserver.com/myfolder/mypage.php" |
|
| 720 | + * and xajax was installed in |
|
| 721 | + * "http://www.myserver.com/anotherfolder", then $sJsURI |
|
| 722 | + * should be set to "../anotherfolder". Defaults to assuming |
|
| 723 | + * xajax is in the same folder as your PHP file. |
|
| 724 | + * @param string the relative folder/file pair of the xajax Javascript |
|
| 725 | + * engine located within the xajax installation folder. |
|
| 726 | + * Defaults to xajax_js/xajax.js. |
|
| 727 | + */ |
|
| 728 | + function printJavascript($sJsURI="", $sJsFile=NULL) |
|
| 729 | + { |
|
| 730 | + print $this->getJavascript($sJsURI, $sJsFile); |
|
| 731 | + } |
|
| 732 | + |
|
| 733 | + /** |
|
| 734 | + * Returns the xajax Javascript code that should be added to your HTML page |
|
| 735 | + * between the <kbd><head> </head></kbd> tags. |
|
| 736 | + * |
|
| 737 | + * <i>Usage:</i> |
|
| 738 | + * <code> |
|
| 739 | + * < ?php $xajaxJSHead = $xajax->getJavascript(); ? > |
|
| 740 | + * <head> |
|
| 741 | + * ... |
|
| 742 | + * < ?php echo $xajaxJSHead; ? > |
|
| 743 | + * </code> |
|
| 744 | + * |
|
| 745 | + * @param string the relative address of the folder where xajax has been |
|
| 746 | + * installed. For instance, if your PHP file is |
|
| 747 | + * "http://www.myserver.com/myfolder/mypage.php" |
|
| 748 | + * and xajax was installed in |
|
| 749 | + * "http://www.myserver.com/anotherfolder", then $sJsURI |
|
| 750 | + * should be set to "../anotherfolder". Defaults to assuming |
|
| 751 | + * xajax is in the same folder as your PHP file. |
|
| 752 | + * @param string the relative folder/file pair of the xajax Javascript |
|
| 753 | + * engine located within the xajax installation folder. |
|
| 754 | + * Defaults to xajax_js/xajax.js. |
|
| 755 | + * @return string |
|
| 756 | + */ |
|
| 757 | + function getJavascript($sJsURI="", $sJsFile=NULL) |
|
| 758 | + { |
|
| 759 | + $html = $this->getJavascriptConfig(); |
|
| 760 | + $html .= $this->getJavascriptInclude($sJsURI, $sJsFile); |
|
| 761 | + |
|
| 762 | + return $html; |
|
| 763 | + } |
|
| 764 | + |
|
| 765 | + /** |
|
| 766 | + * Returns a string containing inline Javascript that sets up the xajax |
|
| 767 | + * runtime (typically called internally by xajax from get/printJavascript). |
|
| 768 | + * |
|
| 769 | + * @return string |
|
| 770 | + */ |
|
| 771 | + function getJavascriptConfig() |
|
| 772 | + { |
|
| 773 | + $html = "\t<script type=\"text/javascript\">\n"; |
|
| 774 | + $html .= "var xajaxRequestUri=\"".$this->sRequestURI."\";\n"; |
|
| 775 | + $html .= "var xajaxDebug=".($this->bDebug?"true":"false").";\n"; |
|
| 776 | + $html .= "var xajaxStatusMessages=".($this->bStatusMessages?"true":"false").";\n"; |
|
| 777 | + $html .= "var xajaxWaitCursor=".($this->bWaitCursor?"true":"false").";\n"; |
|
| 778 | + $html .= "var xajaxDefinedGet=".XAJAX_GET.";\n"; |
|
| 779 | + $html .= "var xajaxDefinedPost=".XAJAX_POST.";\n"; |
|
| 780 | + $html .= "var xajaxLoaded=false;\n"; |
|
| 781 | + |
|
| 782 | + foreach($this->aFunctions as $sFunction => $bExists) { |
|
| 783 | + $html .= $this->_wrap($sFunction,$this->aFunctionRequestTypes[$sFunction]); |
|
| 784 | + } |
|
| 785 | + |
|
| 786 | + $html .= "\t</script>\n"; |
|
| 787 | + return $html; |
|
| 788 | + } |
|
| 789 | + |
|
| 790 | + /** |
|
| 791 | + * Returns a string containing a Javascript include of the xajax.js file |
|
| 792 | + * along with a check to see if the file loaded after six seconds |
|
| 793 | + * (typically called internally by xajax from get/printJavascript). |
|
| 794 | + * |
|
| 795 | + * @param string the relative address of the folder where xajax has been |
|
| 796 | + * installed. For instance, if your PHP file is |
|
| 797 | + * "http://www.myserver.com/myfolder/mypage.php" |
|
| 798 | + * and xajax was installed in |
|
| 799 | + * "http://www.myserver.com/anotherfolder", then $sJsURI |
|
| 800 | + * should be set to "../anotherfolder". Defaults to assuming |
|
| 801 | + * xajax is in the same folder as your PHP file. |
|
| 802 | + * @param string the relative folder/file pair of the xajax Javascript |
|
| 803 | + * engine located within the xajax installation folder. |
|
| 804 | + * Defaults to xajax_js/xajax.js. |
|
| 805 | + * @return string |
|
| 806 | + */ |
|
| 807 | + function getJavascriptInclude($sJsURI="", $sJsFile=NULL) |
|
| 808 | + { |
|
| 809 | + if ($sJsFile == NULL) $sJsFile = "xajax_js/xajax.js"; |
|
| 810 | + |
|
| 811 | + if ($sJsURI != "" && substr($sJsURI, -1) != "/") $sJsURI .= "/"; |
|
| 812 | + |
|
| 813 | + $html = "\t<script type=\"text/javascript\" src=\"" . $sJsURI . $sJsFile . "\"></script>\n"; |
|
| 814 | + $html .= "\t<script type=\"text/javascript\">\n"; |
|
| 815 | + $html .= "window.setTimeout(function () { if (!xajaxLoaded) { alert('Error: the xajax Javascript file could not be included. Perhaps the URL is incorrect?\\nURL: {$sJsURI}{$sJsFile}'); } }, 6000);\n"; |
|
| 816 | + $html .= "\t</script>\n"; |
|
| 817 | + return $html; |
|
| 818 | + } |
|
| 819 | + |
|
| 820 | + /** |
|
| 821 | + * This method can be used to create a new xajax.js file out of the |
|
| 822 | + * xajax_uncompressed.js file (which will only happen if xajax.js doesn't |
|
| 823 | + * already exist on the filesystem). |
|
| 824 | + * |
|
| 825 | + * @param string an optional argument containing the full server file path |
|
| 826 | + * of xajax.js. |
|
| 827 | + */ |
|
| 828 | + function autoCompressJavascript($sJsFullFilename=NULL) |
|
| 829 | + { |
|
| 830 | + $sJsFile = "xajax_js/xajax.js"; |
|
| 831 | + |
|
| 832 | + if ($sJsFullFilename) { |
|
| 833 | + $realJsFile = $sJsFullFilename; |
|
| 834 | + } |
|
| 835 | + else { |
|
| 836 | + $realPath = realpath(dirname(__FILE__)); |
|
| 837 | + $realJsFile = $realPath . "/". $sJsFile; |
|
| 838 | + } |
|
| 839 | + |
|
| 840 | + // Create a compressed file if necessary |
|
| 841 | + if (!file_exists($realJsFile)) { |
|
| 842 | + $srcFile = str_replace(".js", "_uncompressed.js", $realJsFile); |
|
| 843 | + if (!file_exists($srcFile)) { |
|
| 844 | + trigger_error("The xajax uncompressed Javascript file could not be found in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR); |
|
| 845 | + } |
|
| 846 | + require(dirname(__FILE__)."/xajaxCompress.php"); |
|
| 847 | + $javaScript = implode('', file($srcFile)); |
|
| 848 | + $compressedScript = xajaxCompressJavascript($javaScript); |
|
| 849 | + $fH = @fopen($realJsFile, "w"); |
|
| 850 | + if (!$fH) { |
|
| 851 | + trigger_error("The xajax compressed javascript file could not be written in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR); |
|
| 852 | + } |
|
| 853 | + else { |
|
| 854 | + fwrite($fH, $compressedScript); |
|
| 855 | + fclose($fH); |
|
| 856 | + } |
|
| 857 | + } |
|
| 858 | + } |
|
| 859 | + |
|
| 860 | + /** |
|
| 861 | + * Returns the current URL based upon the SERVER vars. |
|
| 862 | + * |
|
| 863 | + * @access private |
|
| 864 | + * @return string |
|
| 865 | + */ |
|
| 866 | + function _detectURI() { |
|
| 867 | + $aURL = array(); |
|
| 868 | + |
|
| 869 | + // Try to get the request URL |
|
| 870 | + if (!empty($_SERVER['REQUEST_URI'])) { |
|
| 871 | + $aURL = parse_url($_SERVER['REQUEST_URI']); |
|
| 872 | + } |
|
| 873 | + |
|
| 874 | + // Fill in the empty values |
|
| 875 | + if (empty($aURL['scheme'])) { |
|
| 876 | + if (!empty($_SERVER['HTTP_SCHEME'])) { |
|
| 877 | + $aURL['scheme'] = $_SERVER['HTTP_SCHEME']; |
|
| 878 | + } else { |
|
| 879 | + $aURL['scheme'] = (!empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off') ? 'https' : 'http'; |
|
| 880 | + } |
|
| 881 | + } |
|
| 882 | + |
|
| 883 | + if (empty($aURL['host'])) { |
|
| 884 | + if (!empty($_SERVER['HTTP_HOST'])) { |
|
| 885 | + if (strpos($_SERVER['HTTP_HOST'], ':') > 0) { |
|
| 886 | + list($aURL['host'], $aURL['port']) = explode(':', $_SERVER['HTTP_HOST']); |
|
| 887 | + } else { |
|
| 888 | + $aURL['host'] = $_SERVER['HTTP_HOST']; |
|
| 889 | + } |
|
| 890 | + } else if (!empty($_SERVER['SERVER_NAME'])) { |
|
| 891 | + $aURL['host'] = $_SERVER['SERVER_NAME']; |
|
| 892 | + } else { |
|
| 893 | + print "xajax Error: xajax failed to automatically identify your Request URI."; |
|
| 894 | + print "Please set the Request URI explicitly when you instantiate the xajax object."; |
|
| 895 | + exit(); |
|
| 896 | + } |
|
| 897 | + } |
|
| 898 | + |
|
| 899 | + if (empty($aURL['port']) && !empty($_SERVER['SERVER_PORT'])) { |
|
| 900 | + $aURL['port'] = $_SERVER['SERVER_PORT']; |
|
| 901 | + } |
|
| 902 | + |
|
| 903 | + if (empty($aURL['path'])) { |
|
| 904 | + if (!empty($_SERVER['PATH_INFO'])) { |
|
| 905 | + $sPath = parse_url($_SERVER['PATH_INFO']); |
|
| 906 | + } else { |
|
| 907 | + $sPath = parse_url(api_get_self()); |
|
| 908 | + } |
|
| 909 | + $aURL['path'] = $sPath['path']; |
|
| 910 | + unset($sPath); |
|
| 911 | + } |
|
| 912 | + |
|
| 913 | + if (!empty($aURL['query'])) { |
|
| 914 | + $aURL['query'] = '?'.$aURL['query']; |
|
| 915 | + } |
|
| 916 | + |
|
| 917 | + // Build the URL: Start with scheme, user and pass |
|
| 918 | + $sURL = $aURL['scheme'].'://'; |
|
| 919 | + if (!empty($aURL['user'])) { |
|
| 920 | + $sURL.= $aURL['user']; |
|
| 921 | + if (!empty($aURL['pass'])) { |
|
| 922 | + $sURL.= ':'.$aURL['pass']; |
|
| 923 | + } |
|
| 924 | + $sURL.= '@'; |
|
| 925 | + } |
|
| 926 | + |
|
| 927 | + // Add the host |
|
| 928 | + $sURL.= $aURL['host']; |
|
| 929 | + |
|
| 930 | + // Add the port if needed |
|
| 931 | + if (!empty($aURL['port']) && (($aURL['scheme'] == 'http' && $aURL['port'] != 80) || ($aURL['scheme'] == 'https' && $aURL['port'] != 443))) { |
|
| 932 | + $sURL.= ':'.$aURL['port']; |
|
| 933 | + } |
|
| 934 | + |
|
| 935 | + // Add the path and the query string |
|
| 936 | + $sURL.= $aURL['path'].@$aURL['query']; |
|
| 937 | + |
|
| 938 | + // Clean up |
|
| 939 | + unset($aURL); |
|
| 940 | + return $sURL; |
|
| 941 | + } |
|
| 942 | + |
|
| 943 | + /** |
|
| 944 | + * Returns true if the function name is associated with an object callback, |
|
| 945 | + * false if not. |
|
| 946 | + * |
|
| 947 | + * @param string the name of the function |
|
| 948 | + * @access private |
|
| 949 | + * @return boolean |
|
| 950 | + */ |
|
| 951 | + function _isObjectCallback($sFunction) |
|
| 952 | + { |
|
| 953 | + if (array_key_exists($sFunction, $this->aObjects)) return true; |
|
| 954 | + return false; |
|
| 955 | + } |
|
| 956 | + |
|
| 957 | + /** |
|
| 958 | + * Returns true if the function or object callback can be called, false if |
|
| 959 | + * not. |
|
| 960 | + * |
|
| 961 | + * @param string the name of the function |
|
| 962 | + * @access private |
|
| 963 | + * @return boolean |
|
| 964 | + */ |
|
| 965 | + function _isFunctionCallable($sFunction) |
|
| 966 | + { |
|
| 967 | + if ($this->_isObjectCallback($sFunction)) { |
|
| 968 | + if (is_object($this->aObjects[$sFunction][0])) { |
|
| 969 | + return method_exists($this->aObjects[$sFunction][0], $this->aObjects[$sFunction][1]); |
|
| 970 | + } |
|
| 971 | + else { |
|
| 972 | + return is_callable($this->aObjects[$sFunction]); |
|
| 973 | + } |
|
| 974 | + } |
|
| 975 | + else { |
|
| 976 | + return function_exists($sFunction); |
|
| 977 | + } |
|
| 978 | + } |
|
| 979 | + |
|
| 980 | + /** |
|
| 981 | + * Calls the function, class method, or object method with the supplied |
|
| 982 | + * arguments. |
|
| 983 | + * |
|
| 984 | + * @param string the name of the function |
|
| 985 | + * @param array arguments to pass to the function |
|
| 986 | + * @access private |
|
| 987 | + * @return mixed the output of the called function or method |
|
| 988 | + */ |
|
| 989 | + function _callFunction($sFunction, $aArgs) |
|
| 990 | + { |
|
| 991 | + if ($this->_isObjectCallback($sFunction)) { |
|
| 992 | + $mReturn = call_user_func_array($this->aObjects[$sFunction], $aArgs); |
|
| 993 | + } |
|
| 994 | + else { |
|
| 995 | + $mReturn = call_user_func_array($sFunction, $aArgs); |
|
| 996 | + } |
|
| 997 | + return $mReturn; |
|
| 998 | + } |
|
| 999 | + |
|
| 1000 | + /** |
|
| 1001 | + * Generates the Javascript wrapper for the specified PHP function. |
|
| 1002 | + * |
|
| 1003 | + * @param string the name of the function |
|
| 1004 | + * @param mixed the request type |
|
| 1005 | + * @access private |
|
| 1006 | + * @return string |
|
| 1007 | + */ |
|
| 1008 | + function _wrap($sFunction,$sRequestType=XAJAX_POST) |
|
| 1009 | + { |
|
| 1010 | + $js = "function ".$this->sWrapperPrefix."$sFunction(){return xajax.call(\"$sFunction\", arguments, ".$sRequestType.");}\n"; |
|
| 1011 | + return $js; |
|
| 1012 | + } |
|
| 1013 | + |
|
| 1014 | + /** |
|
| 1015 | + * Takes a string containing xajax xjxobj XML or xjxquery XML and builds an |
|
| 1016 | + * array representation of it to pass as an argument to the PHP function |
|
| 1017 | + * being called. |
|
| 1018 | + * |
|
| 1019 | + * @param string the root tag of the XML |
|
| 1020 | + * @param string XML to convert |
|
| 1021 | + * @access private |
|
| 1022 | + * @return array |
|
| 1023 | + */ |
|
| 1024 | + function _xmlToArray($rootTag, $sXml) |
|
| 1025 | + { |
|
| 1026 | + $aArray = array(); |
|
| 1027 | + $sXml = str_replace("<$rootTag>","<$rootTag>|~|",$sXml); |
|
| 1028 | + $sXml = str_replace("</$rootTag>","</$rootTag>|~|",$sXml); |
|
| 1029 | + $sXml = str_replace("<e>","<e>|~|",$sXml); |
|
| 1030 | + $sXml = str_replace("</e>","</e>|~|",$sXml); |
|
| 1031 | + $sXml = str_replace("<k>","<k>|~|",$sXml); |
|
| 1032 | + $sXml = str_replace("</k>","|~|</k>|~|",$sXml); |
|
| 1033 | + $sXml = str_replace("<v>","<v>|~|",$sXml); |
|
| 1034 | + $sXml = str_replace("</v>","|~|</v>|~|",$sXml); |
|
| 1035 | + $sXml = str_replace("<q>","<q>|~|",$sXml); |
|
| 1036 | + $sXml = str_replace("</q>","|~|</q>|~|",$sXml); |
|
| 1037 | + |
|
| 1038 | + $this->aObjArray = explode("|~|",$sXml); |
|
| 1039 | + |
|
| 1040 | + $this->iPos = 0; |
|
| 1041 | + $aArray = $this->_parseObjXml($rootTag); |
|
| 1042 | + |
|
| 1043 | + return $aArray; |
|
| 1044 | + } |
|
| 1045 | + |
|
| 1046 | + /** |
|
| 1047 | + * A recursive function that generates an array from the contents of |
|
| 1048 | + * $this->aObjArray. |
|
| 1049 | + * |
|
| 1050 | + * @param string the root tag of the XML |
|
| 1051 | + * @access private |
|
| 1052 | + * @return array |
|
| 1053 | + */ |
|
| 1054 | + function _parseObjXml($rootTag) |
|
| 1055 | + { |
|
| 1056 | + $aArray = array(); |
|
| 1057 | + |
|
| 1058 | + if ($rootTag == "xjxobj") |
|
| 1059 | + { |
|
| 1060 | + while(!stristr($this->aObjArray[$this->iPos],"</xjxobj>")) |
|
| 1061 | + { |
|
| 1062 | + $this->iPos++; |
|
| 1063 | + if(stristr($this->aObjArray[$this->iPos],"<e>")) |
|
| 1064 | + { |
|
| 1065 | + $key = ""; |
|
| 1066 | + $value = null; |
|
| 1067 | + |
|
| 1068 | + $this->iPos++; |
|
| 1069 | + while(!stristr($this->aObjArray[$this->iPos],"</e>")) |
|
| 1070 | + { |
|
| 1071 | + if(stristr($this->aObjArray[$this->iPos],"<k>")) |
|
| 1072 | + { |
|
| 1073 | + $this->iPos++; |
|
| 1074 | + while(!stristr($this->aObjArray[$this->iPos],"</k>")) |
|
| 1075 | + { |
|
| 1076 | + $key .= $this->aObjArray[$this->iPos]; |
|
| 1077 | + $this->iPos++; |
|
| 1078 | + } |
|
| 1079 | + } |
|
| 1080 | + if(stristr($this->aObjArray[$this->iPos],"<v>")) |
|
| 1081 | + { |
|
| 1082 | + $this->iPos++; |
|
| 1083 | + while(!stristr($this->aObjArray[$this->iPos],"</v>")) |
|
| 1084 | + { |
|
| 1085 | + if(stristr($this->aObjArray[$this->iPos],"<xjxobj>")) |
|
| 1086 | + { |
|
| 1087 | + $value = $this->_parseObjXml("xjxobj"); |
|
| 1088 | + $this->iPos++; |
|
| 1089 | + } |
|
| 1090 | + else |
|
| 1091 | + { |
|
| 1092 | + $value .= $this->aObjArray[$this->iPos]; |
|
| 1093 | + if ($this->bDecodeUTF8Input) |
|
| 1094 | + { |
|
| 1095 | + $value = $this->_decodeUTF8Data($value); |
|
| 1096 | + } |
|
| 1097 | + } |
|
| 1098 | + $this->iPos++; |
|
| 1099 | + } |
|
| 1100 | + } |
|
| 1101 | + $this->iPos++; |
|
| 1102 | + } |
|
| 1103 | + |
|
| 1104 | + $aArray[$key]=$value; |
|
| 1105 | + } |
|
| 1106 | + } |
|
| 1107 | + } |
|
| 1108 | + |
|
| 1109 | + if ($rootTag == "xjxquery") |
|
| 1110 | + { |
|
| 1111 | + $sQuery = ""; |
|
| 1112 | + $this->iPos++; |
|
| 1113 | + while(!stristr($this->aObjArray[$this->iPos],"</xjxquery>")) |
|
| 1114 | + { |
|
| 1115 | + if (stristr($this->aObjArray[$this->iPos],"<q>") || stristr($this->aObjArray[$this->iPos],"</q>")) |
|
| 1116 | + { |
|
| 1117 | + $this->iPos++; |
|
| 1118 | + continue; |
|
| 1119 | + } |
|
| 1120 | + $sQuery .= $this->aObjArray[$this->iPos]; |
|
| 1121 | + $this->iPos++; |
|
| 1122 | + } |
|
| 1123 | + |
|
| 1124 | + parse_str($sQuery, $aArray); |
|
| 1125 | + if ($this->bDecodeUTF8Input) |
|
| 1126 | + { |
|
| 1127 | + foreach($aArray as $key => $value) |
|
| 1128 | + { |
|
| 1129 | + $aArray[$key] = $this->_decodeUTF8Data($value); |
|
| 1130 | + } |
|
| 1131 | + } |
|
| 1132 | + // If magic quotes is on, then we need to strip the slashes from the |
|
| 1133 | + // array values because of the parse_str pass which adds slashes |
|
| 1134 | + if (get_magic_quotes_gpc() == 1) { |
|
| 1135 | + $newArray = array(); |
|
| 1136 | + foreach ($aArray as $sKey => $sValue) { |
|
| 1137 | + if (is_string($sValue)) |
|
| 1138 | + $newArray[$sKey] = stripslashes($sValue); |
|
| 1139 | + else |
|
| 1140 | + $newArray[$sKey] = $sValue; |
|
| 1141 | + } |
|
| 1142 | + $aArray = $newArray; |
|
| 1143 | + } |
|
| 1144 | + } |
|
| 1145 | + |
|
| 1146 | + return $aArray; |
|
| 1147 | + } |
|
| 1148 | + |
|
| 1149 | + /** |
|
| 1150 | + * Decodes string data from UTF-8 to the current xajax encoding. |
|
| 1151 | + * |
|
| 1152 | + * @param string data to convert |
|
| 1153 | + * @access private |
|
| 1154 | + * @return string converted data |
|
| 1155 | + */ |
|
| 1156 | + function _decodeUTF8Data($sData) |
|
| 1157 | + { |
|
| 1158 | + $sValue = $sData; |
|
| 1159 | + if ($this->bDecodeUTF8Input) |
|
| 1160 | + { |
|
| 1161 | + $sFuncToUse = NULL; |
|
| 1162 | + |
|
| 1163 | + // An adaptation for the Dokeos LMS, 22-AUG-2009. |
|
| 1164 | + if (function_exists('api_convert_encoding')) |
|
| 1165 | + { |
|
| 1166 | + $sFuncToUse = "api_convert_encoding"; |
|
| 1167 | + } |
|
| 1168 | + //if (function_exists('iconv')) |
|
| 1169 | + elseif (function_exists('iconv')) |
|
| 1170 | + // |
|
| 1171 | + { |
|
| 1172 | + $sFuncToUse = "iconv"; |
|
| 1173 | + } |
|
| 1174 | + else if (function_exists('mb_convert_encoding')) |
|
| 1175 | + { |
|
| 1176 | + $sFuncToUse = "mb_convert_encoding"; |
|
| 1177 | + } |
|
| 1178 | + else if ($this->sEncoding == "ISO-8859-1") |
|
| 1179 | + { |
|
| 1180 | + $sFuncToUse = "utf8_decode"; |
|
| 1181 | + } |
|
| 1182 | + else |
|
| 1183 | + { |
|
| 1184 | + trigger_error("The incoming xajax data could not be converted from UTF-8", E_USER_NOTICE); |
|
| 1185 | + } |
|
| 1186 | + |
|
| 1187 | + if ($sFuncToUse) |
|
| 1188 | + { |
|
| 1189 | + if (is_string($sValue)) |
|
| 1190 | + { |
|
| 1191 | + if ($sFuncToUse == "iconv") |
|
| 1192 | + { |
|
| 1193 | + $sValue = iconv("UTF-8", $this->sEncoding.'//TRANSLIT', $sValue); |
|
| 1194 | + } |
|
| 1195 | + else if ($sFuncToUse == "mb_convert_encoding") |
|
| 1196 | + { |
|
| 1197 | + $sValue = mb_convert_encoding($sValue, $this->sEncoding, "UTF-8"); |
|
| 1198 | + } |
|
| 1199 | + // Added code, an adaptation for the Dokeos LMS, 22-AUG-2009. |
|
| 1200 | + else if ($sFuncToUse == "api_convert_encoding") |
|
| 1201 | + { |
|
| 1202 | + $sValue = api_convert_encoding($sValue, $this->sEncoding, "UTF-8"); |
|
| 1203 | + } |
|
| 1204 | + // |
|
| 1205 | + else |
|
| 1206 | + { |
|
| 1207 | + $sValue = utf8_decode($sValue); |
|
| 1208 | + } |
|
| 1209 | + } |
|
| 1210 | + } |
|
| 1211 | + } |
|
| 1212 | + return $sValue; |
|
| 1213 | + } |
|
| 1214 | 1214 | |
| 1215 | 1215 | }// end class xajax |
| 1216 | 1216 | |
@@ -1220,31 +1220,31 @@ discard block |
||
| 1220 | 1220 | */ |
| 1221 | 1221 | function xajaxErrorHandler($errno, $errstr, $errfile, $errline) |
| 1222 | 1222 | { |
| 1223 | - $errorReporting = error_reporting(); |
|
| 1224 | - if (($errno & $errorReporting) == 0) return; |
|
| 1225 | - |
|
| 1226 | - if ($errno == E_NOTICE) { |
|
| 1227 | - $errTypeStr = "NOTICE"; |
|
| 1228 | - } |
|
| 1229 | - else if ($errno == E_WARNING) { |
|
| 1230 | - $errTypeStr = "WARNING"; |
|
| 1231 | - } |
|
| 1232 | - else if ($errno == E_USER_NOTICE) { |
|
| 1233 | - $errTypeStr = "USER NOTICE"; |
|
| 1234 | - } |
|
| 1235 | - else if ($errno == E_USER_WARNING) { |
|
| 1236 | - $errTypeStr = "USER WARNING"; |
|
| 1237 | - } |
|
| 1238 | - else if ($errno == E_USER_ERROR) { |
|
| 1239 | - $errTypeStr = "USER FATAL ERROR"; |
|
| 1240 | - } |
|
| 1241 | - else if ($errno == E_STRICT) { |
|
| 1242 | - return; |
|
| 1243 | - } |
|
| 1244 | - else { |
|
| 1245 | - $errTypeStr = "UNKNOWN: $errno"; |
|
| 1246 | - } |
|
| 1247 | - $GLOBALS['xajaxErrorHandlerText'] .= "\n----\n[$errTypeStr] $errstr\nerror in line $errline of file $errfile"; |
|
| 1223 | + $errorReporting = error_reporting(); |
|
| 1224 | + if (($errno & $errorReporting) == 0) return; |
|
| 1225 | + |
|
| 1226 | + if ($errno == E_NOTICE) { |
|
| 1227 | + $errTypeStr = "NOTICE"; |
|
| 1228 | + } |
|
| 1229 | + else if ($errno == E_WARNING) { |
|
| 1230 | + $errTypeStr = "WARNING"; |
|
| 1231 | + } |
|
| 1232 | + else if ($errno == E_USER_NOTICE) { |
|
| 1233 | + $errTypeStr = "USER NOTICE"; |
|
| 1234 | + } |
|
| 1235 | + else if ($errno == E_USER_WARNING) { |
|
| 1236 | + $errTypeStr = "USER WARNING"; |
|
| 1237 | + } |
|
| 1238 | + else if ($errno == E_USER_ERROR) { |
|
| 1239 | + $errTypeStr = "USER FATAL ERROR"; |
|
| 1240 | + } |
|
| 1241 | + else if ($errno == E_STRICT) { |
|
| 1242 | + return; |
|
| 1243 | + } |
|
| 1244 | + else { |
|
| 1245 | + $errTypeStr = "UNKNOWN: $errno"; |
|
| 1246 | + } |
|
| 1247 | + $GLOBALS['xajaxErrorHandlerText'] .= "\n----\n[$errTypeStr] $errstr\nerror in line $errline of file $errfile"; |
|
| 1248 | 1248 | } |
| 1249 | 1249 | |
| 1250 | 1250 | ?> |