PHP Class DashboardController, vanilla

Inheritance: extends AppController
ファイルを表示 Open project: vanilla/vanilla Class Usage Examples

Public Methods

Method Description
__construct ( ) Set PageName.
addSideMenu ( string $currentUrl = '' )
initialize ( ) Include JS, CSS, and modules used by all methods.
setHighlightRoute ( string $currentUrl = '' )
userPreferenceCollapse ( ) Sets a user's preference for dashboard panel nav collapsing. Collapsed groups are stored in an list, by their 'data-key' attribute on the nav-header element.
userPreferenceDashboardLandingPage ( ) Saves the name of the section that a user has last navigated to serve as the landing page for whenever they navigate to the dashboard.
userPreferenceSectionLandingPage ( ) Sets a user's preference for the landing page for each top-level nav item. Stored in a list as SectionName->url pairs, where SectionName is the 'data-section' attribute on the panel nav link.

Method Details

__construct() public method

Set PageName.
Since: 2.0.0
public __construct ( )

addSideMenu() public method

public addSideMenu ( string $currentUrl = '' )
$currentUrl string

initialize() public method

Always called by dispatcher before controller's requested method.
Since: 2.0.0
public initialize ( )

setHighlightRoute() public method

public setHighlightRoute ( string $currentUrl = '' )
$currentUrl string

userPreferenceCollapse() public method

Sets a user's preference for dashboard panel nav collapsing. Collapsed groups are stored in an list, by their 'data-key' attribute on the nav-header element.
Saves the name of the section that a user has last navigated to serve as the landing page for whenever they navigate to the dashboard.

userPreferenceSectionLandingPage() public method

Sets a user's preference for the landing page for each top-level nav item. Stored in a list as SectionName->url pairs, where SectionName is the 'data-section' attribute on the panel nav link.