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


Classes:
Var_Dump
   Var_Dump

Class: Var_Dump

Source Location: /Var_Dump-0.4.2/Var_Dump.php

Class Overview

PEAR
   |
   --Var_Dump

Displays informations about the values of variables on a graphical way
  • If given a simple variable (string, integer, double, ressource), the
value itself is printed.

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 72]
Displays informations about the values of variables on a graphical way
  • If given a simple variable (string, integer, double, ressource), the
value itself is printed.

  • If given an array, it is explored recursively and values are presented
in a format that shows keys and elements.
  • If given an object, informations about the object and the class
are printed.



[ Top ]

Class Variables

$lang =  'en'

[line 79]

Selected language for error messages

Type:   string


[ Top ]

$messages =

[line 85]

Messages in various languages

Type:   string


[ Top ]


Method Detail

Var_Dump (Constructor)   [line 140]

Var_Dump Var_Dump( [array $conf = array()])

Var_Dump() - Constructor

If an instance of the class is created, initialize the global parameters for this instance : if we show 'not parsed' variables or not, the default display mode, the default skin name..


Parameters:

array   $conf   —  Global parameters for an instance of the class 'showNotParsed' => Tell if we show 'not parsed' variables or not 'displayMode' => Default display mode : Text or Html 'displaySkin' => Default skin name

[ Top ]

display   [line 273]

void display( [$variable $variable = ''], [string $except = ''], [ $displayMode = false], [ $options = null])

display() - Displays informations about a variable

This method displays informations about the values of a variable on a graphical way, arrays and objects being explored recursively


Parameters:

string   $except   —  If not empty, name of the key not to explore, to avoid parsing references to itself
$variable   $variable   —  A variable to explore
   $displayMode   — 
   $options   — 

[ Top ]

r_display   [line 301]

void r_display( [$variable $variable = ''], [string $except = ''], [ $displayMode = false], [ $options = null])

r_display() - Returns informations about a variable, ready to be printed

This method returns informations about the values of a variable, ready to be printed on a graphical way, arrays and objects being explored recursively


Parameters:

string   $except   —  If not empty, name of the key not to explore, to avoid parsing references to itself
$variable   $variable   —  A variable to explore
   $displayMode   — 
   $options   — 

[ Top ]

setDisplayMode   [line 873]

void setDisplayMode( [array $conf = array()])

setDisplayMode() - Set visual parameters

This method set visual parameters for the rendering : border color and size, cells colors, padding and spacing of the table, font face, size and color.


Parameters:

array   $conf   —  Display configuration

[ Top ]

setSkin   [line 905]

void setSkin( [int $mode = VAR_DUMP_DISPLAY_MODE_HTML_TEXT], [string $skin = 'default'])

setSkin() - Set visual parameters using a skin model

This method set visual parameters using a skin model


Parameters:

int   $mode   —  Default display mode : Text or Html
string   $skin   —  Name of the skin for the moment : default, green, red or blue

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