Public Member Functions | Protected Member Functions | Protected Attributes

ClientProxy Class Reference

Public Member Functions

 hasFormRerendered ($formName)
 getFormOutput ($formName)
 hasOtherOutput ()
 hasOutput ()
 printOutput ()
 setRPCFlag ($flag)
 getRequestParam ($name)
 getFormInputs ($controlName=null, $toString=TRUE)
 updateFormElements ($formName, $recArr, $rawData=false)
 redrawForm ($formName, $sHTML)
 showClientAlert ($alertText)
 showErrorMessage ($errMsg, $flush=false)
 showPopup ($baseForm, $popupForm, $ctrlName="")
 closePopup ()
 showPopupWindow ($content, $w, $h)
 updateClientElement ($elementId, $content)
 runClientScript ($scriptStr)
 runClientFunction ($scriptStr)
 redirectPage ($pageURL)
 redirectView ($view, $rule=null)
 appendScripts ($scriptKey, $scripts, $isFile=true)
 getAppendedScripts ()
 appendStyles ($scriptKey, $styles, $isFile=true)
 getAppendedStyles ($comb=0)
 includeCalendarScripts ()
 includeColorPickerScripts ()
 includeRTEScripts ()
 includeCKEditorScripts ()
 includePropWindowScripts ()
 includeValidatorScripts ()

Protected Member Functions

 printJSONOuput ()

Protected Attributes

 $m_RequestArgs
 $m_FormInputArray = null
 $m_bRPCFlag = false

Detailed Description

Definition at line 28 of file ClientProxy.php.


Member Function Documentation

appendScripts ( scriptKey,
scripts,
isFile = true 
)

Append more scripts - js include, js code

Parameters:
mixed$scriptKey
string$scripts
boolean$isFile
Returns:
void

Definition at line 491 of file ClientProxy.php.

Here is the caller graph for this function:

appendStyles ( scriptKey,
styles,
isFile = true 
)

Append more styles - include and sections

Parameters:
<type>$scriptKey
string$styles
boolean$isFile
Returns:
void

Definition at line 546 of file ClientProxy.php.

Here is the call graph for this function:

Here is the caller graph for this function:

closePopup (  )

Close popup window

Returns:
void

Definition at line 359 of file ClientProxy.php.

getAppendedScripts (  )

Get append scripts

Returns:
string

Definition at line 510 of file ClientProxy.php.

Here is the call graph for this function:

getAppendedStyles ( comb = 0 )

Get appended styles

Returns:
string

Definition at line 566 of file ClientProxy.php.

getFormInputs ( controlName = null,
toString = TRUE 
)

Get form all inputs or one input if controlName is given

Parameters:
string$controlName
boolean$toString- Convert array oriented form controls to string?
Returns:
array|string

Definition at line 167 of file ClientProxy.php.

getFormOutput ( formName )

Get form output.

Parameters:
string$formName
Returns:
string HTML output of form

Definition at line 76 of file ClientProxy.php.

getRequestParam ( name )

Get request parameter, get the client form data passed by GET or POST NOTE: NYU - not yet used

Parameters:
string$namename of parameter
Returns:
string value of paramater

Definition at line 154 of file ClientProxy.php.

hasFormRerendered ( formName )

Check has form rendered?

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

Parameters:
string$formName
Returns:
boolean true if form rendered (formName exist on _formsOutput)

Definition at line 65 of file ClientProxy.php.

hasOtherOutput (  )

Check has other output? NOTE: NYU - not yet used

Returns:
boolean true if has other output

Definition at line 87 of file ClientProxy.php.

hasOutput (  )

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

Returns:
boolean true if has output

Definition at line 97 of file ClientProxy.php.

includeCalendarScripts (  )

Include calendar scripts

Returns:
void

Definition at line 603 of file ClientProxy.php.

Here is the call graph for this function:

includeCKEditorScripts (  )

Include CKEditor scripts

Returns:
void

Definition at line 653 of file ClientProxy.php.

Here is the call graph for this function:

includeColorPickerScripts (  )

Include calendar scripts

Returns:
void

Definition at line 622 of file ClientProxy.php.

Here is the call graph for this function:

includePropWindowScripts (  )

Include PropWindow scripts

Returns:
void

Definition at line 668 of file ClientProxy.php.

Here is the call graph for this function:

includeRTEScripts (  )

Include RTE scripts

Returns:
void

Definition at line 639 of file ClientProxy.php.

Here is the call graph for this function:

includeValidatorScripts (  )

Include validator scripts

Returns:
void

Definition at line 683 of file ClientProxy.php.

Here is the call graph for this function:

printOutput (  )

Print output.

Returns:
void

Definition at line 107 of file ClientProxy.php.

Here is the caller graph for this function:

redirectPage ( pageURL )

Redirect page to the given url. Encoded html string returns to browser, it'll be processed by client javascript. NOTE: NYU - not yet used

Parameters:
string$pageURL
Returns:
void

Definition at line 450 of file ClientProxy.php.

redirectView ( view,
rule = null 
)

Redirect page to the given view. Encoded html string returns to browser, it'll be processed by client javascript.

Parameters:
string$viewfull name of view (with package)
string$rule
Returns:
void

Definition at line 472 of file ClientProxy.php.

redrawForm ( formName,
sHTML 
)

Replace the form content with the provided html text, encoded html string returns to browser, it'll be processed by client javascript.

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

Definition at line 248 of file ClientProxy.php.

runClientScript ( scriptStr )

Run client script

Parameters:
string$scriptStr
Returns:
void

Definition at line 400 of file ClientProxy.php.

Here is the caller graph for this function:

setRPCFlag ( flag )

Set RPC flag.

Parameters:
boolean$flag
Returns:
void

Definition at line 141 of file ClientProxy.php.

showClientAlert ( alertText )

Show popup an alert window on the client browser. Encoded html string returns to browser, it'll be processed by client javascript.

Parameters:
string$alertText
Returns:
void

Definition at line 263 of file ClientProxy.php.

showErrorMessage ( errMsg,
flush = false 
)

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
Returns:
void

Definition at line 279 of file ClientProxy.php.

Here is the call graph for this function:

showPopup ( baseForm,
popupForm,
ctrlName = "" 
)

Show popup window

Parameters:
string$baseForm
string$popupForm
string$ctrlName
Returns:
void

Definition at line 306 of file ClientProxy.php.

showPopupWindow ( content,
w,
h 
)

Show popup window

Parameters:
string$content
number$wwidth of window
number$hheight of window
Returns:
void

Definition at line 375 of file ClientProxy.php.

updateClientElement ( elementId,
content 
)

Update client element

Parameters:
string$elementId
string$content
Returns:
void

Definition at line 388 of file ClientProxy.php.

Here is the call graph for this function:

updateFormElements ( formName,
recArr,
rawData = false 
)

Update the form elements/controls on the client UI Return to client browser : array or string

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

Definition at line 221 of file ClientProxy.php.


The documentation for this class was generated from the following file: