Class: ClientProxy

Source Location: /ClientProxy.php

Class ClientProxy

Class Overview

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.

Located in /ClientProxy.php [line 28]

Author(s):

Rocky Swen <rocky@phpopenbiz.org>

API Tags:

Access:

public

Information Tags:

Copyright:

Properties

Methods

[ Top ]

Property Summary

mixed	$m_bRPCFlag
mixed	$m_FormInputArray
mixed	$m_RequestArgs

[ Top ]

Method Summary

void	AppendScripts()	Append more scripts - js include, js code
void	AppendStyles()	Append more styles - include and sections
void	ClosePopup()	Close popup window
string	GetAppendedScripts()	Get append scripts
string	GetAppendedStyles()	Get appended styles
array	GetFormInputs()	Get form all inputs or one input if ctrlName is given
string	GetFormOutput()	Get form output.
string	GetRequestParam()	Get request parameter
boolean	HasFormRerendered()	Check has form rendered?
boolean	HasOtherOutput()	Check has other output?
boolean	HasOutput()	Check has output (other output and/or forms output)
void	IncludeCalendarScripts()	Include calendar scripts
void	IncludeCKEditorScripts()	Include CKEditor scripts
void	IncludeModalScripts()	Include modal scripts
void	IncludePropWindowScripts()	Include PropWindow scripts
void	IncludeRTEScripts()	Include RTE scripts
void	IncludeValidatorScripts()	Include validator scripts
void	IncludeWindowScripts()	Include Window scripts
void	PrintOutput()	Print output.
string	RedirectPage()	Redirect page to the given url
string	RedirectView()	Redirect page to the given view
string	ReDrawForm()	Replace the form content with the provided html text
void	RunClientScript()	Run client script
void	SetFormInputData()	Set form input data.
void	SetRPCFlag()	Set RPC flag.
string	ShowClientAlert()	Show popup an alert window on the client browser.
void	ShowErrorMessage()	Show error message.
void	ShowErrorPopup()	Show error on popup window
void	ShowPopup()	Show popup window
void	ShowPopupWindow()	Show popup window
void	UpdateClientElement()	Update client element
array	UpdateFormElements()	Update the form elements/controls on the client UI

[ Top ]

Properties

mixed $m_bRPCFlag = false [line 32]

API Tags:

Access:

protected

[ Top ]

mixed $m_FormInputArray = null [line 31]

API Tags:

Access:

protected

[ Top ]

mixed $m_RequestArgs [line 30]

API Tags:

Access:

protected

[ Top ]

Methods

AppendScripts [line 462]

void AppendScripts(

$scriptKey, string
$scripts, [boolean
$isFile = true] 
)

Append more scripts - js include, js code

Parameters:

	$scriptKey:
string	$scripts:
boolean	$isFile:

API Tags:

Access:

public

[ Top ]

AppendStyles [line 502]

void AppendStyles(

$scriptKey, string
$styles, [boolean
$isFile = true] 
)

Append more styles - include and sections

Parameters:

	$scriptKey:
string	$styles:
boolean	$isFile:

API Tags:

Access:

public

[ Top ]

ClosePopup [line 351]

void ClosePopup(
)

Close popup window

API Tags:

Access:

public

[ Top ]

GetAppendedScripts [line 481]

string GetAppendedScripts(
)

Get append scripts

API Tags:

Access:

public

[ Top ]

GetAppendedStyles [line 522]

string GetAppendedStyles(
)

Get appended styles

API Tags:

Access:

public

[ Top ]

GetFormInputs [line 173]

array GetFormInputs(
[string
$ctrlName = null], [boolean
$toString = TRUE] 
)

Get form all inputs or one input if ctrlName is given

Parameters:

string	$ctrlName:
boolean	$toString:	- Convert array oriented form controls to string

API Tags:

Return:	or string
Access:	public

[ Top ]

GetFormOutput [line 76]

string GetFormOutput(
string
$formName 
)

Get form output.

Parameters:

string

$formName:

API Tags:

Return:	HTML output of form
Access:	public

[ Top ]

GetRequestParam [line 138]

string GetRequestParam(
string
$name 
)

Get request parameter

Get the client form data passed by GET or POST

Parameters:

string

$name:

API Tags:

Access:

public

[ Top ]

HasFormRerendered [line 65]

boolean HasFormRerendered(
string
$formName 
)

Check has form rendered?

Form has rendered if _formsOutput[$formName] exist. See ReDrawForm method.

Parameters:

string

$formName:

API Tags:

Return:	true if form rendered (formName exist on _formsOutput)
Access:	public

[ Top ]

HasOtherOutput [line 86]

boolean HasOtherOutput(
)

Check has other output?

API Tags:

Return:	true if has other output
Access:	public

[ Top ]

HasOutput [line 96]

boolean HasOutput(
)

