Documentation

HtmlDumper extends CliDumper
in package

Application

HtmlDumper dumps variables as HTML.

Constants

DUMP_COMMA_SEPARATOR = 4
DUMP_LIGHT_ARRAY = 1
DUMP_STRING_LENGTH = 2
DUMP_TRAILING_COMMA = 8

Properties

$defaultColors : mixed
$defaultOutput : mixed
$collapseNextHash : mixed
$colors : mixed
$controlCharsMap : mixed
$controlCharsRx : mixed
$decimalPoint : mixed
$dumpHeader : mixed
$dumpId : mixed
$dumpPrefix : mixed
$dumpSuffix : mixed
$expandNextHash : mixed
$flags : mixed
$headerIsDumped : mixed
$indentPad : mixed
$lastDepth : mixed
$line : mixed
$lineDumper : mixed
$maxStringWidth : mixed
$outputStream : mixed
$styles : mixed
$themes : mixed
$charset : string
$displayOptions : array<string|int, mixed>
$extraDisplayOptions : array<string|int, mixed>
$handlesHrefGracefully : bool

Methods

__construct() : mixed
dump() : string|null: {@inheritdoc}
dumpScalar() : mixed: {@inheritdoc}
dumpString() : mixed: {@inheritdoc}
enterHash() : mixed: {@inheritdoc}
leaveHash() : mixed: {@inheritdoc}
setCharset() : string: Sets the default character encoding to use for non-UTF8 strings.
setColors() : mixed: Enables/disables colored output.
setDisplayOptions() : mixed: Configures display options.
setDumpBoundaries() : mixed: Sets an HTML prefix and suffix that will encapse every single dump.
setDumpHeader() : mixed: Sets an HTML header that will be dumped once in the output stream.
setIndentPad() : string: Sets the indentation pad string.
setMaxStringWidth() : mixed: Sets the maximum number of characters per line for dumped strings.
setOutput() : callable|resource|string: Sets the output destination of the dumps.
setStyles() : mixed: Configures styles.
setTheme() : mixed
dumpEllipsis() : mixed: Dumps an ellipsis for cut children.
dumpKey() : mixed: Dumps a key in a hash structure.
dumpLine() : mixed: Dumps the current line.
echoLine() : mixed: Generic line dumper callback.
endValue() : mixed
getDumpHeader() : mixed: Dumps the HTML header.
style() : string: Decorates a value with some style.
supportsColors() : bool
utf8Encode() : string|null: Converts a non-UTF-8 string to UTF-8.
getSourceLink() : mixed
hasColorSupport() : bool: Returns true if the stream supports colorization.
isWindowsTrueColor() : bool: Returns true if the Windows terminal supports true color.

DUMP_COMMA_SEPARATOR


    public
        mixed
    DUMP_COMMA_SEPARATOR
    = 4

DUMP_LIGHT_ARRAY


    public
        mixed
    DUMP_LIGHT_ARRAY
    = 1

DUMP_STRING_LENGTH


    public
        mixed
    DUMP_STRING_LENGTH
    = 2

DUMP_TRAILING_COMMA


    public
        mixed
    DUMP_TRAILING_COMMA
    = 8

$defaultColors


    public
    static    mixed
    $defaultColors

$defaultOutput


    public
    static    mixed
    $defaultOutput
     = 'php://output'

$collapseNextHash


    protected
        mixed
    $collapseNextHash
     = false

$colors


    protected
        mixed
    $colors
     = true

$controlCharsMap


    protected
    static    mixed
    $controlCharsMap
     = ["\t" => '\\t', "\n" => '\\n', "\v" => '\\v', "\f" => '\\f', "\r" => '\\r', "\x1b" => '\\e']

$controlCharsRx


    protected
    static    mixed
    $controlCharsRx
     = '/[\\x00-\\x1F\\x7F]+/'

$decimalPoint


    protected
        mixed
    $decimalPoint
     = '.'

$dumpHeader


    protected
        mixed
    $dumpHeader

$dumpId


    protected
        mixed
    $dumpId
     = 'sf-dump'

$dumpPrefix


    protected
        mixed
    $dumpPrefix
     = '<pre class=sf-dump id=%s data-indent-pad="%s">'

$dumpSuffix


    protected
        mixed
    $dumpSuffix
     = '</pre><script>Sfdump(%s)</script>'

$expandNextHash


    protected
        mixed
    $expandNextHash
     = false

$flags


    protected
        mixed
    $flags

$headerIsDumped


    protected
        mixed
    $headerIsDumped
     = false

$indentPad


    protected
        mixed
    $indentPad
     = '  '

$lastDepth


    protected
        mixed
    $lastDepth
     = -1

$line


    protected
        mixed
    $line
     = ''

$lineDumper


    protected
        mixed
    $lineDumper

