apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: Var_Dump

Source Location: /Var_Dump-0.9/Var_Dump.php

Class Overview




Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 50]


[ Top ]


Class Variables

$defaultOptions = array(
        'display_mode' => 'XHTML_Text'
    )

[line 67]

Default configuration options.
  • Access: public

Type:   array


[ Top ]

$options = array()

[line 60]

Run-time configuration options.
  • Access: public

Type:   array


[ Top ]

$renderer =  NULL

[line 84]

Rendering object.
  • Access: public

Type:   object


[ Top ]

$rendererOptions = array()

[line 77]

Rendering configuration options, one entry for each renderer.

See Var_Dump/Renderer/*.php for the complete list of options

  • Access: public

Type:   array


[ Top ]



Method Detail

Var_Dump (Constructor)   [line 96]

Var_Dump Var_Dump( [array $options = array()], [array $rendererOptions = array()])

Class constructor.

See Var_Dump/Renderer/*.php for the complete list of options

  • Access: public

Parameters:

array   $options   —  Global parameters.
array   $rendererOptions   —  Parameters for the rendering.

[ Top ]

display   [line 174]

string display( mixed $expression, [bool $return = FALSE])

Outputs or returns a string representation of a variable.
  • Return: If returned, the string representation of the variable.
  • Access: public

Parameters:

mixed   $expression   —  The variable to parse.
bool   $return   —  Whether the variable should be echoed or returned.

[ Top ]

factory   [line 123]

void &factory( [array $options = array()], [array $rendererOptions = array()])

Attempt to return a concrete Var_Dump instance.

See Var_Dump/Renderer/*.php for the complete list of options

  • Access: public

Parameters:

array   $options   —  Global parameters.
array   $rendererOptions   —  Parameters for the rendering.

[ Top ]

setOptions   [line 156]

void setOptions( [array $options = array()])

Set run-time configuration options for the renderer
  • Access: public

Parameters:

array   $options   —  Run-time configuration options.

[ Top ]

singleton   [line 138]

void &singleton( [array $options = array()], [array $rendererOptions = array()])

Attempt to return a concrete singleton Var_Dump instance.

See Var_Dump/Renderer/*.php for the complete list of options

  • Access: public

Parameters:

array   $options   —  Run-time configuration options.
array   $rendererOptions   —  Parameters for the rendering.

[ Top ]

toString   [line 192]

string toString( mixed $expression)

Uses a renderer object to return the string representation of a variable.
  • Return: The string representation of the variable.
  • Access: public

Parameters:

mixed   $expression   —  The variable to parse.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 10:16:08 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.