Location: PHPKode > projects > PhxEventManager > pem-docs/xajax/xajaxDefaultRequestProcessorPlugin.html
<html>
<head>
<title>Docs For Class xajaxDefaultRequestProcessorPlugin</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">xajax</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
        
                                                        
                              		  [ <a href="../classtrees_xajax.html" class="menu">class tree: xajax</a> ]
		  [ <a href="../elementindex_xajax.html" class="menu">index: xajax</a> ]
		  	    [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
      <b>Packages:</b><br />
              <a href="../li_default.html">default</a><br />
              <a href="../li_xajax.html">xajax</a><br />
            <br /><br />
                        <b>Files:</b><br />
      	  <div class="package">
			<a href="../xajax/_pem-includes---xajax---xajax_core---xajax.inc.php.html">		xajax.inc.php
		</a><br>
			<a href="../xajax/_pem-includes---xajax---xajax_core---plugin_layer---xajaxDefaultIncludePlugin.inc.php.html">		xajaxDefaultIncludePlugin.inc.php
		</a><br>
			<a href="../xajax/_pem-includes---xajax---xajax_core---plugin_layer---xajaxDefaultRequestProcessorPlugin.inc.php.html">		xajaxDefaultRequestProcessorPlugin.inc.php
		</a><br>
			<a href="../xajax/_pem-includes---xajax---xajax_core---plugin_layer---xajaxIncludePlugin.inc.php.html">		xajaxIncludePlugin.inc.php
		</a><br>
			<a href="../xajax/_pem-includes---xajax---xajax_core---plugin_layer---xajaxPluginManager.inc.php.html">		xajaxPluginManager.inc.php
		</a><br>
			<a href="../xajax/_pem-includes---xajax---xajax_core---plugin_layer---xajaxRequestProcessorPlugin.inc.php.html">		xajaxRequestProcessorPlugin.inc.php
		</a><br>
			<a href="../xajax/_pem-includes---xajax---xajax_core---xajaxResponse.inc.php.html">		xajaxResponse.inc.php
		</a><br>
			<a href="../xajax/_pem-includes---xajax---xajax_core---plugin_layer---xajaxResponsePlugin.inc.php.html">		xajaxResponsePlugin.inc.php
		</a><br>
	  </div><br />

      
      
            <b>Classes:</b><br />
        <div class="package">
		    		<a href="../xajax/legacyXajax.html">legacyXajax</a><br />
	    		<a href="../xajax/legacyXajaxResponse.html">legacyXajaxResponse</a><br />
	    		<a href="../xajax/xajax.html">xajax</a><br />
	    		<a href="../xajax/xajaxCall.html">xajaxCall</a><br />
	    		<a href="../xajax/xajaxDefaultIncludePlugin.html">xajaxDefaultIncludePlugin</a><br />
	    		<a href="../xajax/xajaxDefaultRequestProcessorPlugin.html">xajaxDefaultRequestProcessorPlugin</a><br />
	    		<a href="../xajax/xajaxIncludePlugin.html">xajaxIncludePlugin</a><br />
	    		<a href="../xajax/xajaxPluginManager.html">xajaxPluginManager</a><br />
	    		<a href="../xajax/xajaxRequestProcessorPlugin.html">xajaxRequestProcessorPlugin</a><br />
	    		<a href="../xajax/xajaxResponse.html">xajaxResponse</a><br />
	    		<a href="../xajax/xajaxResponsePlugin.html">xajaxResponsePlugin</a><br />
	  </div>

                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: xajaxDefaultRequestProcessorPlugin</h1>
Source Location: /pem-includes/xajax/xajax_core/plugin_layer/xajaxDefaultRequestProcessorPlugin.inc.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre><a href="../xajax/xajaxRequestProcessorPlugin.html">xajaxRequestProcessorPlugin</a>
   |
   --xajaxDefaultRequestProcessorPlugin</pre><br />
<div class="description">xajaxDefaultRequestProcessorPlugin.inc.php :: xajax default request   processor plugin</div><br /><br />
<h4>Author(s):</h4>
<ul>
                    </ul>




    
          
      
<h4>Version:</h4>
<ul>
  <li>$Id: xajaxDefaultRequestProcessorPlugin.inc.php 317 2007-01-30 19:36:39Z gaeldesign $</li>
</ul>

<h4>Copyright:</h4>
<ul>
  <li>Copyright (c) 2005-2006 by Jared White &amp; J. Max Wilson</li>
</ul>
        
</td>

<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#var$aObjArray">$aObjArray</a></li>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#var$iPos">$iPos</a></li>
  </ul>
</td>


<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#methodcanProcessRequest">canProcessRequest</a></li>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#methodgetRequestMode">getRequestMode</a></li>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#methodprocessRequest">processRequest</a></li>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#method_decodeUTF8Data">_decodeUTF8Data</a></li>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#method_outputError">_outputError</a></li>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#method_outputResponse">_outputResponse</a></li>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#method_parseObjXml">_parseObjXml</a></li>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#method_processInputArgs">_processInputArgs</a></li>
    <li><a href="../xajax/xajaxDefaultRequestProcessorPlugin.html#method_xmlToArray">_xmlToArray</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>




<td valign="top">
<h3>Inherited Variables</h3>
<div class="tags">
<h4>Class: <a href="../xajax/xajaxRequestProcessorPlugin.html">xajaxRequestProcessorPlugin</a></h4>
<dl>
<dt>
  <a href="../xajax/xajaxRequestProcessorPlugin.html#var$_objXajax">xajaxRequestProcessorPlugin::$_objXajax</a>
  </dt>
<dd>
   
</dd>
</dl>
</div>
</td>

<td valign="top">
<h3>Inherited Methods</h3>
<div class="tags">
<h4>Class: <a href="../xajax/xajaxRequestProcessorPlugin.html">xajaxRequestProcessorPlugin</a></h4>
<dl>
    <dt>
    <a href="../xajax/xajaxRequestProcessorPlugin.html#methodxajaxRequestProcessorPlugin">xajaxRequestProcessorPlugin::xajaxRequestProcessorPlugin()</a>
  </dt>
  <dd>
    
  </dd>
    <dt>
    <a href="../xajax/xajaxRequestProcessorPlugin.html#method__construct">xajaxRequestProcessorPlugin::__construct()</a>
  </dt>
  <dd>
    
  </dd>
    <dt>
    <a href="../xajax/xajaxRequestProcessorPlugin.html#methodcanProcessRequest">xajaxRequestProcessorPlugin::canProcessRequest()</a>
  </dt>
  <dd>
    
  </dd>
    <dt>
    <a href="../xajax/xajaxRequestProcessorPlugin.html#methodgetRequestMode">xajaxRequestProcessorPlugin::getRequestMode()</a>
  </dt>
  <dd>
    
  </dd>
    <dt>
    <a href="../xajax/xajaxRequestProcessorPlugin.html#methodprocessRequest">xajaxRequestProcessorPlugin::processRequest()</a>
  </dt>
  <dd>
    
  </dd>
    <dt>
    <a href="../xajax/xajaxRequestProcessorPlugin.html#methodsetXajax">xajaxRequestProcessorPlugin::setXajax()</a>
  </dt>
  <dd>
    
  </dd>
  </dl>
</div>
</td>

</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 24]<br />
xajaxDefaultRequestProcessorPlugin.inc.php :: xajax default request   processor plugin<br /><br /><p>xajax version 0.5 (Beta 2)  copyright (c) 2006 by Jared White &amp; J. Max Wilson  http://www.xajaxproject.org</p><p>xajax is an open source PHP class library for easily creating powerful  PHP-driven, web-based Ajax Applications. Using xajax, you can asynchronously  call PHP functions and update the content of your your webpage without  reloading the page.</p><p>xajax is released under the terms of the BSD license  http://www.xajaxproject.org/bsd_license.txt</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>version:</b>&nbsp;&nbsp;</td><td>$Id: xajaxDefaultRequestProcessorPlugin.inc.php 317 2007-01-30 19:36:39Z gaeldesign $</td>
  </tr>
  <tr>
    <td><b>copyright:</b>&nbsp;&nbsp;</td><td>Copyright (c) 2005-2006 by Jared White &amp; J. Max Wilson</td>
  </tr>
  <tr>
    <td><b>license:</b>&nbsp;&nbsp;</td><td><a href="http://www.xajaxproject.org/bsd_license.txt">BSD License</a></td>
  </tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />

