Class: Var_Dump_Renderer_Text

Source Location: /Var_Dump-0.9/Var_Dump/Renderer/Text.php

Class Overview

Var_Dump_Renderer
   |
   --Var_Dump_Renderer_Text

A concrete renderer for Var_Dump

Author(s):

Frederic Poeydomenge <frederic.poeydomenge at free.fr>

Child classes:

Var_Dump_Renderer_XHTML_Text: A concrete renderer for Var_Dump

Var_Dump_Renderer_HTML4_Text: A concrete renderer for Var_Dump

Inherited Variables

Class: Var_Dump_Renderer

Var_Dump_Renderer::$depth
Var_Dump_Renderer::$family
Var_Dump_Renderer::$keyLen
Var_Dump_Renderer::$options
Var_Dump_Renderer::$type
Var_Dump_Renderer::$value

Inherited Methods

Class: Var_Dump_Renderer

Var_Dump_Renderer::Var_Dump_Renderer(): Class constructor.
Var_Dump_Renderer::initialize(): Initialize internal data structures for the rendering.
Var_Dump_Renderer::setOptions(): Set run-time configuration options for the renderer
Var_Dump_Renderer::singleton(): Attempt to return a concrete singleton Var_Dump_Renderer instance.
Var_Dump_Renderer::toString(): Returns the string representation of a variable

Class Details

[line 33]
A concrete renderer for Var_Dump

Returns a text-only representation of a variable

Author: Frederic Poeydomenge <frederic.poeydomenge@free.fr>

[ Top ]

Class Variables

$defaultOptions = array(
        'show_container'  => TRUE,
        'mode'            => 'compact',
        'offset'          => 2,
        'opening'         => '{',
        'closing'         => '}',
        'operator'        => ' => ',
        'is_html'         => FALSE,
        'before_text'     => '',
        'after_text'      => '',
        'before_num_key'  => '',
        'after_num_key'   => '',
        'before_str_key'  => '',
        'after_str_key'   => '',
        'before_operator' => '',
        'after_operator'  => '',
        'before_type'     => '',
        'after_type'      => '',
        'before_value'    => '',
        'after_value'     => ''
    )

[line 63]

Default configuration options.

show_container : bool, Show the root Element or not mode : string, Can be one of the following displaying modes 'compact' = no keys alignment 'normal' = keys alignment, proportional spacing 'wide' = keys alignment, wider spacing offset : integer, Offset between the start of a group and the content opening : string, Opening character closing : string, Closing character operator : string, Operator symbol is_html : bool, Do we need to htmlspecialchars() the texts before_text : string, Text to insert before the text after_text : string, Text to insert after the text before_num_key : string, Text to insert before a numerical key after_num_key : string, Text to insert after a numerical key before_str_key : string, Text to insert before a string key after_str_key : string, Text to insert after a string key before_operator : string, Text to insert before the operator after_operator : string, Text to insert after the operator before_type : string, Text to insert before a type after_type : string, Text to insert after a type before_value : string, Text to insert before a value after_value : string, Text to insert after a value

Access: public

Type:	array
Overrides:	Array

[ Top ]

Method Detail

Var_Dump_Renderer_Text (Constructor) [line 91]

Var_Dump_Renderer_Text Var_Dump_Renderer_Text(
[array
$options = array()])

Class constructor.

Access: public

Parameters:

array $options — Parameters for the rendering.

[ Top ]

getFinishElement [line 230]

string getFinishElement(
integer
$c)

Returns the value of the element.

Return: The value of the element.
Access: public

Parameters:

integer $c — Index of the element.

[ Top ]

getOperator [line 189]

string getOperator(
)

Returns the operator symbol.

Return: The operator symbol.
Access: public

[ Top ]

getStartElement [line 209]

string getStartElement(
integer
$c)

Returns the key of the element.

Return: The key of the element.
Access: public

Parameters:

integer $c — Index of the element.

[ Top ]

toString [line 103]

string toString(
)

Returns the string representation of a variable.

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

Overrides Var_Dump_Renderer::toString() (Returns the string representation of a variable)

[ Top ]