DumperInterface
in
DumperInterface used by Data objects.
Tags
Table of Contents
- dumpScalar() : mixed
- Dumps a scalar value.
- dumpString() : mixed
- Dumps a string.
- enterHash() : mixed
- Dumps while entering an hash.
- leaveHash() : mixed
- Dumps while leaving an hash.
Methods
dumpScalar()
Dumps a scalar value.
public
dumpScalar(Cursor $cursor, string $type, string|int|float|bool $value) : mixed
Parameters
- $cursor : Cursor
- $type : string
-
The PHP type of the value being dumped
- $value : string|int|float|bool
-
The scalar value being dumped
Return values
mixed —dumpString()
Dumps a string.
public
dumpString(Cursor $cursor, string $str, bool $bin, int $cut) : mixed
Parameters
- $cursor : Cursor
- $str : string
-
The string being dumped
- $bin : bool
-
Whether $str is UTF-8 or binary encoded
- $cut : int
-
The number of characters $str has been cut by
Return values
mixed —enterHash()
Dumps while entering an hash.
public
enterHash(Cursor $cursor, int $type, string|int $class, bool $hasChild) : mixed
Parameters
- $cursor : Cursor
- $type : int
-
A Cursor::HASH_* const for the type of hash
- $class : string|int
-
The object class, resource type or array count
- $hasChild : bool
-
When the dump of the hash has child item
Return values
mixed —leaveHash()
Dumps while leaving an hash.
public
leaveHash(Cursor $cursor, int $type, string|int $class, bool $hasChild, int $cut) : mixed
Parameters
- $cursor : Cursor
- $type : int
-
A Cursor::HASH_* const for the type of hash
- $class : string|int
-
The object class, resource type or array count
- $hasChild : bool
-
When the dump of the hash has child item
- $cut : int
-
The number of items the hash has been cut by