ClientProxy.html:
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class ClientProxy</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class ClientProxy</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ClientProxy class - a class that is treated as the bi-direction proxy of client. Through this class, others can get client form inputs, redraw client form or call client javascript functions.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
<li><span class="field">copyright:</span> Copyright (c) 2005</li>
<li><span class="field">author:</span> rocky swen</li>
</ul>
<p class="notes">
Located in <a class="field" href="_ClientProxy_php.html">/ClientProxy.php</a> (line <span class="field">12</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$m_bRPCFlag" title="details" class="var-name">$m_bRPCFlag</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$m_FormInputArray" title="details" class="var-name">$m_FormInputArray</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$m_RequestArgs" title="details" class="var-name">$m_RequestArgs</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">void</span>
<a href="#CallClientFunction" title="details" class="method-name">CallClientFunction</a>
(<span class="var-type">mixed</span> <span class="var-name">$funcStr</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#ClosePopup" title="details" class="method-name">ClosePopup</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#GetFormInputs" title="details" class="method-name">GetFormInputs</a>
([<span class="var-type">string</span> <span class="var-name">$ctrlName</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#GetRequestParam" title="details" class="method-name">GetRequestParam</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#RedirectPage" title="details" class="method-name">RedirectPage</a>
(<span class="var-type">string</span> <span class="var-name">$pageURL</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#RedirectView" title="details" class="method-name">RedirectView</a>
(<span class="var-type">string</span> <span class="var-name">$view</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#ReDrawForm" title="details" class="method-name">ReDrawForm</a>
(<span class="var-type">string</span> <span class="var-name">$formName</span>, <span class="var-type">string</span> <span class="var-name">&$sHTML</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#SetFormInputData" title="details" class="method-name">SetFormInputData</a>
(<span class="var-type">string</span> <span class="var-name">$formdata</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#SetRPCFlag" title="details" class="method-name">SetRPCFlag</a>
(<span class="var-type">mixed</span> <span class="var-name">$flag</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#ShowClientAlert" title="details" class="method-name">ShowClientAlert</a>
(<span class="var-type">string</span> <span class="var-name">$alertText</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#ShowErrorMessage" title="details" class="method-name">ShowErrorMessage</a>
(<span class="var-type">mixed</span> <span class="var-name">$errMsg</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#ShowErrorPopup" title="details" class="method-name">ShowErrorPopup</a>
(<span class="var-type">mixed</span> <span class="var-name">$errMsg</span>)
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#UpdateFormElements" title="details" class="method-name">UpdateFormElements</a>
(<span class="var-type">string</span> <span class="var-name">$formName</span>, <span class="var-type">array</span> <span class="var-name">&$recArr</span>)
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$m_bRPCFlag" id="$m_bRPCFlag"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$m_bRPCFlag</span>
= <span class="var-default"> false</span> (line <span class="line-number">16</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$m_FormInputArray" id="$m_FormInputArray"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$m_FormInputArray</span>
(line <span class="line-number">15</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$m_RequestArgs" id="$m_RequestArgs"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$m_RequestArgs</span>
(line <span class="line-number">14</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodCallClientFunction" id="CallClientFunction"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">CallClientFunction</span> (line <span class="line-number">139</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
CallClientFunction
</span>
(<span class="var-type">mixed</span> <span class="var-name">$funcStr</span>)
</div>
</div>
<a name="methodClosePopup" id="ClosePopup"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">ClosePopup</span> (line <span class="line-number">133</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
ClosePopup
</span>
()
</div>
</div>
<a name="methodGetFormInputs" id="GetFormInputs"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">GetFormInputs</span> (line <span class="line-number">62</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ClientProxy::GetFormInputs() - get form all inputs or one input if ctrlName is given</p>
<ul class="tags">
<li><span class="field">return:</span> or string</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
GetFormInputs
</span>
([<span class="var-type">string</span> <span class="var-name">$ctrlName</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$ctrlName</span> </li>
</ul>
</div>
<a name="methodGetRequestParam" id="GetRequestParam"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">GetRequestParam</span> (line <span class="line-number">29</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ClientProxy::GetRequestParam() - get the client form data passed by GET or POST</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
GetRequestParam
</span>
(<span class="var-type">string</span> <span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span> </li>
</ul>
</div>
<a name="methodRedirectPage" id="RedirectPage"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">RedirectPage</span> (line <span class="line-number">168</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ClientProxy::RedirectPage() - redirect page to the given url</p>
<ul class="tags">
<li><span class="field">return:</span> - encoded html string returns to browser, it'll be processed by client javascript.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
RedirectPage
</span>
(<span class="var-type">string</span> <span class="var-name">$pageURL</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$pageURL</span> </li>
</ul>
</div>
<a name="methodRedirectView" id="RedirectView"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">RedirectView</span> (line <span class="line-number">178</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ClientProxy::RedirectView() - redirect page to the given view</p>
<ul class="tags">
<li><span class="field">return:</span> - encoded html string returns to browser, it'll be processed by client javascript.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
RedirectView
</span>
(<span class="var-type">string</span> <span class="var-name">$view</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$view</span> </li>
</ul>
</div>
<a name="methodReDrawForm" id="ReDrawForm"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">ReDrawForm</span> (line <span class="line-number">91</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ClientProxy::ReDrawForm() - replace the form content with the provided html text</p>
<ul class="tags">
<li><span class="field">return:</span> - encoded html string returns to browser, it'll be processed by client javascript.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
ReDrawForm
</span>
(<span class="var-type">string</span> <span class="var-name">$formName</span>, <span class="var-type">string</span> <span class="var-name">&$sHTML</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$formName</span><span class="var-description">: - name of the html form on client</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$sHTML</span><span class="var-description">: - html text to redraw the form</span> </li>
</ul>
</div>
<a name="methodSetFormInputData" id="SetFormInputData"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">SetFormInputData</span> (line <span class="line-number">41</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ClientProxy::SetFormInputData() - called by BizController to parse and save the client form data</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
SetFormInputData
</span>
(<span class="var-type">string</span> <span class="var-name">$formdata</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$formdata</span> </li>
</ul>
</div>
<a name="methodSetRPCFlag" id="SetRPCFlag"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">SetRPCFlag</span> (line <span class="line-number">18</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
SetRPCFlag
</span>
(<span class="var-type">mixed</span> <span class="var-name">$flag</span>)
</div>
</div>
<a name="methodShowClientAlert" id="ShowClientAlert"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">ShowClientAlert</span> (line <span class="line-number">102</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ClientProxy::ShowClientAlert() - popup an alert window on the browser</p>
<ul class="tags">
<li><span class="field">return:</span> - encoded html string returns to browser, it'll be processed by client javascript.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
ShowClientAlert
</span>
(<span class="var-type">string</span> <span class="var-name">$alertText</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$alertText</span> </li>
</ul>
</div>
<a name="methodShowErrorMessage" id="ShowErrorMessage"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">ShowErrorMessage</span> (line <span class="line-number">109</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
ShowErrorMessage
</span>
(<span class="var-type">mixed</span> <span class="var-name">$errMsg</span>)
</div>
</div>
<a name="methodShowErrorPopup" id="ShowErrorPopup"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">ShowErrorPopup</span> (line <span class="line-number">120</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
ShowErrorPopup
</span>
(<span class="var-type">mixed</span> <span class="var-name">$errMsg</span>)
</div>
</div>
<a name="methodUpdateFormElements" id="UpdateFormElements"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">UpdateFormElements</span> (line <span class="line-number">77</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ClientProxy::UpdateFormElements() - update the form controls on the client UI</p>
<ul class="tags">
<li><span class="field">return:</span> or string</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
UpdateFormElements
</span>
(<span class="var-type">string</span> <span class="var-name">$formName</span>, <span class="var-type">array</span> <span class="var-name">&$recArr</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$formName</span><span class="var-description">: - name of the html form on client</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$recArr</span><span class="var-description">: - name/value pairs</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 26 Oct 2005 07:44:48 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
</p>
</div></body>
</html>
Other Development Tools Scripts:
