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\AdminConfig

Admin Config.

Summary

Methods
Properties
Constants
defaults()
setBasePath()
basePath()
setRoutes()
$routes
$handlers
$acl
DEFAULT_BASE_PATH
No protected methods found
No protected properties found
N/A
No private methods found
$basePath
N/A

Constants

DEFAULT_BASE_PATH

DEFAULT_BASE_PATH

Properties

$routes

$routes : array

Type

array

$handlers

$handlers : array

Type

array

$acl

$acl : array

Type

array

$basePath

$basePath : string

The base path for the admin module's route group.

Type

string

Methods

defaults()

defaults() : array

The default data is defined in a JSON file.

Returns

array

setBasePath()

setBasePath(string  $path) : \Charcoal\Admin\Config

Set the admin module's route group.

Parameters

string $path

The admin module base path.

Throws

\InvalidArgumentException

If the route group is invalid.

Returns

\Charcoal\Admin\Config —

Chainable

basePath()

basePath() : string

Retrieve the admin module's route group.

Returns

string

setRoutes()

setRoutes(array  $routes) : \Charcoal\Admin\Config

Parse the admin module's route configuration.

Parameters

array $routes

The route configuration structure to set.

Returns

\Charcoal\Admin\Config —

Chainable