Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Fonctions membres publiques | Fonctions membres protégées | Attributs protégés | Attributs protégés statiques
Référence de la classe DebugBarVarDumper
+ Graphe d'héritage de DebugBarVarDumper:

Fonctions membres publiques

 getClonerOptions ()
 
 mergeClonerOptions ($options)
 
 resetClonerOptions ($options=null)
 
 getDumperOptions ()
 
 mergeDumperOptions ($options)
 
 resetDumperOptions ($options=null)
 
 captureVar ($data)
 
 renderCapturedVar ($capturedData, $seekPath=array())
 
 renderVar ($data)
 
 getAssets ()
 

Fonctions membres protégées

 getCloner ()
 
 getDumper ()
 
 getDisplayOptions ()
 
 dump (Data $data)
 

Attributs protégés

 $clonerOptions
 
 $dumperOptions
 
 $cloner
 
 $dumper
 

Attributs protégés statiques

static $defaultClonerOptions = array()
 
static $defaultDumperOptions
 

Description détaillée

Clones and renders variables in HTML format using the Symfony VarDumper component.

Cloning is decoupled from rendering, so that dumper users can have the fastest possible cloning performance, while delaying rendering until it is actually needed.

Documentation des fonctions membres

◆ captureVar()

captureVar (   $data)

Captures the data from a variable and serializes it for later rendering.

Paramètres
mixed$dataThe variable to capture.
Renvoie
string Serialized variable data.

Références $data, et DebugBarVarDumper\getCloner().

◆ dump()

dump ( Data  $data)
protected

Helper function to dump a Data object to HTML.

Paramètres
Data$data
Renvoie
string

Références DebugBarVarDumper\$dumper, $output, $result, DebugBarVarDumper\getDisplayOptions(), DebugBarVarDumper\getDumper(), et null.

Référencé par DebugBarVarDumper\renderCapturedVar(), et DebugBarVarDumper\renderVar().

◆ getAssets()

getAssets ( )

Returns assets required for rendering variables.

Renvoie
array

Implémente AssetProvider.

Références DebugBarVarDumper\$dumper, et DebugBarVarDumper\getDumper().

◆ getCloner()

getCloner ( )
protected

Gets the VarCloner instance with configuration options set.

Renvoie
VarCloner

Références DebugBarVarDumper\$cloner, DebugBarVarDumper\$clonerOptions, et DebugBarVarDumper\getClonerOptions().

Référencé par DebugBarVarDumper\captureVar(), et DebugBarVarDumper\renderVar().

◆ getClonerOptions()

getClonerOptions ( )

Gets the array of non-default VarCloner configuration options.

Renvoie
array

Références DebugBarVarDumper\$clonerOptions, et null.

Référencé par DebugBarVarDumper\getCloner(), et DebugBarVarDumper\mergeClonerOptions().

◆ getDisplayOptions()

getDisplayOptions ( )
protected

Gets the display options for the HTML dumper.

Renvoie
array

Références DebugBarVarDumper\$dumperOptions, et DebugBarVarDumper\getDumperOptions().

Référencé par DebugBarVarDumper\dump().

◆ getDumper()

getDumper ( )
protected

Gets the DebugBarHtmlDumper instance with configuration options set.

Renvoie
DebugBarHtmlDumper

Références DebugBarVarDumper\$dumper, DebugBarVarDumper\$dumperOptions, et DebugBarVarDumper\getDumperOptions().

Référencé par DebugBarVarDumper\dump(), et DebugBarVarDumper\getAssets().

◆ getDumperOptions()

getDumperOptions ( )

Gets the array of non-default HtmlDumper configuration options.

Renvoie
array

Références DebugBarVarDumper\$dumperOptions, et null.

Référencé par DebugBarVarDumper\getDisplayOptions(), DebugBarVarDumper\getDumper(), et DebugBarVarDumper\mergeDumperOptions().

◆ mergeClonerOptions()

mergeClonerOptions (   $options)

Merges an array of non-default VarCloner configuration options with the existing non-default options.

Configuration options are:

  • casters: a map of VarDumper Caster objects to use instead of the default casters.
  • additional_casters: a map of VarDumper Caster objects to use in addition to the default casters.
  • max_items: maximum number of items to clone beyond the minimum depth.
  • max_string: maximum string size
  • min_depth: minimum tree depth to clone before counting items against the max_items limit. (Requires Symfony 3.4; ignored on older versions.)