$maxStringWidth


    protected
        mixed
    $maxStringWidth
     = 0

$outputStream


    protected
        mixed
    $outputStream

$styles


    protected
        mixed
    $styles

$themes


    protected
    static    mixed
    $themes
     = ['dark' => ['default' => 'background-color:#18171B; color:#FF8400; line-height:1.2em; font:12px Menlo, Monaco, Consolas, monospace; word-wrap: break-word; white-space: pre-wrap; position:relative; z-index:99999; word-break: break-all', 'num' => 'font-weight:bold; color:#1299DA', 'const' => 'font-weight:bold', 'str' => 'font-weight:bold; color:#56DB3A', 'note' => 'color:#1299DA', 'ref' => 'color:#A0A0A0', 'public' => 'color:#FFFFFF', 'protected' => 'color:#FFFFFF', 'private' => 'color:#FFFFFF', 'meta' => 'color:#B729D9', 'key' => 'color:#56DB3A', 'index' => 'color:#1299DA', 'ellipsis' => 'color:#FF8400', 'ns' => 'user-select:none;'], 'light' => ['default' => 'background:none; color:#CC7832; line-height:1.2em; font:12px Menlo, Monaco, Consolas, monospace; word-wrap: break-word; white-space: pre-wrap; position:relative; z-index:99999; word-break: break-all', 'num' => 'font-weight:bold; color:#1299DA', 'const' => 'font-weight:bold', 'str' => 'font-weight:bold; color:#629755;', 'note' => 'color:#6897BB', 'ref' => 'color:#6E6E6E', 'public' => 'color:#262626', 'protected' => 'color:#262626', 'private' => 'color:#262626', 'meta' => 'color:#B729D9', 'key' => 'color:#789339', 'index' => 'color:#1299DA', 'ellipsis' => 'color:#CC7832', 'ns' => 'user-select:none;']]

$charset


    private
        string
    $charset
     = ''

$displayOptions


    private
        array<string|int, mixed>
    $displayOptions
     = ['maxDepth' => 1, 'maxStringLength' => 160, 'fileLinkFormat' => null]

$extraDisplayOptions


    private
        array<string|int, mixed>
    $extraDisplayOptions
     = []

$handlesHrefGracefully


    private
        bool
    $handlesHrefGracefully

__construct()


    public
                    __construct([mixed $output = null ][, string $charset = null ][, int $flags = 0 ]) : mixed

Parameters

$output : mixed = null: A line dumper callable, an opened stream or an output path, defaults to static::$defaultOutput
$charset : string = null: The default character encoding to use for non-UTF8 strings
$flags : int = 0: A bit field of static::DUMP_* constants to fine tune dumps representation

dump()

{@inheritdoc}


    public
                    dump(Data $data[, mixed $output = null ][, array<string|int, mixed> $extraDisplayOptions = [] ]) : string|null

Parameters

$data : Data
$output : mixed = null
$extraDisplayOptions : array<string|int, mixed> = []

Return values

string|null

dumpScalar()

{@inheritdoc}


    public
                    dumpScalar(Cursor $cursor, string $type, string|int|float|bool|null $value) : mixed

Parameters

$cursor : Cursor
$type : string
$value : string|int|float|bool|null

dumpString()

{@inheritdoc}


    public
                    dumpString(Cursor $cursor, string $str, bool $bin, int $cut) : mixed

Parameters

$cursor : Cursor
$str : string
$bin : bool
$cut : int

enterHash()

{@inheritdoc}


    public
                    enterHash(Cursor $cursor, int $type, string|int|null $class, bool $hasChild) : mixed

Parameters

$cursor : Cursor
$type : int
$class : string|int|null
$hasChild : bool

leaveHash()

{@inheritdoc}


    public
                    leaveHash(Cursor $cursor, int $type, string|int|null $class, bool $hasChild, int $cut) : mixed

Parameters

$cursor : Cursor
$type : int
$class : string|int|null
$hasChild : bool
$cut : int

setCharset()

Sets the default character encoding to use for non-UTF8 strings.


    public
                    setCharset(string $charset) : string

Parameters

$charset : string

Return values

string —

The previous charset

setColors()

Enables/disables colored output.


    public
                    setColors(bool $colors) : mixed

Parameters

$colors : bool

setDisplayOptions()

Configures display options.


    public
                    setDisplayOptions(array<string|int, mixed> $displayOptions) : mixed

Parameters

$displayOptions : array<string|int, mixed>: A map of display options to customize the behavior

setDumpBoundaries()

Sets an HTML prefix and suffix that will encapse every single dump.


    public
                    setDumpBoundaries(string $prefix, string $suffix) : mixed

Parameters

$prefix : string
$suffix : string

setDumpHeader()

