Class: Var_Dump_Renderer_Common

Source Location: /Var_Dump-1.0.2/php/Var_Dump/Renderer/Common.php

Class Overview

A base class for Var_Dump renderers, must be inherited by all such.

Author(s):

Frederic Poeydomenge <at free dot fr fpoeydomenge at free dot fr>

Variables

Methods

Child classes:

Var_Dump_Renderer_XML: A concrete renderer for Var_Dump

Var_Dump_Renderer_Table: A concrete renderer for Var_Dump

Var_Dump_Renderer_Text: A concrete renderer for Var_Dump

Inherited Variables

Inherited Methods

Class Details

[line 29]
A base class for Var_Dump renderers, must be inherited by all such.

Author: Frederic Poeydomenge <at free dot fr fpoeydomenge at free dot fr>

[ Top ]

Class Variables

$defaultOptions = array()

[line 48]

Default configuration options.

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

Access: public

Type:

array

[ Top ]

$depth =

[line 64]

Array containing the element depths

Access: public

Type:

array

[ Top ]

$family =

[line 56]

Array containing the element family : start/finish group, start/finish element

Access: public

Type:

array

[ Top ]

$keyLen =

[line 88]

Array containing the strlen of keys for all the nested arrays

Access: public

Type:

array

[ Top ]

$options = array()

[line 38]

Run-time configuration options.

Access: public

Type:

array

[ Top ]

$type =

[line 72]

Array containing the element types

Access: public

Type:

array

[ Top ]

$value =

[line 80]

Array containing the element values

Access: public

Type:

array

[ Top ]

Method Detail

initialize [line 111]

void initialize(

&$family, 
&$depth, 
&$type, 
&$value, 
&$keyLen, array
$family, array
$depth, array
$type, array
$value, array
$keyLen)

Initialize internal data structures for the rendering.

Access: public

Parameters:

array	`$family`	—	Containing the element family.
array	`$depth`	—	Containing the element depths.
array	`$type`	—	Containing the element types.
array	`$value`	—	Containing the element values.
array	`$keyLen`	—	Strlen of keys for all the nested arrays
	`&$family`	—
	`&$depth`	—
	`&$type`	—
	`&$value`	—
	`&$keyLen`	—

[ Top ]

setOptions [line 96]

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

Set run-time configuration options for the renderer

Access: public

Parameters:

array $options — Run-time configuration options.

[ Top ]

toString [line 127]

string toString(
)

Returns the string representation of a variable

Return: The string representation of the variable.
Abstract:
Access: public

Overridden in child classes as:

Var_Dump_Renderer_XML::toString(): Returns the string representation of a variable

Var_Dump_Renderer_Table::toString(): Returns the string representation of a variable

Var_Dump_Renderer_Text::toString(): Returns the string representation of a variable.

[ Top ]