Toolbar
extends BaseConfig
in package
-------------------------------------------------------------------------- Debug Toolbar --------------------------------------------------------------------------
The Debug Toolbar provides a way to see information about the performance
and state of your application during that page display. By default it will
NOT be displayed under production environments, and will only display if
CI_DEBUG is true, since if it's not, there's not much to display anyway.
Table of Contents
- $collectors : array<string|int, string>
- -------------------------------------------------------------------------- Toolbar Collectors --------------------------------------------------------------------------
- $maxHistory : int
- -------------------------------------------------------------------------- Max History --------------------------------------------------------------------------
- $maxQueries : int
- -------------------------------------------------------------------------- Max Queries --------------------------------------------------------------------------
- $registrars : array<string|int, mixed>
- An optional array of classes that will act as Registrars for rapidly setting config class properties.
- $viewsPath : string
- -------------------------------------------------------------------------- Toolbar Views Path --------------------------------------------------------------------------
- $didDiscovery : bool
- Has module discovery happened yet?
- $moduleConfig : Modules
- The modules configuration.
- __construct() : mixed
- Will attempt to get environment variables with names that match the properties of the child class.
- getEnvValue() : mixed
- Retrieve an environment-specific configuration setting
- initEnvValue() : mixed
- Initialization an environment-specific configuration setting
- registerProperties() : mixed
- Provides external libraries a simple way to register one or more options into a config file.
Properties
$collectors
-------------------------------------------------------------------------- Toolbar Collectors --------------------------------------------------------------------------
public
array<string|int, string>
$collectors
= [
CodeIgniterDebugToolbarCollectorsTimers::class,
CodeIgniterDebugToolbarCollectorsDatabase::class,
CodeIgniterDebugToolbarCollectorsLogs::class,
CodeIgniterDebugToolbarCollectorsViews::class,
// CodeIgniterDebugToolbarCollectorsCache::class,
CodeIgniterDebugToolbarCollectorsFiles::class,
CodeIgniterDebugToolbarCollectorsRoutes::class,
CodeIgniterDebugToolbarCollectorsEvents::class,
]
List of toolbar collectors that will be called when Debug Toolbar fires up and collects data from.
$maxHistory
-------------------------------------------------------------------------- Max History --------------------------------------------------------------------------
public
int
$maxHistory
= 20
$maxHistory sets a limit on the number of past requests that are stored,
helping to conserve file space used to store them. You can set it to
0 (zero) to not have any history stored, or -1 for unlimited history.
$maxQueries
-------------------------------------------------------------------------- Max Queries --------------------------------------------------------------------------
public
int
$maxQueries
= 100
If the Database Collector is enabled, it will log every query that the the system generates so they can be displayed on the toolbar's timeline and in the query log. This can lead to memory issues in some instances with hundreds of queries.
$maxQueries defines the maximum amount of queries that will be stored.
$registrars
An optional array of classes that will act as Registrars for rapidly setting config class properties.
public
static array<string|int, mixed>
$registrars
= []
$viewsPath
-------------------------------------------------------------------------- Toolbar Views Path --------------------------------------------------------------------------
public
string
$viewsPath
= SYSTEMPATH . 'Debug/Toolbar/Views/'
The full path to the the views that are used by the toolbar. This MUST have a trailing slash.
$didDiscovery
Has module discovery happened yet?
protected
static bool
$didDiscovery
= false
$moduleConfig
The modules configuration.
protected
static Modules
$moduleConfig
Methods
__construct()
Will attempt to get environment variables with names that match the properties of the child class.
public
__construct() : mixed
The "shortPrefix" is the lowercase-only config class name.
Return values
mixed —getEnvValue()
Retrieve an environment-specific configuration setting
protected
getEnvValue(string $property, string $prefix, string $shortPrefix) : mixed
Parameters
- $property : string
- $prefix : string
- $shortPrefix : string
Return values
mixed —initEnvValue()
Initialization an environment-specific configuration setting
protected
initEnvValue(mixed &$property, string $name, string $prefix, string $shortPrefix) : mixed
Parameters
- $property : mixed
- $name : string
- $prefix : string
- $shortPrefix : string
Return values
mixed —registerProperties()
Provides external libraries a simple way to register one or more options into a config file.
protected
registerProperties() : mixed