\DebugBarJavascriptRenderer

__construct()

__construct(\DebugBar\DebugBar  $debugBar, string  $baseUrl = null, string  $basePath = null) 

Parameters

setOptions()

setOptions(array  $options) 

Sets options from an array

Options:

• base_path
• base_url
• include_vendors
• javascript_class
• variable_name
• initialization
• enable_jquery_noconflict
• controls
• disable_controls
• ignore_collectors
• ajax_handler_classname
• ajax_handler_bind_to_jquery
• open_handler_classname
• open_handler_url

Parameters

setBasePath()

setBasePath(string  $path) 

Sets the path which assets are relative to

Parameters

getBasePath()

getBasePath() : string

Returns the path which assets are relative to

Returns

setBaseUrl()

setBaseUrl(string  $url) 

Sets the base URL from which assets will be served

Parameters

getBaseUrl()

getBaseUrl() : string

Returns the base URL from which assets will be served

Returns

setIncludeVendors()

setIncludeVendors(boolean  $enabled = true) 

Whether to include vendor assets

You can only include js or css vendors using setIncludeVendors('css') or setIncludeVendors('js')

Parameters

areVendorsIncluded()

areVendorsIncluded() : boolean

Checks if vendors assets are included

Returns

disableVendor()

disableVendor(string  $name) : void

Disable a specific vendor's assets.

Parameters

setJavascriptClass()

setJavascriptClass(string  $className) 

Sets the javascript class name

Parameters

getJavascriptClass()

getJavascriptClass() : string

Returns the javascript class name

Returns

setVariableName()

setVariableName(string  $name) 

Sets the variable name of the class instance

Parameters

getVariableName()

getVariableName() : string

Returns the variable name of the class instance

Returns

setInitialization()

setInitialization(integer  $init) 

Sets what should be initialized

• INITIALIZE_CONSTRUCTOR: only initializes the instance
  • INITIALIZE_CONTROLS: initializes the controls and data mapping
  • INITIALIZE_CONSTRUCTOR | INITIALIZE_CONTROLS: initialize everything (default)

Parameters

getInitialization()

getInitialization() : integer

Returns what should be initialized

Returns

setEnableJqueryNoConflict()

setEnableJqueryNoConflict(boolean  $enabled = true) 

Sets whether to call jQuery.noConflict()

Parameters

isJqueryNoConflictEnabled()

isJqueryNoConflictEnabled() : boolean

Checks if jQuery.noConflict() will be called

Returns

setUseRequireJs()

setUseRequireJs(boolean  $enabled = true) : $this

Sets whether to use RequireJS or not

Parameters

Returns

isRequireJsUsed()

isRequireJsUsed() : boolean

Checks if RequireJS is used

Returns

addControl()

addControl(string  $name, array  $options) 

Adds a control to initialize

Possible options:

• icon: icon name
• tooltip: string
• widget: widget class name
• title: tab title
• map: a property name from the data to map the control to
• default: a js string, default value of the data map

"icon" or "widget" are at least needed

Parameters

disableControl()

disableControl(string  $name) 

Disables a control

Parameters

getControls()

getControls() : array

Returns the list of controls

This does not include controls provided by collectors

Returns

ignoreCollector()

ignoreCollector(string  $name) 

Ignores widgets provided by a collector

Parameters

getIgnoredCollectors()

getIgnoredCollectors() : array

Returns the list of ignored collectors

Returns

setAjaxHandlerClass()

setAjaxHandlerClass(string  $className) 

Sets the class name of the ajax handler

Set to false to disable

Parameters

getAjaxHandlerClass()

getAjaxHandlerClass() : string

Returns the class name of the ajax handler

Returns

setBindAjaxHandlerToJquery()

setBindAjaxHandlerToJquery(boolean  $bind = true) 

Sets whether to call bindToJquery() on the ajax handler

Parameters

isAjaxHandlerBoundToJquery()

isAjaxHandlerBoundToJquery() : boolean

Checks whether bindToJquery() will be called on the ajax handler

Returns

setBindAjaxHandlerToXHR()

