PHP Class RainLab\Pages\Widgets\SnippetList

Author: Alexey Bobkov, Samuel Georges
Inheritance: extends Backend\Classes\WidgetBase, use trait Backend\Traits\SearchableWidget
Show file Open project: rainlab/pages-plugin

Public Properties

Property Type Description
$noRecordsMessage

Protected Properties

Property Type Description
$dataIdPrefix
$theme

Public Methods

Method Description
__construct ( $controller, $alias )
onSearch ( ) * Event handlers
render ( ) : string Renders the widget.

Protected Methods

Method Description
getData ( ) * Methods for the internal use
getSession ( $key = null, $default = null )
getThemeSessionKey ( $prefix )
putSession ( $key, $value )
updateList ( )

Method Details

__construct() public method

public __construct ( $controller, $alias )

getData() protected method

* Methods for the internal use
protected getData ( )

getSession() protected method

protected getSession ( $key = null, $default = null )

getThemeSessionKey() protected method

protected getThemeSessionKey ( $prefix )

onSearch() public method

* Event handlers
public onSearch ( )

putSession() protected method

protected putSession ( $key, $value )

render() public method

Renders the widget.
public render ( ) : string
return string

updateList() protected method

protected updateList ( )

Property Details

$dataIdPrefix protected property

protected $dataIdPrefix

$noRecordsMessage public property

public $noRecordsMessage

$theme protected property

protected $theme