xplo.re Medusa Core Framework 3.1
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Event
  • Todo
  • Download

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • Driver
    • Field
    • Filter
      • Driver
    • Formatter
      • Driver
        • coreuimarkup
          • Token
    • Hash
    • Loader
    • Locale
    • Log
      • Driver
    • Module
      • Dependency
        • Requirement
          • Core
          • PHP
      • Linkage
        • Driver
    • PDF
    • Plugin
    • Query
      • Driver
    • Server
      • Driver
    • Session
      • Driver
    • Set
    • Storage
      • Driver
      • Field
        • Element
    • Stream
      • Driver
    • String
    • Translation
      • Driver
      • Language
        • Driver
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • vardump

Class vardump

Converts arbitrary input variables into a variable dump.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Set\Mutable implements Core\Mutator
Extended by Core\Field implements Core\Inquiry
Extended by Core\Converter
Extended by Core\Converter\Driver\vardump
Namespace: Core\Converter\Driver
Package: Core\Converter
Since: 3.0
Requires: PHP 5.3
Version: 1.0
Located at Converter/Driver/vardump.inc.php

Methods summary

public
# __construct( Core\URI $uri )

Parameters

$uri
Driver configuration URI.

Since

3.0
protected string
# _dump( mixed $variable, boolean $formatHTML = true, integer $level = 0, boolean & $blockFlag = null )

Renders dump of any kind of variable.

Renders dump of any kind of variable.

Parameters

$variable
Variable to render dump of.
$formatHTML
If set to true, the rendered dump contains HTML formatting.
$level
Block level the variable is contained (intend).
$blockFlag

Set to true, if variable rendered created an own block, otherwise set to false.

Returns

string
Formatted variable dump.

Since

3.0
protected string
# _dumpArray( string & $typeName, boolean & $isBlock, mixed $variable, boolean $formatHTML, integer $level )

Formats an array.

Formats an array.

Parameters

$typeName
$isBlock
$variable
$formatHTML
$level

Returns

string

Since

3.0
protected string
# _dumpBoolean( string & $typeName, boolean & $isBlock, mixed $variable, boolean $formatHTML, integer $level )

Formats a Boolean value.

Formats a Boolean value.

Parameters

$typeName
$isBlock
$variable
$formatHTML
$level

Returns

string

Since

3.0
protected string
# _dumpDouble( string & $typeName, boolean & $isBlock, mixed $variable, boolean $formatHTML, integer $level )

Formats a double value.

Formats a double value.

Parameters

$typeName
$isBlock
$variable
$formatHTML
$level

Returns

string

Since

3.0
protected string
# _dumpInteger( string & $typeName, boolean & $isBlock, mixed $variable, boolean $formatHTML, integer $level )

Formats an integer value.

Formats an integer value.

Parameters

$typeName
$isBlock
$variable
$formatHTML
$level

Returns

string

Since

3.0
protected string
# _dumpNull( string & $typeName, boolean & $isBlock, mixed $variable, boolean $formatHTML, integer $level )

Formats a null value.

Formats a null value.

Parameters

$typeName
$isBlock
$variable
$formatHTML
$level

Returns

string

Since

3.0
protected string
# _dumpObject( string & $typeName, boolean & $isBlock, mixed $variable, boolean $formatHTML, integer $level )

Formats an object.

Formats an object.

Parameters

$typeName
$isBlock
$variable
$formatHTML
$level

Returns

string

Since

3.0
protected string
# _dumpResource( string & $typeName, boolean & $isBlock, mixed $variable, boolean $formatHTML, integer $level )

Formats a resource value.

Formats a resource value.

Parameters

$typeName
$isBlock
$variable
$formatHTML
$level

Returns

string

Since

3.0
protected string
# _dumpString( string & $typeName, boolean & $isBlock, mixed $variable, boolean $formatHTML, integer $level )

Formats a string value.

Formats a string value.

Parameters

$typeName
$isBlock
$variable
$formatHTML
$level

Returns

string

Since

3.0
protected string
# _formatString( string $string, boolean $formatHTML )

Renders a string with special support for encoding control characters.

Renders a string with special support for encoding control characters.

Parameters

$string
$formatHTML

Returns

string

Since

3.0
protected string
# _dumpUnknown( string & $typeName, boolean & $isBlock, mixed $variable, boolean $formatHTML, integer $level )

Formats an unknown type value.

Formats an unknown type value.

Parameters

$typeName
$isBlock
$variable
$formatHTML
$level

Returns

string

Since

3.0
public mixed
# convert( mixed $value, $formatHTML = false )

Converts the input.

Converts the input.

Supports an additional Boolean argument to control whether the generated output should include HTML formatting. Defaults to false.

Parameters

$value

Value to convert. May accept additional parameters depending on the converter in use.

$formatHTML

Returns

mixed
Converted value.

Since

3.0

Overrides

Core\Converter::convert

Methods inherited from Core\Converter

__invoke(), autocreate(), chain(), getDataForUndefinedKey()

Methods inherited from Core\Field

getDataForKey(), getDataForKeys(), issetDataForKey(), offsetExists(), offsetGet(), offsetSet(), offsetUnset()

Methods inherited from Core\Set\Mutable

__set(), __unset()

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

protected array $_v_typeColours

Colours used for variables in HTML output based on their type.

Colours used for variables in HTML output based on their type.

Since

3.0
# array ( 'default' => 'lightslategray', 'boolean' => 'darkcyan', 'double' => 'mediumvioletred', 'integer' => 'blue', 'null' => 'royalblue', 'op' => 'grey', 'string' => 'brown', )
protected array $_v_typeDisplayNames

Translation table for variable types.

Translation table for variable types.

Since

3.0
# array ( 'array' => 'array', 'boolean' => 'boolean', 'double' => 'float', 'integer' => 'int', 'null' => 'null', 'object' => 'object', 'resource' => 'resource', 'string' => 'string', 'unknown' => '-unknown-', )
protected integer $_v_levelLimit

Limit for array and object members.

Limit for array and object members.

Since

3.0
# 256
protected integer $_v_recursionLimit

Recursion limit.

Recursion limit.

Since

3.0
# 16
protected array $_blockTypes

Variable types to create own output blocks for.

Variable types to create own output blocks for.

Since

3.0
# array ( 'array', 'object', 'resource', )
protected string $_indexOperator

Cached index operator string for arrays and objects.

Cached index operator string for arrays and objects.

Since

3.0
#
protected array $_intermediateHashSet

Cached hashes during a var dump to detect recursion.

Cached hashes during a var dump to detect recursion.

Since

3.0
#
protected string $_referenceOperator

Cached reference operator string.

Cached reference operator string.

Since

3.0
#
protected Core\Encoder $_stringEncoder

Cached string encoder used to dump strings with encoded control characters.

Cached string encoder used to dump strings with encoded control characters.

Since

3.0
#
protected static array $_hashSet

Global hash set cache for arrays and objects to detect recursion.

Global hash set cache for arrays and objects to detect recursion.

Since

3.0
#

Properties inherited from Core\Converter

$_v_dataSource, $_v_successor

Properties inherited from Core\Field

$_v_data

Magic properties

public read-only integer $levelLimit

Limit for array and object members.

public read-only integer $recursionLimit

Recursion limit.

public read-only array $typeColours

Translation table for variable types to their HTML colour.

public read-only array $typeDisplayNames

Translation table for variable type names.

Magic properties inherited from Core\Converter

$dataSource, $successor

Magic properties inherited from Core\Field

$data

Magic properties inherited from Core\Object

$hash, $uuid

xplo.re Medusa Core Framework 3.1 API documentation generated by ApiGen