$baseUrl
$baseUrl : \Psr\Http\Message\UriInterface
The base URI.
Base class for all `admin` Templates.
title
(Translation) - The page titlesubtitle
(Translation) The page subtitleshowHeaderMenu
(bool) - Display the header menu or notheaderMenu
(iterator) - The header menu datashowFooterMenu
(bool) - Display the footer menu or notfooterMenu
(iterator) - The footer menu data$adminConfig : \Charcoal\Admin\Config
Store a reference to the admin configuration.
init(\Psr\Http\Message\RequestInterface $request) : boolean
Retrieve options from Request's parameters (GET).
For admin templates, initializations is:
$_GET
\Psr\Http\Message\RequestInterface | $request | The PSR7 request. |
setIdent(mixed $ident) : \Charcoal\Admin\AdminTemplate
mixed | $ident | Template identifier. |
Chainable
setLabel(mixed $label) : \Charcoal\Admin\AdminTemplate
mixed | $label | Template label. |
Chainable
setTitle(mixed $title) : \Charcoal\Admin\AdminTemplate
Set the title of the page.
mixed | $title | Template title. |
Chainable
setSubtitle(mixed $subtitle) : \Charcoal\Admin\AdminTemplate
Set the page's sub-title.
mixed | $subtitle | Template subtitle. |
Chainable
setShowTopHeaderMenu(boolean $bool) : \Charcoal\Admin\AdminTemplate
Display or not the top right header menu.
boolean | $bool | Display or not. |
Chainable.
setTopHeaderMenu(array $menu) : \Charcoal\Admin\AdminTemplate
Sets the top right header menu.
array | $menu | Menu as link and labels. |
Chainable.
setShowHeaderMenu(boolean $show) : \Charcoal\Admin\AdminTemplate
boolean | $show | The show header menu flag. |
Chainable
setShowFooterMenu(boolean $show) : \Charcoal\Admin\AdminTemplate
boolean | $show | The show footer menu flag. |
Chainable
setShowSidemenu(boolean $show) : \Charcoal\Admin\AdminTemplate
boolean | $show | The show sidemenu flag. |
Chainable
addFeedback(string $level, mixed $message) : \Charcoal\Admin\Ui\FeedbackContainerTrait
Add feedback.
string | $level | The feedback level. |
mixed | $message | The feedback message. |
Chainable
clearFeedback() : \Charcoal\Admin\Ui\FeedbackContainerTrait
Remove all feedback from collection.
Chainable
addLocalization(string $ident, mixed $translations) : self
Add a custom localization message.
string | $ident | The message ID. |
mixed | $translations | The message translations. |
If the message ID is not a string or the translations are invalid.
localization(string $ident) : \Charcoal\Translator\Translation|string|null
Retrieve the translations for the given message ID.
string | $ident | The message ID to lookup. |
If the message ID is not a string.
setSiteName(string $name) : \Charcoal\Admin\AdminTemplate
Set the name of the project.
string | $name | Name of the project. |
Chainable