<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
	<a name="var$aObjArray"></a>
	<p></p>
	<h4>$aObjArray = <span class="value"></span></h4>
	<p>[line 29]</p>
  <br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>var:</b>&nbsp;&nbsp;</td><td>Array for parsing complex objects</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>array</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$iPos"></a>
	<p></p>
	<h4>$iPos = <span class="value"></span></h4>
	<p>[line 33]</p>
  <br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>var:</b>&nbsp;&nbsp;</td><td>Position in $aObjArray</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>integer</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />

<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">

  <hr />
	<a name="methodcanProcessRequest"></a>
	<h3>method canProcessRequest <span class="smalllinenumber">[line 46]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void canProcessRequest(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		<br /><br />

	Overrides <a href="../xajax/xajaxRequestProcessorPlugin.html#methodcanProcessRequest">xajaxRequestProcessorPlugin::canProcessRequest()</a> (parent method not documented)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetRequestMode"></a>
	<h3>method getRequestMode <span class="smalllinenumber">[line 35]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void getRequestMode(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		<br /><br />

	Overrides <a href="../xajax/xajaxRequestProcessorPlugin.html#methodgetRequestMode">xajaxRequestProcessorPlugin::getRequestMode()</a> (parent method not documented)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodprocessRequest"></a>
	<h3>method processRequest <span class="smalllinenumber">[line 52]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void processRequest(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		<br /><br />

	Overrides <a href="../xajax/xajaxRequestProcessorPlugin.html#methodprocessRequest">xajaxRequestProcessorPlugin::processRequest()</a> (parent method not documented)<br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method_decodeUTF8Data"></a>
	<h3>method _decodeUTF8Data <span class="smalllinenumber">[line 454]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string _decodeUTF8Data(
string
$sData)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Decodes string data from UTF-8 to the current xajax encoding.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>converted data</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$sData</b>&nbsp;&nbsp;</td>
        <td>data to convert</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method_outputError"></a>
	<h3>method _outputError <span class="smalllinenumber">[line 251]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void _outputError(

$errorMsg)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">&nbsp;&nbsp;</td>
        <td><b>$errorMsg</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method_outputResponse"></a>
	<h3>method _outputResponse <span class="smalllinenumber">[line 207]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void _outputResponse(

$objResponse)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">&nbsp;&nbsp;</td>
        <td><b>$objResponse</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method_parseObjXml"></a>
	<h3>method _parseObjXml <span class="smalllinenumber">[line 333]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array _parseObjXml(
string
$rootTag)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		A recursive function that generates an array from the contents of  $this-&gt;aObjArray.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$rootTag</b>&nbsp;&nbsp;</td>
        <td>the root tag of the XML</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method_processInputArgs"></a>
	<h3>method _processInputArgs <span class="smalllinenumber">[line 267]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array _processInputArgs(
array
$aArgs)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Converts the raw input arguments into proper xajax arguments.<br /><br /><p>You can subclass xajax and extend this method to perform additional conversion  steps such as input filtering.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$aArgs</b>&nbsp;&nbsp;</td>
        <td>the arguments to process</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method_xmlToArray"></a>
	<h3>method _xmlToArray <span class="smalllinenumber">[line 303]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array _xmlToArray(
string
$rootTag, string
$sXml)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Takes a string containing xajax xjxobj XML or xjxquery XML and builds an  array representation of it to pass as an argument to the PHP function  being called.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$rootTag</b>&nbsp;&nbsp;</td>
        <td>the root tag of the XML</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$sXml</b>&nbsp;&nbsp;</td>
        <td>XML to convert</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Tue, 21 Aug 2007 14:49:57 -0500 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0a2</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>
Return current item: PhxEventManager