Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe AbstractDumper
+ Graphe d'héritage de AbstractDumper:

Fonctions membres publiques

 __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)
 
- Fonctions membres publiques hérités de DumperInterface
 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)
 

Champs de données

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

Attributs publics statiques

static $defaultOutput = 'php://output'
 

Fonctions membres protégées

 dumpLine (int $depth)
 
 echoLine (string $line, int $depth, string $indentPad)
 
 utf8Encode (?string $s)
 

Attributs protégés

 $line = ''
 
 $lineDumper
 
 $outputStream
 
 $decimalPoint
 
 $indentPad = ' '
 
 $flags
 

Attributs privés

 $charset = ''
 

Description détaillée

Abstract mechanism for dumping a Data object.

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 
)
Paramètres
callable | resource | string | null$outputA line dumper callable, an opened stream or an output path, defaults to static::$defaultOutput
string | null$charsetThe default character encoding to use for non-UTF8 strings
int$flagsA bit field of static::DUMP_* constants to fine tune dumps representation

Références AbstractDumper\$charset, AbstractDumper\$flags, $output, AbstractDumper\$outputStream, AbstractDumper\setCharset(), et AbstractDumper\setOutput().

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

Documentation des fonctions membres

◆ dump()

dump ( Data  $data,
  $output = null 
)

Dumps a Data object.

Paramètres
callable | resource | string | true | null$outputA line dumper callable, an opened stream, an output path or true to return the dump
Renvoie
string|null The dump as string when $output is true

Références $output, $result, $this, Data\dump(), AbstractDumper\dumpLine(), null, et AbstractDumper\setOutput().

◆ dumpLine()

dumpLine ( int  $depth)
protected

Dumps the current line.

Paramètres
int$depthThe recursive depth in the dumped structure for the line being dumped, or -1 to signal the end-of-dump to the line dumper callable

Références AbstractDumper\$lineDumper.

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

◆ echoLine()

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

Generic line dumper callback.

Références AbstractDumper\$indentPad, et AbstractDumper\$line.

◆ setCharset()

setCharset ( string  $charset)

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

Renvoie
string The previous charset

Références AbstractDumper\$charset, et null.

Référencé par AbstractDumper\__construct().

◆ setIndentPad()

setIndentPad ( string  $pad)

Sets the indentation pad string.

Paramètres
string$padA string that will be prepended to dumped lines, repeated by nesting level
Renvoie
string The previous indent pad

Références AbstractDumper\$indentPad.

◆ setOutput()

setOutput (   $output)

Sets the output destination of the dumps.

Paramètres
callable | resource | string$outputA line dumper callable, an opened stream or an output path
Renvoie
callable|resource|string The previous output destination

Références AbstractDumper\$lineDumper, $output, $this, et null.

Référencé par AbstractDumper\__construct(), et AbstractDumper\dump().

◆ utf8Encode()

utf8Encode ( ?string  $s)
protected

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

Renvoie
string|null

Références $c, et null.

Référencé par CliDumper\dumpKey(), CliDumper\dumpScalar(), CliDumper\dumpString(), et CliDumper\enterHash().

Documentation des champs

◆ $charset

◆ $decimalPoint

$decimalPoint
protected

◆ $defaultOutput

$defaultOutput = 'php://output'
static

◆ $flags

◆ $indentPad

$indentPad = ' '
protected

◆ $line

◆ $lineDumper

◆ $outputStream

$outputStream
protected

◆ DUMP_COMMA_SEPARATOR

const DUMP_COMMA_SEPARATOR = 4

◆ DUMP_LIGHT_ARRAY

const DUMP_LIGHT_ARRAY = 1

◆ DUMP_STRING_LENGTH

const DUMP_STRING_LENGTH = 2

◆ DUMP_TRAILING_COMMA

const DUMP_TRAILING_COMMA = 8

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