class Dashboard (View source)

Properties

protected bool|null $canRead
protected bool|null $canAccessComposer

Methods

bool
canRead()

Checks to see if a user has access to the C5 dashboard.

bool
canAccessComposer()

No description

bool
inDashboard(Page|string|null $pageOrPath = null)

Test if the a page or path path is within the dashboard.

getDashboardPaneFooterWrapper($includeDefaultBody = true) deprecated

No description

getDashboardPaneHeaderWrapper($title = false, $help = false, $span = 'span12', $includeDefaultBody = true, $navigatePages = [], $upToPage = false, $favorites = true) deprecated

No description

Details

bool canRead()

Checks to see if a user has access to the C5 dashboard.

Return Value

bool

bool canAccessComposer()

No description

Return Value

bool

bool inDashboard(Page|string|null $pageOrPath = null)

Test if the a page or path path is within the dashboard.

If an empty (or no) argument is passed, we'll check the current page.

Parameters

Page|string|null $pageOrPath

Return Value

bool

getDashboardPaneFooterWrapper($includeDefaultBody = true) deprecated

deprecated

No description

Parameters

$includeDefaultBody

getDashboardPaneHeaderWrapper($title = false, $help = false, $span = 'span12', $includeDefaultBody = true, $navigatePages = [], $upToPage = false, $favorites = true) deprecated

deprecated

No description

Parameters

$title
$help
$span
$includeDefaultBody
$navigatePages
$upToPage
$favorites