setBindAjaxHandlerToXHR(boolean  $bind = true) 

Sets whether to call bindToXHR() on the ajax handler

Parameters

isAjaxHandlerBoundToXHR()

isAjaxHandlerBoundToXHR() : boolean

Checks whether bindToXHR() will be called on the ajax handler

Returns

setOpenHandlerClass()

setOpenHandlerClass(string  $className) 

Sets the class name of the js open handler

Parameters

getOpenHandlerClass()

getOpenHandlerClass() : string

Returns the class name of the js open handler

Returns

setOpenHandlerUrl()

setOpenHandlerUrl(string  $url) 

Sets the url of the open handler

Parameters

getOpenHandlerUrl()

getOpenHandlerUrl() : string

Returns the url for the open handler

Returns

addAssets()

addAssets(array  $cssFiles, array  $jsFiles, string  $basePath = null, string  $baseUrl = null) 

Add assets to render in the head

Parameters

getAssets()

getAssets(string  $type = null, string  $relativeTo = self::RELATIVE_PATH) : array

Returns the list of asset files

Parameters

Returns

getAsseticCollection()

getAsseticCollection(string  $type = null) : array

Returns a tuple where the both items are Assetic AssetCollection, the first one being css files and the second js files

Parameters

Returns

or \Assetic\Asset\AssetCollection

dumpCssAssets()

dumpCssAssets(string  $targetFilename = null) 

Write all CSS assets to standard output or in a file

Parameters

dumpJsAssets()

dumpJsAssets(string  $targetFilename = null) 

Write all JS assets to standard output or in a file

Parameters

renderHead()

renderHead() : string

Renders the html to include needed assets

Only useful if Assetic is not used

Returns

renderOnShutdown()

renderOnShutdown(boolean  $here = true, boolean  $initialize = true, boolean  $renderStackedData = true, boolean  $head = false) : string

Register shutdown to display the debug bar

Parameters

Returns

Return "{--DEBUGBAR_OB_START_REPLACE_ME--}" or return an empty string if $here == false

renderOnShutdownWithHead()

renderOnShutdownWithHead(boolean  $here = true, boolean  $initialize = true, boolean  $renderStackedData = true) : string

Same as renderOnShutdown() with $head = true

Parameters

Returns

replaceTagInBuffer()

replaceTagInBuffer(boolean  $here = true, boolean  $initialize = true, boolean  $renderStackedData = true, boolean  $head = false) 

Is callback function for register_shutdown_function(.

..)

Parameters

render()

render(boolean  $initialize = true, boolean  $renderStackedData = true) : string

Returns the code needed to display the debug bar

AJAX request should not render the initialization code.

Parameters

Returns

getRelativeRoot()

getRelativeRoot(string  $relativeTo, string  $basePath, string  $baseUrl) : string

Returns the correct base according to the type

Parameters

Returns

makeUriRelativeTo()

makeUriRelativeTo(string|array  $uri, string  $root) : string

Makes a URI relative to another

Parameters

Returns

filterAssetArray()

filterAssetArray(array  $array, string  $type = null) : array

Filters a tuple of (css, js) assets according to $type

Parameters

Returns

createAsseticCollection()

createAsseticCollection(array  $files) : \Assetic\Asset\AssetCollection

Create an Assetic AssetCollection with the given files.

Filenames will be converted to absolute path using the base path.

Parameters

Returns

dumpAssets()

dumpAssets(array  $files, string  $targetFilename = null, boolean  $useRequireJs = false) 

Write assets to standard output or in a file

Parameters

getJsInitializationCode()

getJsInitializationCode() : string

Returns the js code needed to initialize the debug bar

Returns

getJsControlsDefinitionCode()

getJsControlsDefinitionCode(string  $varname) : string

Returns the js code needed to initialized the controls and data mapping of the debug bar

Controls can be defined by collectors themselves or using \addControl()

Parameters

Returns

getAddDatasetCode()

getAddDatasetCode(string  $requestId, array  $data, mixed  $suffix = null) : string

Returns the js code needed to add a dataset

Parameters

Returns