Client
[ class tree: Client ] [ index: Client ] [ all elements ]

Class: AjaxPluginResponse

Source Location: /client/AjaxHelper.php

Class Overview


Container for plugins' AJAX responses


Variables

Methods



Class Details

[line 45]
Container for plugins' AJAX responses

This object is used by plugins in Ajaxable::getAjaxResponse() - called by FormRenderer::showAjaxPluginResponse() to feed the pluginResponse XML docuemt




[ Top ]


Class Variables

$htmlCode = array()

[line 50]



Tags:

var:  array of assigned htmlCode.
access:  protected

Type:   array


[ Top ]

$variables = array()

[line 55]



Tags:

var:  array of assigned variables.
access:  protected

Type:   array


[ Top ]



Class Methods


constructor __construct [line 60]

AjaxPluginResponse __construct( )

Constructor



Tags:

access:  public


[ Top ]

method addHtmlCode [line 68]

void addHtmlCode( string $id, string $htmlCode)

Adds HTML code to AJAX response.



Tags:

access:  public


Parameters:

string   $id   id of the HTML code to add
string   $htmlCode   HTML code content

[ Top ]

method addVariable [line 85]

void addVariable( string $id, string $value)

Adds a value to AJAX response.



Tags:

access:  public


Parameters:

string   $id   variable id
string   $value   variable value

[ Top ]

method getHtmlCode [line 76]

array getHtmlCode( )

Returns an array of HTML code.



Tags:

return:  array of added HTML code.
access:  public


[ Top ]

method getVariables [line 93]

array getVariables( )

Returns an array of variables.



Tags:

return:  array of added variables
access:  public


[ Top ]

method isEmpty [line 102]

bool isEmpty( )

Returns true if both HTML and variables content are empty



Tags:

return:  true if both HTML and variables content are empty, false otherwise
access:  public


[ Top ]


Documentation generated on Mon, 09 Sep 2013 13:30:23 +0200 by phpDocumentor 1.3.0RC3