SystemAdmin
Reference for the SystemAdmin module: the System area of the admin interface. Tools register themselves as System sections, and modules add summary panels to the System home page. The module also contributes a pointer panel to the main Admin home page.
This page is a pure reference. For how the framework fits together, see the Guide.
SystemAdminConfig- register System admin sections and home page panels.SystemAdminUi- render the System section and its navigation.SystemAdminPageUi- render the System home page.SystemAdminPanelUi- render the System panel on the main Admin home page.
SystemAdminConfig
The configuration class: register a section callback for the System admin interface, and add a panel to the System home page. Registrations are held in the public static properties below.
Properties
| Property | Type | Description |
|---|---|---|
SystemAdminConfig::$sections | array | The registered section entries, each an object with urlName, buttonLabel and routeCallback. |
SystemAdminConfig::$panels | array | The registered home page panels, each an array with title and contentCallback. |
Panel
SystemAdminConfig::Panel(string $title, Callable $contentCallback): void
Add a panel to the home page of the System admin section.
| Name | Type | Description |
|---|---|---|
$title | string | The title of the panel. |
$contentCallback | Callable | Function that renders the panel content. |
Returns void
Section
SystemAdminConfig::Section(string $buttonLabel, string $urlName, callable|null $routeCallback): void
Register a section callback for the System admin interface. The callback renders the admin section UI and handles routing.
| Name | Type | Description |
|---|---|---|
$buttonLabel | string | The label for the link, for example Cache or Config. |
$urlName | string | The URL name for the section, for example cache or config. |
$routeCallback | callable|null | Function that renders the admin section UI. |
Returns void
SystemAdminUi
Renders the System admin section: sorts the registered sections by button label, and builds the navigation with a Home file and a directory per section.
Section
SystemAdminUi::Section(): void
Render the System admin navigation: the Home file and, for each registered section with a route callback, a directory entered under its own module name and base path.
Returns void
SystemAdminPageUi
Renders the System home page: the title, an introduction, and a grid of the panels that modules have registered.
Home
SystemAdminPageUi::Home(): void
Render the System home page, including a Modules section that lays out each registered panel in a grid.
Returns void
SystemAdminPanelUi
The panel that System contributes to the main Admin home page: a brief pointer into the System section, with a count of the installed system modules and a link to view them.
AdminHome
SystemAdminPanelUi::AdminHome(): void
Render the System panel for the main Admin home page: the number of installed system modules and a button to view the System section.
Returns void