Sets an HTML header that will be dumped once in the output stream.


    public
                    setDumpHeader(string|null $header) : mixed

Parameters

$header : string|null

setIndentPad()

Sets the indentation pad string.


    public
                    setIndentPad(string $pad) : string

Parameters

$pad : string: A string that will be prepended to dumped lines, repeated by nesting level

Return values

string —

The previous indent pad

setMaxStringWidth()

Sets the maximum number of characters per line for dumped strings.


    public
                    setMaxStringWidth(int $maxStringWidth) : mixed

Parameters

$maxStringWidth : int

setOutput()

Sets the output destination of the dumps.


    public
                    setOutput(callable|resource|string $output) : callable|resource|string

Parameters

$output : callable|resource|string: A line dumper callable, an opened stream or an output path

Return values

callable|resource|string —

The previous output destination

setStyles()

Configures styles.


    public
                    setStyles(array<string|int, mixed> $styles) : mixed

Parameters

$styles : array<string|int, mixed>: A map of style names to style definitions

setTheme()


    public
                    setTheme(string $themeName) : mixed

Parameters

$themeName : string

dumpEllipsis()

Dumps an ellipsis for cut children.


    protected
                    dumpEllipsis(Cursor $cursor, bool $hasChild, int $cut) : mixed

Parameters

$cursor : Cursor
$hasChild : bool: When the dump of the hash has child item
$cut : int: The number of items the hash has been cut by

dumpKey()

Dumps a key in a hash structure.


    protected
                    dumpKey(Cursor $cursor) : mixed

Parameters

$cursor : Cursor

dumpLine()

Dumps the current line.


    protected
                    dumpLine(int $depth[, bool $endOfValue = false ]) : mixed

Parameters

$depth : int: The recursive depth in the dumped structure for the line being dumped, or -1 to signal the end-of-dump to the line dumper callable
$endOfValue : bool = false

echoLine()

Generic line dumper callback.


    protected
                    echoLine(string $line, int $depth, string $indentPad) : mixed

Parameters

$line : string
$depth : int
$indentPad : string

endValue()


    protected
                    endValue(Cursor $cursor) : mixed

Parameters

$cursor : Cursor

getDumpHeader()

Dumps the HTML header.


    protected
                    getDumpHeader() : mixed

style()

Decorates a value with some style.


    protected
                    style(string $style, string $value[, array<string|int, mixed> $attr = [] ]) : string

Parameters

$style : string: The type of style being applied
$value : string: The value being styled
$attr : array<string|int, mixed> = []: Optional context information

Return values

string

supportsColors()


    protected
                    supportsColors() : bool

Return values

bool

utf8Encode()

Converts a non-UTF-8 string to UTF-8.


    protected
                    utf8Encode(string|null $s) : string|null

Parameters

$s : string|null

Return values

string|null

getSourceLink()


    private
                    getSourceLink(string $file, int $line) : mixed

Parameters

$file : string
$line : int

hasColorSupport()

Returns true if the stream supports colorization.


    private
                    hasColorSupport(mixed $stream) : bool

Reference: Composer\XdebugHandler\Process::supportsColor https://github.com/composer/xdebug-handler

Parameters

$stream : mixed

Return values

bool

isWindowsTrueColor()

Returns true if the Windows terminal supports true color.


    private
                    isWindowsTrueColor() : bool

Note that this does not check an output stream, but relies on environment variables from known implementations, or a PHP and Windows version that supports true color.

Return values

bool

HtmlDumper extends CliDumper in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

DUMP_COMMA_SEPARATOR

DUMP_LIGHT_ARRAY

DUMP_STRING_LENGTH

DUMP_TRAILING_COMMA

Properties

$defaultColors

$defaultOutput

$collapseNextHash

$colors

$controlCharsMap

$controlCharsRx

$decimalPoint

$dumpHeader

$dumpId

$dumpPrefix

$dumpSuffix

$expandNextHash

$flags

$headerIsDumped

$indentPad

$lastDepth

$line

$lineDumper

$maxStringWidth

$outputStream

$styles

$themes

$charset

$displayOptions

$extraDisplayOptions

$handlesHrefGracefully

Methods

__construct()

Parameters

dump()

Parameters

Return values

dumpScalar()

Parameters

dumpString()

Parameters

enterHash()

Parameters

leaveHash()

Parameters

setCharset()

Parameters

Return values

setColors()

Parameters

setDisplayOptions()

Parameters

setDumpBoundaries()

Parameters

setDumpHeader()

Parameters

setIndentPad()

Parameters

Return values

setMaxStringWidth()

Parameters

setOutput()

Parameters

Return values

setStyles()

Parameters

setTheme()

Parameters

dumpEllipsis()

Parameters

dumpKey()

Parameters

dumpLine()

HtmlDumper extends CliDumper
in package

Application