Référence de la classe HtmlDumper

Graphe d'héritage de HtmlDumper:

Fonctions membres publiques
	__construct ($output=null, string $charset=null, int $flags=0)
	setStyles (array $styles)
	setTheme (string $themeName)
	setDisplayOptions (array $displayOptions)
	setDumpHeader (?string $header)
	setDumpBoundaries (string $prefix, string $suffix)
	dump (Data $data, $output=null, array $extraDisplayOptions=[])
	dumpString (Cursor $cursor, string $str, bool $bin, int $cut)
	enterHash (Cursor $cursor, int $type, $class, bool $hasChild)
	leaveHash (Cursor $cursor, int $type, $class, bool $hasChild, int $cut)
Fonctions membres publiques hérités de CliDumper
	__construct ($output=null, string $charset=null, int $flags=0)
	setColors (bool $colors)
	setMaxStringWidth (int $maxStringWidth)
	setStyles (array $styles)
	setDisplayOptions (array $displayOptions)
	dumpScalar (Cursor $cursor, string $type, $value)
	dumpString (Cursor $cursor, string $str, bool $bin, int $cut)
	enterHash (Cursor $cursor, int $type, $class, bool $hasChild)
	leaveHash (Cursor $cursor, int $type, $class, bool $hasChild, int $cut)
Fonctions membres publiques hérités de AbstractDumper
	__construct ($output=null, string $charset=null, int $flags=0)
	setOutput ($output)
	setCharset (string $charset)
	setIndentPad (string $pad)
	dump (Data $data, $output=null)
Fonctions membres publiques hérités de DataDumperInterface
	dump (Data $data)

Attributs publics statiques
static	$defaultOutput = 'php://output'
Attributs publics statiques hérités de CliDumper
static	$defaultColors
static	$defaultOutput = 'php://stdout'
static	n
Attributs publics statiques hérités de AbstractDumper
static	$defaultOutput = 'php://output'

Fonctions membres protégées
	getDumpHeader ()
	style (string $style, string $value, array $attr=[])
	dumpLine (int $depth, bool $endOfValue=false)
Fonctions membres protégées hérités de CliDumper
	dumpEllipsis (Cursor $cursor, bool $hasChild, int $cut)
	dumpKey (Cursor $cursor)
	style (string $style, string $value, array $attr=[])
	supportsColors ()
	dumpLine (int $depth, bool $endOfValue=false)
	endValue (Cursor $cursor)
Fonctions membres protégées hérités de AbstractDumper
	dumpLine (int $depth)
	echoLine (string $line, int $depth, string $indentPad)
	utf8Encode (?string $s)

Attributs protégés
static	$dumpHeader
	$dumpPrefix = '<pre class=sf-dump id=%s data-indent-pad="%s">'
	$dumpSuffix = '</pre><script>Sfdump(%s)</script>'
	$dumpId = 'sf-dump'
	$colors = true
	$headerIsDumped = false
	$lastDepth = -1
	$styles
Attributs protégés hérités de CliDumper
	$colors
	$maxStringWidth = 0
	$styles
	$collapseNextHash = false
	$expandNextHash = false
Attributs protégés hérités de AbstractDumper
	$line = ''
	$lineDumper
	$outputStream
	$decimalPoint
	$indentPad = ' '
	$flags

Attributs protégés statiques
static	$themes
Attributs protégés statiques hérités de CliDumper
static	$controlCharsRx = '/[\x00-\x1F\x7F]+/'
static	$controlCharsMap

Fonctions membres privées
	getSourceLink (string $file, int $line)

Attributs privés
	$displayOptions
	$extraDisplayOptions = []

Membres hérités additionnels
Champs de données hérités de AbstractDumper
const	DUMP_LIGHT_ARRAY = 1
const	DUMP_STRING_LENGTH = 2
const	DUMP_COMMA_SEPARATOR = 4
const	DUMP_TRAILING_COMMA = 8

Description détaillée

HtmlDumper dumps variables as HTML.

Auteur

Nicolas Grekas p@tch.nosp@m.work.nosp@m..com

Documentation des constructeurs et destructeur

