API Documentation
\
Charcoal
Admin
Action
Account
Object
System
Widget
Table
Object
Property
Display
Input
Selectize
Script
Notification
Object
Table
Translation
User
AclRole
Service
ServiceProvider
Template
Account
Object
System
Ui
Sidemenu
User
Widget
Dialog
FormGroup
Graph

\Charcoal\Admin\TemplateHandlerTemplate

Admin Error Handler Template

Available (mustache) methods

  • title (Translation) - The page title
  • subtitle (Translation) The page subtitle
  • showHeaderMenu (bool) - Display the header menu or not
  • headerMenu (iterator) - The header menu data
  • showFooterMenu (bool) - Display the footer menu or not
  • footerMenu (iterator) - The footer menu data

Summary

Methods
Properties
Constants
setDependencies()
init()
setIdent()
ident()
setLabel()
label()
setTitle()
title()
setSubtitle()
subtitle()
setShowTopHeaderMenu()
showTopHeaderMenu()
setTopHeaderMenu()
topHeaderMenu()
setShowHeaderMenu()
showHeaderMenu()
headerMenu()
setShowFooterMenu()
showFooterMenu()
footerMenu()
setShowSidemenu()
showSidemenu()
sidemenu()
isAuthenticated()
getAuthenticatedUser()
adminUrl()
setBaseUrl()
baseUrl()
headerMenuLogo()
siteName()
documentTitle()
devMode()
lang()
locale()
recaptchaKey()
hasFeedbacks()
numFeedbacks()
feedbacks()
addFeedback()
clearFeedback()
setErrorMessage()
errorMessage()
setErrorTitle()
errorTitle()
No public properties found
No constants found
setModelFactory()
modelFactory()
createHeaderMenu()
createSidemenu()
authRequired()
setSiteName()
setWidgetFactory()
widgetFactory()
resolveFeedbackLevel()
$baseUrl
$adminConfig
$appConfig
$label
$title
$subtitle
$headerMenu
$sidemenu
$feedbacks
N/A
No private methods found
$siteName
$ident
$showSidemenu
$showHeaderMenu
$showFooterMenu
$showTopHeaderMenu
$modelFactory
$widgetFactory
$errorTitle
$errorMessage
N/A

Properties

$baseUrl

$baseUrl : \Psr\Http\Message\UriInterface

The base URI.

Type

\Psr\Http\Message\UriInterface

$adminConfig

$adminConfig : \Charcoal\Admin\Config

Store a reference to the admin configuration.

Type

\Charcoal\Admin\Config

$appConfig

$appConfig : \Charcoal\App\Config

Store a reference to the application configuration.

Type

\Charcoal\App\Config

$label

$label : \Charcoal\Translator\Translation|string|null

Type

\Charcoal\Translator\Translation|string|null

$title

$title : \Charcoal\Translator\Translation|string|null

Type

\Charcoal\Translator\Translation|string|null

$subtitle

$subtitle : \Charcoal\Translator\Translation|string|null

Type

\Charcoal\Translator\Translation|string|null

$headerMenu

$headerMenu : boolean

Type

boolean

$sidemenu

$sidemenu : \Charcoal\Admin\SideMenuWidgetInterface

Type

\Charcoal\Admin\SideMenuWidgetInterface

$feedbacks

$feedbacks : array

Collection of feedback.

Type

array

$siteName

$siteName : \Charcoal\Translator\Translation|string|null

The name of the project.

Type

\Charcoal\Translator\Translation|string|null

$ident

$ident : string

Type

string

$showSidemenu

$showSidemenu : boolean

Type

boolean

$showHeaderMenu

$showHeaderMenu : boolean

Type

boolean

$showFooterMenu

$showFooterMenu : boolean

Type

boolean

$showTopHeaderMenu

$showTopHeaderMenu : boolean

Type

boolean

$modelFactory

$modelFactory : \Charcoal\Factory\FactoryInterface

Type

\Charcoal\Factory\FactoryInterface

$widgetFactory

$widgetFactory : \Charcoal\Factory\FactoryInterface

Type

\Charcoal\Factory\FactoryInterface

$errorTitle

$errorTitle : \Charcoal\Admin\Template\Translation|string|null

The current error title.

Type

\Charcoal\Admin\Template\Translation|string|null

$errorMessage

$errorMessage : \Charcoal\Admin\Template\Translation|string|null

The current error message.

Type

\Charcoal\Admin\Template\Translation|string|null

Methods

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Set common dependencies (services) used in all admin templates.

Parameters

\Pimple\Container $container

DI Container.

init()

init(\Psr\Http\Message\RequestInterface  $request) : boolean

Template's init method is called automatically from `charcoal-app`'s Template Route.

For admin templates, initializations is:

  • to start a session, if necessary
  • to authenticate
  • to initialize the template data with $_GET

Parameters

\Psr\Http\Message\RequestInterface $request

The request to initialize.

Returns

boolean

setIdent()

setIdent(mixed  $ident) : \Charcoal\Admin\AdminTemplate

Parameters

mixed $ident

Template identifier.

Returns

\Charcoal\Admin\AdminTemplate —

Chainable

ident()

ident() : string

Returns

string

setLabel()

setLabel(mixed  $label) : \Charcoal\Admin\AdminTemplate

Parameters

mixed $label

Template label.

Returns

\Charcoal\Admin\AdminTemplate —

Chainable

label()

label() : \Charcoal\Translator\Translation|string|null

Returns

\Charcoal\Translator\Translation|string|null

setTitle()

setTitle(mixed  $title) : \Charcoal\Admin\AdminTemplate

Set the title of the page.

Parameters

mixed $title

Template title.

Returns

\Charcoal\Admin\AdminTemplate —

Chainable

title()

title() : \Charcoal\Admin\Template\Translation|string|null

Retrieve the title of the page.

Returns

\Charcoal\Admin\Template\Translation|string|null

setSubtitle()

setSubtitle(mixed  $subtitle) : \Charcoal\Admin\AdminTemplate

Set the page's sub-title.

Parameters

mixed $subtitle

Template subtitle.

Returns

\Charcoal\Admin\AdminTemplate —

Chainable

subtitle()

subtitle() : \Charcoal\Translator\Translation|string|null

Retrieve the page's sub-title.

Returns

\Charcoal\Translator\Translation|string|null

setShowTopHeaderMenu()

setShowTopHeaderMenu(boolean  $bool) : \Charcoal\Admin\AdminTemplate

Display or not the top right header menu.

Parameters

boolean $bool

Display or not.

Returns

\Charcoal\Admin\AdminTemplate —

Chainable.

showTopHeaderMenu()

showTopHeaderMenu() : boolean

Returns

boolean —

Show the top header menu or not.

setTopHeaderMenu()

setTopHeaderMenu(array  $menu) : \Charcoal\Admin\AdminTemplate

Sets the top right header menu.

Parameters

array $menu

Menu as link and labels.

Returns

\Charcoal\Admin\AdminTemplate —

Chainable.

topHeaderMenu()

topHeaderMenu() : array

Header menu links and labels.

Returns

array —

The menu.

setShowHeaderMenu()

setShowHeaderMenu(boolean  $show) : \Charcoal\Admin\AdminTemplate

Parameters

boolean $show

The show header menu flag.

Returns

\Charcoal\Admin\AdminTemplate —

Chainable

showHeaderMenu()

showHeaderMenu() : boolean

Returns

boolean

headerMenu()

headerMenu() : array

Returns

array

setShowFooterMenu()

setShowFooterMenu(boolean  $show) : \Charcoal\Admin\AdminTemplate

Parameters

boolean $show

The show footer menu flag.

Returns

\Charcoal\Admin\AdminTemplate —

Chainable

showFooterMenu()

showFooterMenu() : boolean

Returns

boolean

footerMenu()

footerMenu() : array

Returns

array

setShowSidemenu()

setShowSidemenu(boolean  $show) : \Charcoal\Admin\AdminTemplate

Parameters

boolean $show

The show sidemenu flag.

Returns

\Charcoal\Admin\AdminTemplate —

Chainable

showSidemenu()

showSidemenu() : boolean

Returns

boolean

sidemenu()

sidemenu() : \Charcoal\Admin\SidemenuWidgetInterface|null

Retrieve the sidemenu.

Returns

\Charcoal\Admin\SidemenuWidgetInterface|null

isAuthenticated()

isAuthenticated() : boolean

Determine if the current user is authenticated.

Returns

boolean

getAuthenticatedUser()

getAuthenticatedUser() : \Charcoal\User\UserInterface|null

Retrieve the currently authenticated user.

Returns

\Charcoal\User\UserInterface|null

adminUrl()

adminUrl() : \Psr\Http\Message\UriInterface|string

Retrieve the base URI of the administration area.

Returns

\Psr\Http\Message\UriInterface|string

setBaseUrl()

setBaseUrl(\Psr\Http\Message\UriInterface|string  $uri) : self

