contenido\classes\Debug\Debug_VisibleAdv.class.php

Show: PublicProtectedPrivateinherited
Table of Contents
Project: Contenido Content Management System

Description: Debug object to show info on screen in a box / HTML Block at the top of page. Instead of doing the output immediately using method show, values can be collected and printed to screen in one go. Therefore there's a box positioned at the left top of the page that can be toggled and hidden.

Please note: When using method Debug_VisibleAdv::showAll() you'll produce invalid HTML when having an XHTML doctype.

Requirements:

Author
Rudi Bieller  
Con_php_req
5.0  
Copyright
four for business AG  
License
http://www.contenido.org/license/LIZENZ.txt  
Link
http://www.4fb.de  
Link
{@internal created 2008-05-20 $Id: Debug_VisibleAdv.class.php 830 2008-09-18 10:51:34Z OliverL $: }}  
Package
Contenido Backend classes  
Version
1.0.0  

\Debug_VisibleAdv

Package: Default
Implements
\IDebug

Properties

>VPropertyprivate$_aItems
Details
Type
n/a
>VPropertyprivate$_instance
static
Details
Type
n/a

Methods

methodprivate__construct() : void

Constructor

Details
Access
private  
methodprivate_prepareValue(mixed $mValue) : string

Prepares Debug item value for output as string representation.

Parameters
NameTypeDescription
$mValuemixed
Returns
TypeDescription
string
Details
Access
private  
methodpublicadd(mixed $mVariable, string $sVariableDescription = '') : \void;

Add a Debug item to internal collection.

Parameters
NameTypeDescription
$mVariablemixed
$sVariableDescriptionstring
Returns
TypeDescription
\void;
Details
Access
public  
methodpubliccount() : int

Implemenation of Countable interface

Returns
TypeDescription
int
Details
Access
public  
methodpublicgetInstance() : void
static

static

Details
Access
public  
methodpublicreset() : void

Reset internal collection with Debug items.

Details
Access
public  
methodpublicshow(mixed $mVariable, string $sVariableDescription = '', boolean $bExit = false) : void

Outputs contents of passed variable in a preformatted, readable way

Parameters
NameTypeDescription
$mVariablemixed

The variable to be displayed

$sVariableDescriptionstring

The variable's name or description

$bExitboolean

If set to true, your app will die() after output of current var

Details
Access
public  
methodpublicshowAll() : void

Outputs all Debug items in collection to screen in a HTML Box at left top of page.

Details
Access
public  

\Debug_VisibleAdv_Item

Package: Default
An object representing one Debug item of a Debug_VisibleBlock.

Properties

>VPropertyprivate$_mValue
Details
Type
n/a
>VPropertyprivate$_sDescription
Details
Type
n/a

Methods

methodpublicgetDescription() : string

Get name/description of item

Returns
TypeDescription
string
Details
Access
public  
methodpublicgetValue() : mixed

Get value of item

Returns
TypeDescription
mixed
Details
Access
public  
methodpublicsetDescription( $sDescription) : void

Set name/description of item

Parameters
NameTypeDescription
$sDescription
Details
Access
public  
methodpublicsetValue( $mValue) : void

Set value of item

Parameters
NameTypeDescription
$mValue
Details
Access
public  
Documentation was generated by phpDocumentor 2.0.0a12.