dashboard Class Reference

dashboard helper class More...

Static Public Member Functions

static get_default_dashboard ()
 Returns the default dashboard for the currently authenticated user, be it through the login_dashboard setting or just an accessable one.
static get_login_dashboard ()
 Returns a Dashboard_Model if the user has set an explicit login dashboard that exists.
static is_login_dashboard (Dashboard_Model $dashboard)
 Whether to show "Set as login dashboard" for the given Dashboard.
static set_dashboard_menu_based_on_logged_in_user (Menu_Model $menu)
 Objects are always passed by reference, which means that you could modify away on $menu and still have it reflected elsewhere!

Detailed Description

dashboard helper class


Member Function Documentation

static dashboard::get_default_dashboard (  )  [static]

Returns the default dashboard for the currently authenticated user, be it through the login_dashboard setting or just an accessable one.

Returns:
Dashboard_Model Returns null/false if no dashboard is found
static dashboard::get_login_dashboard (  )  [static]

Returns a Dashboard_Model if the user has set an explicit login dashboard that exists.

Returns:
Dashboard_Model or null/false if no dashboard is set or exists
static dashboard::is_login_dashboard ( Dashboard_Model dashboard  )  [static]

Whether to show "Set as login dashboard" for the given Dashboard.

Parameters:
$dashboard Dashboard_Model
Returns:
bool
static dashboard::set_dashboard_menu_based_on_logged_in_user ( Menu_Model menu  )  [static]

Objects are always passed by reference, which means that you could modify away on $menu and still have it reflected elsewhere!

Parameters:
$menu Menu_Model

The documentation for this class was generated from the following file:
 All Data Structures Functions Variables

Generated on 19 Dec 2018 for ninja by  doxygen 1.6.1