Set the base URI of the application.

Parameters

\Psr\Http\Message\UriInterface|string $uri

The base URI.

Returns

self

baseUrl()

baseUrl() : \Psr\Http\Message\UriInterface|string

Retrieve the base URI of the application.

Returns

\Psr\Http\Message\UriInterface|string

headerMenuLogo()

headerMenuLogo() : string

Returns

string

siteName()

siteName() : \Charcoal\Translator\Translation|string|null

Retrieve the name of the project.

Returns

\Charcoal\Translator\Translation|string|null

documentTitle()

documentTitle() : \Charcoal\Translator\Translation|string|null

Retrieve the document title.

Returns

\Charcoal\Translator\Translation|string|null

devMode()

devMode() : boolean

Application Debug Mode.

Returns

boolean

lang()

lang() : string

Retrieve the current language.

Returns

string

locale()

locale() : string

Retrieve the current language.

Returns

string

recaptchaKey()

recaptchaKey() : string

Returns

string

hasFeedbacks()

hasFeedbacks() : boolean

Determine if there's feedback.

Returns

boolean

numFeedbacks()

numFeedbacks() : integer

Count feedback.

Returns

integer

feedbacks()

feedbacks(string|null  $level = null) : array

Retrieve the feedback collection.

Optionally retrieve only the feedback for the given level.

Parameters

string|null $level

Optional level to filter collection.

Throws

\InvalidArgumentException

If the feedback level is invalid.

Returns

array

addFeedback()

addFeedback(string  $level, mixed  $message) : \Charcoal\Admin\Ui\FeedbackContainerTrait

Add feedback.

Parameters

string $level

The feedback level.
mixed $message

The feedback message.

Returns

\Charcoal\Admin\Ui\FeedbackContainerTrait —

Chainable

setErrorMessage()

setErrorMessage(mixed  $message) : self

Set the handler's error message.

Parameters

mixed $message

The error message.

Returns

self

errorMessage()

errorMessage() : \Charcoal\Admin\Template\Translation|string|null

Retrieve the error message.

Returns

\Charcoal\Admin\Template\Translation|string|null

setErrorTitle()

setErrorTitle(mixed  $title) : self

Set the handler's error title.

Parameters

mixed $title

The error title.

Returns

self

errorTitle()

errorTitle() : \Charcoal\Admin\Template\Translation|string|null

Retrieve the error title.

Returns

\Charcoal\Admin\Template\Translation|string|null

setModelFactory()

setModelFactory(\Charcoal\Factory\FactoryInterface  $factory) : void

As a convenience, all admin templates have a model factory to easily create objects.

Parameters

\Charcoal\Factory\FactoryInterface $factory

The factory used to create models.

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Throws

\Exception

If the factory is not set.

Returns

\Charcoal\Factory\FactoryInterface —

The model factory.

createHeaderMenu()

createHeaderMenu(mixed  $options = null) : array

Parameters

mixed $options

The sidemenu widget ID or config.

Throws

\InvalidArgumentException

If the menu is missing, invalid, or malformed.

Returns

array

createSidemenu()

createSidemenu(mixed  $options = null) : \Charcoal\Admin\SidemenuWidgetInterface|null

Parameters

mixed $options

The sidemenu widget ID or config.

Throws

\InvalidArgumentException

If the sidemenu widget is invalid.

Returns

\Charcoal\Admin\SidemenuWidgetInterface|null

authRequired()

authRequired() : boolean

Error handler response is available to all users, no login required.

Authentication is required by default. If unnecessary, replace this method in the inherited template class.

For example, the "Login" / "Reset Password" templates should return false.

Returns

boolean

setSiteName()

setSiteName(string  $name) : \Charcoal\Admin\AdminTemplate

Set the name of the project.

Parameters

string $name

Name of the project.

Returns

\Charcoal\Admin\AdminTemplate —

Chainable

setWidgetFactory()

setWidgetFactory(\Charcoal\Factory\FactoryInterface  $factory) : void

Parameters

\Charcoal\Factory\FactoryInterface $factory

The widget factory, to create the dashboard and sidemenu widgets.

widgetFactory()

widgetFactory() : \Charcoal\Factory\FactoryInterface

Throws

\Exception

If the widget factory dependency was not previously set / injected.

Returns

\Charcoal\Factory\FactoryInterface

resolveFeedbackLevel()

resolveFeedbackLevel(string  $level) : string

Resolve the given feedback level.

Parameters

string $level

The feedback level.

Returns

string —

The level.