PHP Class RainLab\Pages\Widgets\PageList

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

Public Properties

Property Type Description
$addSubpageLabel
$deleteConfirmation Message to display when the Delete button is clicked.
$noRecordsMessage

Protected Properties

Property Type Description
$dataIdPrefix
$theme

Public Methods

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

Protected Methods

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

Method Details

__construct() public method

public __construct ( $controller, $alias )

getData() protected method

* Methods for th internal use
protected getData ( )

getSession() protected method

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

getThemeSessionKey() protected method

protected getThemeSessionKey ( $prefix )

onReorder() public method

* Event handlers
public onReorder ( )

onSearch() public method

public onSearch ( )

onUpdate() public method

public onUpdate ( )

pageToText() protected method

protected pageToText ( $page )

putSession() protected method

protected putSession ( $key, $value )

render() public method

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

subtreeToText() protected method

protected subtreeToText ( $page )

updateList() protected method

protected updateList ( )

Property Details

$addSubpageLabel public_oe property

public $addSubpageLabel

$dataIdPrefix protected_oe property

protected $dataIdPrefix

$deleteConfirmation public_oe property

Message to display when the Delete button is clicked.
public $deleteConfirmation

$noRecordsMessage public_oe property

public $noRecordsMessage

$theme protected_oe property

protected $theme