PHP Class Prado\Web\UI\ActiveControls\TCallbackEventParameter

The TCallbackEventParameter provides the parameter passed during the callback request in the {@link getCallbackParameter CallbackParameter} property. The callback response content (e.g. new HTML content) must be rendered using an THtmlWriter obtained from the {@link getNewWriter NewWriter} property, which returns a NEW instance of TCallbackResponseWriter. Each instance TCallbackResponseWriter is associated with a unique boundary delimited. By default each panel only renders its own content. To replace the content of ONE panel with that of rendered from multiple panels use the same writer instance for the panels to be rendered. The response data (i.e., passing results back to the client-side callback handler function) can be set using {@link setResponseData ResponseData} property.
Since: 3.1
Inheritance: extends Prado\TEventParameter
Exibir arquivo Open project: pradosoft/prado Class Usage Examples

Public Methods

Method Description
__construct ( $response, $parameter ) Creates a new TCallbackEventParameter.
getCallbackParameter ( ) : mixed
getNewWriter ( ) : TCallbackResponseWriter
getResponseData ( ) : mixed
setResponseData ( $value )

Method Details

__construct() public method

Creates a new TCallbackEventParameter.
public __construct ( $response, $parameter )

getCallbackParameter() public method

public getCallbackParameter ( ) : mixed
return mixed callback request parameter.

getNewWriter() public method

public getNewWriter ( ) : TCallbackResponseWriter
return TCallbackResponseWriter holds the response content.

getResponseData() public method

public getResponseData ( ) : mixed
return mixed callback response data.

setResponseData() public method

public setResponseData ( $value )