setupPage Class Reference
The setupPage class, used to make sure all the setup pages are rendered in a consistent manner. More...
Public Member Functions | |
| setupPage () | |
| addBreadcrumb ($title, $url) | |
| addCommand ($title, $description, $url) | |
| render () | |
Public Attributes | |
| $contents | |
| string The contents of the setup page | |
| $breadcrumbs | |
| array An array of breadcrumbs data. This always has the top level defined, so no need to add that | |
| $commands | |
| array An array containing commands. Optional | |
Detailed Description
The setupPage class, used to make sure all the setup pages are rendered in a consistent manner.Definition at line 90 of file shared-setup.php.
Member Function Documentation
| setupPage::setupPage | ( | ) |
The setupPage constructor
Definition at line 99 of file shared-setup.php.
References $language, addBreadcrumb(), globalIDtoURL(), and i18n().
Here is the call graph for this function:
| setupPage::addBreadcrumb | ( | $ | title, | |
| $ | url | |||
| ) |
Adds a breadcrumb to the end of the breadcrumbs trail
- Parameters:
-
$title What to show in the breadcrumbs trail $url The url to invoke upon activation of the breadcrumbs trail
Definition at line 115 of file shared-setup.php.
Referenced by setupPage().
| setupPage::addCommand | ( | $ | title, | |
| $ | description, | |||
| $ | url | |||
| ) |
Adds a new command to the left of the commands
- Parameters:
-
$title The short title of the command $description The longer tooltip description of the command $url The url to invoke when the command is activated
Definition at line 130 of file shared-setup.php.
| setupPage::render | ( | ) |
Renders the setup page as defined by the current instance
- Returns:
- string The rendered setup page
Definition at line 144 of file shared-setup.php.
References drawCommand().
Here is the call graph for this function:
Member Data Documentation
| setupPage::$contents |
| setupPage::$breadcrumbs |
array An array of breadcrumbs data. This always has the top level defined, so no need to add that
Definition at line 93 of file shared-setup.php.
| setupPage::$commands |
The documentation for this class was generated from the following file:
