class Dashboard (View source)

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

string
getDashboardPaneHeader(bool $title = false, bool $help = false, array $navigatePages = [], bool $upToPage = false, bool $favorites = true)

No description

mixed
getIntelligentSearchMenu()

No description

Details

bool canRead()

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

Return Value

bool

bool canAccessComposer()

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

Parameters

$includeDefaultBody

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

deprecated

Parameters

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

string getDashboardPaneHeader(bool $title = false, bool $help = false, array $navigatePages = [], bool $upToPage = false, bool $favorites = true)

Parameters

bool $title
bool $help
array $navigatePages
bool $upToPage
bool $favorites

Return Value

string

mixed getIntelligentSearchMenu()

Return Value

mixed