Check has output (other output and/or forms output)

API Tags:

Return:	true if has output
Access:	public

[ Top ]

IncludeCalendarScripts [line 540]

void IncludeCalendarScripts(
)

Include calendar scripts

API Tags:

Access:

public

[ Top ]

IncludeCKEditorScripts [line 572]

void IncludeCKEditorScripts(
)

Include CKEditor scripts

API Tags:

Access:

public

[ Top ]

IncludeModalScripts [line 613]

void IncludeModalScripts(
)

Include modal scripts

API Tags:

Access:

public

[ Top ]

IncludePropWindowScripts [line 586]

void IncludePropWindowScripts(
)

Include PropWindow scripts

API Tags:

Access:

public

[ Top ]

IncludeRTEScripts [line 558]

void IncludeRTEScripts(
)

Include RTE scripts

API Tags:

Access:

public

[ Top ]

IncludeValidatorScripts [line 599]

void IncludeValidatorScripts(
)

Include validator scripts

API Tags:

Access:

public

[ Top ]

IncludeWindowScripts [line 632]

void IncludeWindowScripts(
)

Include Window scripts

API Tags:

Access:

public

[ Top ]

PrintOutput [line 106]

void PrintOutput(
)

Print output.

API Tags:

Access:

public

[ Top ]

RedirectPage [line 432]

string RedirectPage(
string
$pageURL 
)

Redirect page to the given url

Parameters:

string

$pageURL:

API Tags:

Return:	- encoded html string returns to browser, it'll be processed by client javascript.
Access:	public

[ Top ]

RedirectView [line 450]

string RedirectView(
string
$view, [mixed
$rule = null] 
)

Redirect page to the given view

Parameters:

string

$view:

API Tags:

Return:	- encoded html string returns to browser, it'll be processed by client javascript.
Access:	public

[ Top ]

ReDrawForm [line 239]

string ReDrawForm(
string
$formName, string
&$sHTML 
)

Replace the form content with the provided html text

Parameters:

string	$formName:	- name of the html form on client
string	$sHTML:	- html text to redraw the form

API Tags:

Return:	- encoded html string returns to browser, it'll be processed by client javascript.
Access:	public

[ Top ]

RunClientScript [line 387]

void RunClientScript(
string
$scriptStr 
)

Run client script

Parameters:

string

$scriptStr:

API Tags:

Access:

public

[ Top ]

SetFormInputData [line 152]

void SetFormInputData(
string
$formdata 
)

Set form input data.

Called by BizController to parse and save the client form data

Parameters:

string

$formdata:

API Tags:

Access:

public

[ Top ]

SetRPCFlag [line 125]

void SetRPCFlag(
boolean
$flag 
)

Set RPC flag.

Parameters:

boolean

$flag:

API Tags:

Access:

public

[ Top ]

ShowClientAlert [line 253]

string ShowClientAlert(
string
$alertText 
)

Show popup an alert window on the client browser.

Parameters:

string

$alertText:

API Tags:

Return:	- encoded html string returns to browser, it'll be processed by client javascript.
Access:	public

[ Top ]

ShowErrorMessage [line 268]

void ShowErrorMessage(
char
$errMsg 
)

Show error message.

If its a remote call, it uses javascript If it is not a remote call, it outputs to the page's html

Parameters:

char

$errMsg:

API Tags:

Access:

public

[ Top ]

ShowErrorPopup [line 332]

void ShowErrorPopup(
string
$errMsg 
)

Show error on popup window

Parameters:

string

$errMsg:

error message

API Tags:

Access:

public

[ Top ]

ShowPopup [line 288]

void ShowPopup(
string
$baseForm, string
$popupForm, [string
$ctrlName = ""] 
)

Show popup window

Parameters:

string	$baseForm:
string	$popupForm:
string	$ctrlName:

API Tags:

Access:

public

[ Top ]

ShowPopupWindow [line 364]

void ShowPopupWindow(
string
$content, number
$w, number
$h 
)

Show popup window

Parameters:

string	$content:
number	$w:	width of window
number	$h:	height of window

API Tags:

Access:

public

[ Top ]

UpdateClientElement [line 376]

void UpdateClientElement(
string
$elementId, string
$content 
)

Update client element

Parameters:

string	$elementId:
string	$content:

API Tags:

Access:

public

[ Top ]

UpdateFormElements [line 221]

array UpdateFormElements(
string
$formName, array
&$recArr 
)

Update the form elements/controls on the client UI

Parameters:

string	$formName:	- name of the html form on client
array	$recArr:	- name/value pairs

API Tags:

Return:	or string
Access:	public

[ Top ]

Documentation generated on Tue, 22 Dec 2009 03:02:41 -0800 by phpDocumentor 1.3.0RC3

	openbiz.bin

[ class tree: openbiz.bin ] [ index: openbiz.bin ] [ all elements ]