[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/maximebf/debugbar/src/DebugBar/ -> DebugBar.php (summary)

(no description)

File Size: 497 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

DebugBar:: (29 methods):
  addCollector()
  hasCollector()
  getCollector()
  getCollectors()
  setRequestIdGenerator()
  getRequestIdGenerator()
  getCurrentRequestId()
  setStorage()
  getStorage()
  isDataPersisted()
  setHttpDriver()
  getHttpDriver()
  collect()
  getData()
  getDataAsHeaders()
  sendDataInHeaders()
  stackData()
  hasStackedData()
  getStackedData()
  setStackDataSessionNamespace()
  getStackDataSessionNamespace()
  setStackAlwaysUseSessionStorage()
  isStackAlwaysUseSessionStorage()
  initStackSession()
  getJavascriptRenderer()
  offsetSet()
  offsetGet()
  offsetExists()
  offsetUnset()


Class: DebugBar  - X-Ref

Main DebugBar object

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

<code>
$debugbar = new DebugBar();
$debugbar->addCollector(new DataCollector\MessagesCollector());
$debugbar['messages']->addMessage("foobar");
</code>
addCollector(DataCollectorInterface $collector)   X-Ref
Adds a data collector

param: DataCollectorInterface $collector
return: $this

hasCollector($name)   X-Ref
Checks if a data collector has been added

param: string $name
return: boolean

getCollector($name)   X-Ref
Returns a data collector

param: string $name
return: DataCollectorInterface

getCollectors()   X-Ref
Returns an array of all data collectors

return: array[DataCollectorInterface]

setRequestIdGenerator(RequestIdGeneratorInterface $generator)   X-Ref
Sets the request id generator

param: RequestIdGeneratorInterface $generator
return: $this

getRequestIdGenerator()   X-Ref

return: RequestIdGeneratorInterface

getCurrentRequestId()   X-Ref
Returns the id of the current request

return: string

setStorage(StorageInterface $storage = null)   X-Ref
Sets the storage backend to use to store the collected data

param: StorageInterface $storage
return: $this

getStorage()   X-Ref

return: StorageInterface

isDataPersisted()   X-Ref
Checks if the data will be persisted

return: boolean

setHttpDriver(HttpDriverInterface $driver)   X-Ref
Sets the HTTP driver

param: HttpDriverInterface $driver
return: $this

getHttpDriver()   X-Ref
Returns the HTTP driver

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

return: HttpDriverInterface

collect()   X-Ref
Collects the data from the collectors

return: array

getData()   X-Ref
Returns collected data

Will collect the data if none have been collected yet

return: array

getDataAsHeaders($headerName = 'phpdebugbar', $maxHeaderLength = 4096, $maxTotalHeaderLength = 250000)   X-Ref
Returns an array of HTTP headers containing the data

param: string $headerName
param: integer $maxHeaderLength
return: array

sendDataInHeaders($useOpenHandler = null, $headerName = 'phpdebugbar', $maxHeaderLength = 4096)   X-Ref
Sends the data through the HTTP headers

param: bool $useOpenHandler
param: string $headerName
param: integer $maxHeaderLength
return: $this

stackData()   X-Ref
Stacks the data in the session for later rendering


hasStackedData()   X-Ref
Checks if there is stacked data in the session

return: boolean

getStackedData($delete = true)   X-Ref
Returns the data stacked in the session

param: boolean $delete Whether to delete the data in the session
return: array

setStackDataSessionNamespace($ns)   X-Ref
Sets the key to use in the $_SESSION array

param: string $ns
return: $this

getStackDataSessionNamespace()   X-Ref
Returns the key used in the $_SESSION array

return: string

setStackAlwaysUseSessionStorage($enabled = true)   X-Ref
Sets whether to only use the session to store stacked data even
if a storage is enabled

param: boolean $enabled
return: $this

isStackAlwaysUseSessionStorage()   X-Ref
Checks if the session is always used to store stacked data
even if a storage is enabled

return: boolean

initStackSession()   X-Ref
Initializes the session for stacked data

return: HttpDriverInterface

getJavascriptRenderer($baseUrl = null, $basePath = null)   X-Ref
Returns a JavascriptRenderer for this instance

param: string $baseUrl
param: string $basePath
return: JavascriptRenderer

offsetSet($key, $value)   X-Ref
No description

offsetGet($key)   X-Ref
No description

offsetExists($key)   X-Ref
No description

offsetUnset($key)   X-Ref
No description



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer