Référence de la classe DebugBar

Graphe d'héritage de DebugBar:

Fonctions membres publiques
	addCollector (DataCollectorInterface $collector)
	hasCollector ($name)
	getCollector ($name)
	getCollectors ()
	setRequestIdGenerator (RequestIdGeneratorInterface $generator)
	getRequestIdGenerator ()
	getCurrentRequestId ()
	setStorage (StorageInterface $storage=null)
	getStorage ()
	isDataPersisted ()
	setHttpDriver (HttpDriverInterface $driver)
	getHttpDriver ()
	collect ()
	getData ()
	getDataAsHeaders ($headerName='phpdebugbar', $maxHeaderLength=4096, $maxTotalHeaderLength=250000)
	sendDataInHeaders ($useOpenHandler=null, $headerName='phpdebugbar', $maxHeaderLength=4096)
	stackData ()
	hasStackedData ()
	getStackedData ($delete=true)
	setStackDataSessionNamespace ($ns)
	getStackDataSessionNamespace ()
	setStackAlwaysUseSessionStorage ($enabled=true)
	isStackAlwaysUseSessionStorage ()
	getJavascriptRenderer ($baseUrl=null, $basePath=null)
	offsetSet ($key, $value)
	offsetGet ($key)
	offsetExists ($key)
	offsetUnset ($key)

Attributs publics statiques
static	$useOpenHandlerWhenSendingDataHeaders = false

Fonctions membres protégées
	initStackSession ()

Attributs protégés
	$collectors = array()
	$data
	$jsRenderer
	$requestIdGenerator
	$requestId
	$storage
	$httpDriver
	$stackSessionNamespace = 'PHPDEBUGBAR_STACK_DATA'
	$stackAlwaysUseSessionStorage = false

Description détaillée

Main DebugBar object

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

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

Documentation des fonctions membres

addCollector()

addCollector

(

DataCollectorInterface

$collector

)

Adds a data collector

Paramètres

DataCollectorInterface

$collector

Exceptions

DebugBarException

Renvoie

$this

Références $this, et DataCollectorInterface\getName().

collect()

collect

(

)

Collects the data from the collectors

Renvoie

array

Références $data, $item, $name, et null.

getCollector()

getCollector

(

$name

)

Returns a data collector

Paramètres

string

$name

Renvoie

DataCollectorInterface

Exceptions

DebugBarException

Références $name.

getCollectors()

getCollectors

(

)

Returns an array of all data collectors

Renvoie

array[DataCollectorInterface]

getCurrentRequestId()

getCurrentRequestId

(

)

Returns the id of the current request

Renvoie

string

Références null.

getData()

getData

(

)

Returns collected data

Will collect the data if none have been collected yet

Renvoie

array

Références $data, et null.

getDataAsHeaders()

getDataAsHeaders	(		$headerName = 'phpdebugbar',
			$maxHeaderLength = 4096,
			$maxTotalHeaderLength = 250000
	)

Returns an array of HTTP headers containing the data

Paramètres

string	$headerName
integer	$maxHeaderLength

Renvoie

array

Références $c, $data, $i, et $name.

getHttpDriver()

getHttpDriver

(

)

Returns the HTTP driver

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

Renvoie

HttpDriverInterface

Références null.

getJavascriptRenderer()

getJavascriptRenderer	(		$baseUrl = null,
			$basePath = null
	)

Returns a JavascriptRenderer for this instance

Paramètres

string	$baseUrl
string	$basePath

Renvoie

JavascriptRenderer

Références $basePath, $this, et null.

getRequestIdGenerator()

getRequestIdGenerator

(

)

Renvoie

RequestIdGeneratorInterface

Références null.

getStackDataSessionNamespace()

getStackDataSessionNamespace

(

)

Returns the key used in the $_SESSION array

Renvoie

string

getStackedData()

getStackedData

(

$delete = true

)

Returns the data stacked in the session

Paramètres

boolean

$delete

Whether to delete the data in the session

Renvoie

array

Références $data, et $id.

getStorage()

getStorage

(

)

Renvoie

StorageInterface

hasCollector()

hasCollector

(

$name

)

Checks if a data collector has been added

Paramètres

string

$name

Renvoie

boolean

Références $name.

hasStackedData()

hasStackedData

(

)

Checks if there is stacked data in the session

Renvoie

boolean

Références $this.

initStackSession()

initStackSession ( )

protected

Initializes the session for stacked data

Renvoie

HttpDriverInterface

Exceptions

DebugBarException

Références $this.

isDataPersisted()

isDataPersisted

(

)

Checks if the data will be persisted

Renvoie

boolean

Références null.

Référencé par OpenHandler\__construct().

isStackAlwaysUseSessionStorage()

isStackAlwaysUseSessionStorage

(

)

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

Renvoie

boolean

offsetExists()

offsetExists

(

$key

)

Références $key.

offsetGet()

offsetGet

(

$key

)

Références $key.

offsetSet()

offsetSet	(		$key,
			$value
	)

offsetUnset()

offsetUnset

(

$key

)

sendDataInHeaders()

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

Sends the data through the HTTP headers

Paramètres

bool	$useOpenHandler
string	$headerName
integer	$maxHeaderLength

Renvoie

$this

Références $this, et null.

setHttpDriver()

setHttpDriver

(

HttpDriverInterface

$driver

)

Sets the HTTP driver

Paramètres

HttpDriverInterface

$driver

Renvoie

$this

Références $this.

setRequestIdGenerator()

setRequestIdGenerator

(

RequestIdGeneratorInterface

$generator

)

Sets the request id generator

Paramètres

RequestIdGeneratorInterface

$generator

Renvoie

$this

Références $this.

setStackAlwaysUseSessionStorage()

setStackAlwaysUseSessionStorage

(

$enabled = true

)

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

Paramètres

boolean

$enabled

Renvoie

$this

Références $enabled, et $this.

setStackDataSessionNamespace()

setStackDataSessionNamespace

(

$ns

)

Sets the key to use in the $_SESSION array

Paramètres

string

$ns

Renvoie

$this

Références $this.

setStorage()

setStorage

(

StorageInterface

$storage = null

)

Sets the storage backend to use to store the collected data

Paramètres

StorageInterface

$storage

Renvoie

$this

Références $this.

stackData()

stackData

(

)

Stacks the data in the session for later rendering

Références $data, $this, elseif, et null.

Documentation des champs

$collectors

$collectors = array()

protected

$data

$data

protected

$httpDriver

$httpDriver

protected

$jsRenderer

$jsRenderer

protected

$requestId

$requestId

protected

$requestIdGenerator

$requestIdGenerator

protected

$stackAlwaysUseSessionStorage

$stackAlwaysUseSessionStorage = false

protected

$stackSessionNamespace

$stackSessionNamespace = 'PHPDEBUGBAR_STACK_DATA'

protected

$storage

$storage

protected

$useOpenHandlerWhenSendingDataHeaders

$useOpenHandlerWhenSendingDataHeaders = false

static

---

La documentation de cette classe a été générée à partir du fichier suivant :

• DebugBar.php