__construct()

__construct	(		$output = null,
		string	$charset = null,
		int	$flags = 0
	)

{}

Références AbstractDumper\$charset, AbstractDumper\$flags, $output, et AbstractDumper\__construct().

Documentation des fonctions membres

dump()

dump	(	Data	$data,
			$output = null,
		array	$extraDisplayOptions = []
	)

{}

Références $data, HtmlDumper\$extraDisplayOptions, $output, et $result.

Référencé par HtmlDumper\getDumpHeader().

dumpLine()

dumpLine ( int  $depth, bool  $endOfValue = false  )

protected

{}

dumpString()

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

{Dumps a string.

Paramètres

string	$str	The string being dumped
bool	$bin	Whether $str is UTF-8 or binary encoded
int	$cut	The number of characters $str has been cut by

}

Implémente DumperInterface.

enterHash()

enterHash	(	Cursor	$cursor,
		int	$type,
			$class,
		bool	$hasChild
	)

{Dumps while entering an hash.

Paramètres

int	$type	A Cursor::HASH_* const for the type of hash
string | int	$class	The object class, resource type or array count
bool	$hasChild	When the dump of the hash has child item

}

Implémente DumperInterface.

Références $class, $r, $this, et $type.

getDumpHeader()

getDumpHeader ( )

protected

Dumps the HTML header.

Références HtmlDumper\$dumpHeader, AbstractDumper\$line, AbstractDumper\$lineDumper, $options, HtmlDumper\dump(), if, CliDumper\n, null, et parent.

Référencé par DebugBarHtmlDumper\getDumpHeaderByDebugBar().

getSourceLink()

getSourceLink ( string  $file, int  $line  )

private

leaveHash()

leaveHash	(	Cursor	$cursor,
		int	$type,
			$class,
		bool	$hasChild,
		int	$cut
	)

{Dumps while leaving an hash.

Paramètres

int	$type	A Cursor::HASH_* const for the type of hash
string | int	$class	The object class, resource type or array count
bool	$hasChild	When the dump of the hash has child item
int	$cut	The number of items the hash has been cut by

}

Implémente DumperInterface.

Références $class, et $type.

setDisplayOptions()

setDisplayOptions

(

array

$displayOptions

)

Configures display options.

Paramètres

array

$displayOptions

A map of display options to customize the behavior

Références HtmlDumper\$displayOptions.

setDumpBoundaries()

setDumpBoundaries	(	string	$prefix,
		string	$suffix
	)

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

Références $prefix, et $suffix.

setDumpHeader()

setDumpHeader

(

?string

$header

)

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

Références $header.

Référencé par SourceContextProvider\htmlEncode().

setStyles()

setStyles

(

array

$styles

)

{}

Références HtmlDumper\$styles.

Référencé par HtmlDumper\setTheme().

setTheme()

setTheme

(

string

$themeName

)

Références class, et HtmlDumper\setStyles().

style()

style ( string  $style, string  $value, array  $attr = []  )

protected

{}

Références $attr, $b, $c, $class, $href, $i, $label, $r, $style, $target, $value, elseif, et Symfony\Component\VarDumper\Dumper\esc().

Documentation des champs

$colors

$colors = true

protected

$defaultOutput

$defaultOutput = 'php://output'

static

$displayOptions

$displayOptions

private

Valeur initiale :

= [
        'maxDepth' => 1

Référencé par HtmlDumper\setDisplayOptions().

$dumpHeader

$dumpHeader

protected

Référencé par HtmlDumper\getDumpHeader().

$dumpId

$dumpId = 'sf-dump'

protected

$dumpPrefix

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

protected

$dumpSuffix

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

protected

$extraDisplayOptions

$extraDisplayOptions = []

private

Référencé par HtmlDumper\dump().

$headerIsDumped

$headerIsDumped = false

protected

$lastDepth

$lastDepth = -1

protected

$styles

$styles

protected

Référencé par HtmlDumper\setStyles().

$themes

$themes

staticprotected

Valeur initiale :

= [
        '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'

---

La documentation de cette classe a été générée à partir du fichier suivant :

• HtmlDumper.php