setDependencies()

setDependencies(\Pimple\Container  $container) : void

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

Parameters

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

Returns

setIdent()

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

Parameters

Returns

Chainable

ident()

ident() : string

Returns

setLabel()

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

Parameters

Returns

Chainable

label()

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

Returns

setTitle()

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

Set the title of the page.

Parameters

Returns

Chainable

title()

title() : string|null

Retrieve the title of the page.

Returns

setSubtitle()

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

Set the page's sub-title.

Parameters

Returns

Chainable

subtitle()

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

Retrieve the page's sub-title.

Returns

setShowTopHeaderMenu()

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

Display or not the top right header menu.

Parameters

Returns

Chainable.

showTopHeaderMenu()

showTopHeaderMenu() : boolean

Returns

Show the top header menu or not.

setTopHeaderMenu()

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

Sets the top right header menu.

Parameters

Returns

Chainable.

topHeaderMenu()

topHeaderMenu() : array

Header menu links and labels.

Returns

The menu.

setShowHeaderMenu()

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

Parameters

Returns

Chainable

showHeaderMenu()

showHeaderMenu() : boolean

Returns

headerMenu()

headerMenu() : array

Returns

setShowFooterMenu()

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

Parameters

Returns

Chainable

showFooterMenu()

showFooterMenu() : boolean

Returns

footerMenu()

footerMenu() : array

Returns

setShowSidemenu()

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

Parameters

Returns

Chainable

showSidemenu()

showSidemenu() : boolean

Returns

sidemenu()

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

Retrieve the sidemenu.

Returns

isAuthenticated()

isAuthenticated() : boolean

Determine if the current user is authenticated.

Returns

getAuthenticatedUser()

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

Retrieve the currently authenticated user.

Returns

adminUrl()

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

Retrieve the base URI of the administration area.

Returns

setBaseUrl()

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

Set the base URI of the application.

Parameters

Returns

baseUrl()

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

Retrieve the base URI of the application.

Returns

headerMenuLogo()

headerMenuLogo() : string

Returns

siteName()

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

Retrieve the name of the project.

Returns

documentTitle()

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

Retrieve the document title.

Returns

devMode()

devMode() : boolean

Application Debug Mode.

Returns

lang()

lang() : string

Retrieve the current language.

Returns

locale()

locale() : string

Retrieve the current language.

Returns

recaptchaKey()

recaptchaKey() : string

Returns

hasFeedbacks()

hasFeedbacks() : boolean

Determine if there's feedback.

Returns

numFeedbacks()

numFeedbacks() : integer

Count feedback.

Returns

feedbacks()

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

Retrieve the feedback collection.

Optionally retrieve only the feedback for the given level.

Parameters

Throws

\InvalidArgumentException

If the feedback level is invalid.

Returns

addFeedback()

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

Add feedback.

Parameters

Returns

Chainable

clearFeedback()

clearFeedback() : \Charcoal\Admin\Ui\FeedbackContainerTrait

Remove all feedback from collection.

Returns

Chainable

setModelFactory()

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

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

Parameters

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Throws

\Exception

If the factory is not set.

Returns

The model factory.

createHeaderMenu()

createHeaderMenu(mixed  $options = null) : array

Parameters

Throws

\InvalidArgumentException

If the menu is missing, invalid, or malformed.

Returns

createSidemenu()

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

Parameters

Throws

\InvalidArgumentException

If the sidemenu widget is invalid.

Returns

authRequired()

authRequired() : boolean

Help 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

setSiteName()

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

Set the name of the project.

Parameters

Returns

Chainable

setWidgetFactory()

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

Parameters

widgetFactory()

widgetFactory() : \Charcoal\Factory\FactoryInterface

Throws

\Exception

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

Returns

resolveFeedbackLevel()

resolveFeedbackLevel(string  $level) : string

Resolve the given feedback level.

Parameters

Returns

The level.