PHP Class Prado\Web\UI\ActiveControls\TActiveDataList

TActiveDataList represents a data bound and updatable grid control which is the active counterpart to the original {@link TDataList} control. This component can be used in the same way as the regular datalist, the only difference is that the active datalist uses callbacks instead of postbacks for interaction. Please refer to the original documentation of the regular counterparts for usage.
Author: Marcos Aurelio Nobre ([email protected])
Inheritance: extends Prado\Web\UI\WebControls\TDataList, implements Prado\Web\UI\ActiveControls\IActiveControl
Datei anzeigen Open project: pradosoft/prado

Public Methods

Method Description
__construct ( ) Creates a new callback control, sets the adapter to TActiveControlAdapter.
getActiveControl ( ) : TBaseActiveControl
render ( $writer ) Renders the repeater.
setDataSource ( $value ) Sets the data source object associated with the repeater control.

Protected Methods

Method Description
getContainerID ( ) : string Returns the id of the surrounding container (span).

Private Methods

Method Description
renderDataList ( $writer ) Renders the repeater by writing a span tag with the container id obtained from {@link getContainerID()} which will be called by the replacement method of the client script to update it's content.
renderPager ( ) Loops through all {@link TActivePager} on the page and registers the ones which are set to paginate the repeater for rendering. This is to ensure that the connected pagers are also rendered if the data source changed.

Method Details

__construct() public method

Creates a new callback control, sets the adapter to TActiveControlAdapter.
public __construct ( )

getActiveControl() public method

public getActiveControl ( ) : TBaseActiveControl
return TBaseActiveControl standard active control options.

getContainerID() protected method

Returns the id of the surrounding container (span).
protected getContainerID ( ) : string
return string container id

render() public method

If the repeater did not pass the prerender phase yet, it will register itself for rendering later. Else it will call the {@link renderRepeater()} method which will do the rendering of the repeater.
public render ( $writer )

setDataSource() public method

In addition, the render method of all connected pagers is called so they get updated when the data source is changed. Also the repeater registers itself for rendering in order to get it's content replaced on client side.
public setDataSource ( $value )