Documentation

Sidebar extends Base
in package

AbstractYes

Table of Contents

Properties

$element  : mixed
$extension  : mixed
$fd  : mixed
$key  : mixed

Methods

__construct()  : mixed
format()  : mixed
Centralized method to formats the dataset for sidebar at the back-end
generateIndex()  : mixed
Generates the index for the current model
getForm()  : mixed
To satisfy the requirements from \JModelAdmin
getItems()  : mixed
Retrieves a list of menus on the sidebar
getUserStateFromRequest()  : mixed
Get state from the current request
getViews()  : mixed
Given a list of sidebar structure, collect all the views used in the childs
getCount()  : mixed
Retrieve counters defined by the respective extension
getMenus()  : mixed
Retrieve menus defined by the respective extension
populateState()  : mixed
Stock method to auto-populate the model state.

Properties

$element

protected mixed $element = 'sidebar'

$extension

protected mixed $extension = null

$fd

protected mixed $fd = null

$key

protected mixed $key = null

Methods

__construct()

public __construct([mixed $config = [] ]) : mixed
Parameters
$config : mixed = []

format()

Centralized method to formats the dataset for sidebar at the back-end

public static format(mixed $activeView, mixed $items, mixed $extension, mixed $getViewsCallback, mixed $getCountCallback) : mixed
Parameters
$activeView : mixed
$items : mixed
$extension : mixed
$getViewsCallback : mixed
$getCountCallback : mixed
Tags
since
1.1.0
access

public

generateIndex()

Generates the index for the current model

public final generateIndex([mixed $namespace = '' ]) : mixed
Parameters
$namespace : mixed = ''
Tags
since
1.1.0
access

private

getForm()

To satisfy the requirements from \JModelAdmin

public getForm([mixed $data = [] ][, mixed $loadData = true ]) : mixed
Parameters
$data : mixed = []
$loadData : mixed = true
Tags
since
1.1.0
access

public

getItems()

Retrieves a list of menus on the sidebar

public getItems(mixed $activeView) : mixed
Parameters
$activeView : mixed
Tags
since
1.1.0
access

public

getUserStateFromRequest()

Get state from the current request

public getUserStateFromRequest(mixed $key[, mixed $default = '' ][, mixed $type = 'none' ]) : mixed
Parameters
$key : mixed
$default : mixed = ''
$type : mixed = 'none'
Tags
since
1.1.0
access

public

getViews()

Given a list of sidebar structure, collect all the views used in the childs

public getViews(mixed $menu) : mixed
Parameters
$menu : mixed
Tags
since
1.1.0
access

public

getCount()

Retrieve counters defined by the respective extension

protected abstract getCount(mixed $namespace) : mixed
Parameters
$namespace : mixed
Tags
since
1.1.0
access

protected

getMenus()

Retrieve menus defined by the respective extension

protected abstract getMenus() : mixed
Tags
since
1.1.0
access

protected

populateState()

Stock method to auto-populate the model state.

protected populateState() : mixed
Tags
since
1.1.2
access

protected


        
On this page

Search results