API Documentation
\
Composer
Autoload
Controllers
Admin
Core
core
DebugBar
Bridge
SwiftMailer
Twig
DataCollector
PDO
DataFormatter
Storage
Helpers
lib
Lib
Models
PHPThumb
Plugins
Tests
Psr
Log
Test
Symfony
Component
HttpFoundation
File
Exception
MimeType
Session
Attribute
Flash
Storage
Handler
Proxy
Tests
File
MimeType
Session
Attribute
Flash
Storage
Handler
Proxy
VarDumper
Caster
Cloner
Dumper
Exception
Test
Tests
Caster
Fixture
Test

\DebugBarStandardDebugBar

Debug bar subclass which adds all included collectors

Manages data collectors. DebugBar provides an array-like access to collectors by name.

$debugbar = new DebugBar(); $debugbar->addCollector(new DataCollector\MessagesCollector()); $debugbar['messages']->addMessage("foobar");

Summary

Methods
Properties
Constants
addCollector()
hasCollector()
getCollector()
getCollectors()
setRequestIdGenerator()
getRequestIdGenerator()
getCurrentRequestId()
setStorage()
getStorage()
isDataPersisted()
setHttpDriver()
getHttpDriver()
collect()
getData()
getDataAsHeaders()
sendDataInHeaders()
stackData()
hasStackedData()
getStackedData()
setStackDataSessionNamespace()
getStackDataSessionNamespace()
setStackAlwaysUseSessionStorage()
isStackAlwaysUseSessionStorage()
getJavascriptRenderer()
offsetSet()
offsetGet()
offsetExists()
offsetUnset()
__construct()
$useOpenHandlerWhenSendingDataHeaders
No constants found
initStackSession()
$collectors
$data
$jsRenderer
$requestIdGenerator
$requestId
$storage
$httpDriver
$stackSessionNamespace
$stackAlwaysUseSessionStorage
N/A
No private methods found
No private properties found
N/A

Properties

$useOpenHandlerWhenSendingDataHeaders

$useOpenHandlerWhenSendingDataHeaders :

Type

$collectors

$collectors :

Type

$data

$data :

Type

$jsRenderer

$jsRenderer :

Type

$requestIdGenerator

$requestIdGenerator :

Type

$requestId

$requestId :

Type

$storage

$storage :

Type

$httpDriver

$httpDriver :

Type

$stackSessionNamespace

$stackSessionNamespace :

Type

$stackAlwaysUseSessionStorage

$stackAlwaysUseSessionStorage :

Type

Methods

addCollector()

addCollector(\DebugBar\DataCollector\DataCollectorInterface  $collector) : $this

Adds a data collector

Parameters

\DebugBar\DataCollector\DataCollectorInterface $collector

Throws

\DebugBar\DebugBarException

Returns

$this

hasCollector()

hasCollector(string  $name) : boolean

Checks if a data collector has been added

Parameters

string $name

Returns

boolean

getCollectors()

getCollectors() : \DebugBar\array[DataCollectorInterface]

Returns an array of all data collectors

Returns

\DebugBar\array[DataCollectorInterface]

setRequestIdGenerator()

setRequestIdGenerator(\DebugBar\RequestIdGeneratorInterface  $generator)

Sets the request id generator

Parameters

\DebugBar\RequestIdGeneratorInterface $generator

getCurrentRequestId()

getCurrentRequestId() : string

Returns the id of the current request

Returns

string

setStorage()

setStorage(\DebugBar\Storage\StorageInterface  $storage = null)

Sets the storage backend to use to store the collected data

Parameters

\DebugBar\Storage\StorageInterface $storage

isDataPersisted()

isDataPersisted() : boolean

Checks if the data will be persisted

Returns

boolean

getHttpDriver()

getHttpDriver() : \DebugBar\HttpDriverInterface

Returns the HTTP driver

If no http driver where defined, a PhpHttpDriver is automatically created

Returns

\DebugBar\HttpDriverInterface

collect()

collect() : array

Collects the data from the collectors

Returns

array

getData()

getData() : array

Returns collected data

Will collect the data if none have been collected yet

Returns

array

getDataAsHeaders()

getDataAsHeaders(string  $headerName = 'phpdebugbar', integer  $maxHeaderLength = 4096,   $maxTotalHeaderLength = 250000) : array

Returns an array of HTTP headers containing the data

Parameters

string $headerName
integer $maxHeaderLength
$maxTotalHeaderLength

Returns

array

sendDataInHeaders()

sendDataInHeaders(boolean  $useOpenHandler = null, string  $headerName = 'phpdebugbar', integer  $maxHeaderLength = 4096)

Sends the data through the HTTP headers

Parameters

boolean $useOpenHandler
string $headerName
integer $maxHeaderLength

stackData()

stackData()

Stacks the data in the session for later rendering

hasStackedData()

hasStackedData() : boolean

Checks if there is stacked data in the session

Returns

boolean

getStackedData()

getStackedData(boolean  $delete = true) : array

Returns the data stacked in the session

Parameters

boolean $delete

Whether to delete the data in the session

Returns

array

setStackDataSessionNamespace()

setStackDataSessionNamespace(string  $ns)

Sets the key to use in the $_SESSION array

Parameters

string $ns

getStackDataSessionNamespace()

getStackDataSessionNamespace() : string

Returns the key used in the $_SESSION array

Returns

string

setStackAlwaysUseSessionStorage()

setStackAlwaysUseSessionStorage(boolean  $enabled = true)

Sets whether to only use the session to store stacked data even if a storage is enabled

Parameters

boolean $enabled

isStackAlwaysUseSessionStorage()

isStackAlwaysUseSessionStorage() : boolean

Checks if the session is always used to store stacked data even if a storage is enabled

Returns

boolean

getJavascriptRenderer()

getJavascriptRenderer(string  $baseUrl = null,   $basePath = null) : \DebugBar\JavascriptRenderer

Returns a JavascriptRenderer for this instance

Parameters

string $baseUrl
$basePath

Returns

\DebugBar\JavascriptRenderer

offsetSet()

offsetSet(  $key,   $value)

Parameters

$key
$value

offsetGet()

offsetGet(  $key)

Parameters

$key

offsetExists()

offsetExists(  $key)

Parameters

$key

offsetUnset()

offsetUnset(  $key)

Parameters

$key

__construct()

__construct()

initStackSession()

initStackSession() : \DebugBar\HttpDriverInterface

Initializes the session for stacked data

Returns

\DebugBar\HttpDriverInterface