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
Properties
- $collectors : array<int, class-string>
- -------------------------------------------------------------------------- Toolbar Collectors --------------------------------------------------------------------------
- $collectVarData : bool
- -------------------------------------------------------------------------- Collect Var Data --------------------------------------------------------------------------
- $maxHistory : int
- -------------------------------------------------------------------------- Max History --------------------------------------------------------------------------
- $maxQueries : int
- -------------------------------------------------------------------------- Max Queries --------------------------------------------------------------------------
- $viewsPath : string
- -------------------------------------------------------------------------- Toolbar Views Path --------------------------------------------------------------------------
- $watchedDirectories : array<int, string>
- -------------------------------------------------------------------------- Watched Directories --------------------------------------------------------------------------
- $watchedExtensions : array<int, string>
- -------------------------------------------------------------------------- Watched File Extensions --------------------------------------------------------------------------
Properties
$collectors
-------------------------------------------------------------------------- Toolbar Collectors --------------------------------------------------------------------------
public
array<int, class-string>
$collectors
= [
\CodeIgniter\Debug\Toolbar\Collectors\Timers::class,
\CodeIgniter\Debug\Toolbar\Collectors\Database::class,
\CodeIgniter\Debug\Toolbar\Collectors\Logs::class,
\CodeIgniter\Debug\Toolbar\Collectors\Views::class,
// \CodeIgniter\Debug\Toolbar\Collectors\Cache::class,
\CodeIgniter\Debug\Toolbar\Collectors\Files::class,
\CodeIgniter\Debug\Toolbar\Collectors\Routes::class,
\CodeIgniter\Debug\Toolbar\Collectors\Events::class,
]
List of toolbar collectors that will be called when Debug Toolbar fires up and collects data from.
$collectVarData
-------------------------------------------------------------------------- Collect Var Data --------------------------------------------------------------------------
public
bool
$collectVarData
= true
If set to false var data from the views will not be collected. Useful to avoid high memory usage when there are lots of data passed to the view.
$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.
$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.
$watchedDirectories
-------------------------------------------------------------------------- Watched Directories --------------------------------------------------------------------------
public
array<int, string>
$watchedDirectories
= ['app']
Contains an array of directories that will be watched for changes and used to determine if the hot-reload feature should reload the page or not. We restrict the values to keep performance as high as possible.
NOTE: The ROOTPATH will be prepended to all values.
$watchedExtensions
-------------------------------------------------------------------------- Watched File Extensions --------------------------------------------------------------------------
public
array<int, string>
$watchedExtensions
= ['php', 'css', 'js', 'html', 'svg', 'json', 'env']
Contains an array of file extensions that will be watched for changes and used to determine if the hot-reload feature should reload the page or not.