Paramètres
array$options

Références $options, DebugBarVarDumper\getClonerOptions(), et null.

◆ mergeDumperOptions()

mergeDumperOptions (   $options)

Merges an array of non-default HtmlDumper configuration options with the existing non-default options.

Configuration options are:

  • styles: a map of CSS styles to include in the assets, as documented in HtmlDumper::setStyles.
  • expanded_depth: the tree depth to initially expand. (Requires Symfony 3.2; ignored on older versions.)
  • max_string: maximum string size. (Requires Symfony 3.2; ignored on older versions.)
  • file_link_format: link format for files; f expanded to file and l expanded to line (Requires Symfony 3.2; ignored on older versions.)
Paramètres
array$options

Références $options, DebugBarVarDumper\getDumperOptions(), et null.

◆ renderCapturedVar()

renderCapturedVar (   $capturedData,
  $seekPath = array() 
)

Renders previously-captured data from captureVar to HTML and returns it as a string.

Paramètres
string$capturedDataCaptured data from captureVar.
array$seekPathPass an array of keys to traverse if you only want to render a subset of the data.
Renvoie
string HTML rendering of the variable.

Références $data, $key, et DebugBarVarDumper\dump().

◆ renderVar()

renderVar (   $data)

Captures and renders the data from a variable to HTML and returns it as a string.

Paramètres
mixed$dataThe variable to capture and render.
Renvoie
string HTML rendering of the variable.

Références $data, DebugBarVarDumper\dump(), et DebugBarVarDumper\getCloner().

◆ resetClonerOptions()

resetClonerOptions (   $options = null)

Resets the array of non-default VarCloner configuration options without retaining any of the existing non-default options.

Configuration options are:

  • casters: a map of VarDumper Caster objects to use instead of the default casters.
  • additional_casters: a map of VarDumper Caster objects to use in addition to the default casters.
  • max_items: maximum number of items to clone beyond the minimum depth.
  • max_string: maximum string size
  • min_depth: minimum tree depth to clone before counting items against the max_items limit. (Requires Symfony 3.4; ignored on older versions.)
Paramètres
array$options

Références $options, et null.

◆ resetDumperOptions()

resetDumperOptions (   $options = null)

Resets the array of non-default HtmlDumper configuration options without retaining any of the existing non-default options.

Configuration options are:

  • styles: a map of CSS styles to include in the assets, as documented in HtmlDumper::setStyles.
  • expanded_depth: the tree depth to initially expand. (Requires Symfony 3.2; ignored on older versions.)
  • max_string: maximum string size. (Requires Symfony 3.2; ignored on older versions.)
  • file_link_format: link format for files; f expanded to file and l expanded to line (Requires Symfony 3.2; ignored on older versions.)
Paramètres
array$options

Références $options, et null.

Documentation des champs

◆ $cloner

$cloner
protected

Référencé par DebugBarVarDumper\getCloner().

◆ $clonerOptions

$clonerOptions
protected

Référencé par DebugBarVarDumper\getCloner(), et DebugBarVarDumper\getClonerOptions().

◆ $defaultClonerOptions

$defaultClonerOptions = array()
staticprotected

◆ $defaultDumperOptions

$defaultDumperOptions
staticprotected
Valeur initiale :
= array(
'expanded_depth' => 0,
'styles' => array(
'default' => 'word-wrap: break-word; white-space: pre-wrap; word-break: normal',
'num' => 'font-weight:bold; color:#1299DA',
'const' => 'font-weight:bold',
'str' => 'font-weight:bold; color:#3A9B26',
'note' => 'color:#1299DA',
'ref' => 'color:#7B7B7B',
'public' => 'color:#000000',
'protected' => 'color:#000000',
'private' => 'color:#000000',
'meta' => 'color:#B729D9',
'key' => 'color:#3A9B26',
'index' => 'color:#1299DA',
'ellipsis' => 'color:#A0A000',
),
)

◆ $dumper

$dumper
protected

Référencé par DebugBarVarDumper\dump(), DebugBarVarDumper\getAssets(), et DebugBarVarDumper\getDumper().

◆ $dumperOptions

$dumperOptions
protected

Référencé par DebugBarVarDumper\getDisplayOptions(), DebugBarVarDumper\getDumper(), et DebugBarVarDumper\getDumperOptions().

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