Référence de la classe Data

Graphe d'héritage de Data:

Fonctions membres publiques
	__construct (array $data)
	getType ()
	getValue ($recursive=false)
	count ()
	getIterator ()
	__get (string $key)
	__isset (string $key)
	offsetExists ($key)
	offsetGet ($key)
	offsetSet ($key, $value)
	offsetUnset ($key)
	__toString ()
	withMaxDepth (int $maxDepth)
	withMaxItemsPerDepth (int $maxItemsPerDepth)
	withRefHandles (bool $useRefHandles)
	withContext (array $context)
	seek ($key)
	dump (DumperInterface $dumper)

Fonctions membres privées
	dumpItem (DumperInterface $dumper, Cursor $cursor, array &$refs, $item)
	dumpChildren (DumperInterface $dumper, Cursor $parentCursor, array &$refs, array $children, int $hashCut, int $hashType, bool $dumpKeys)
	getStub ($item)

Attributs privés
	$data
	$position = 0
	$key = 0
	$maxDepth = 20
	$maxItemsPerDepth = -1
	$useRefHandles = -1
	$context = []

Description détaillée

Auteur

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

Documentation des constructeurs et destructeur

__construct()

__construct

(

array

$data

)

Paramètres

array

$data

An array as returned by ClonerInterface::cloneVar()

Références Data\$data.

Documentation des fonctions membres

__get()

__get

(

string

$key

)

Références Data\$data, $item, Data\getStub(), null, et Data\seek().

Référencé par Data\offsetGet().

__isset()

__isset

(

string

$key

)

Renvoie

bool

Références null, et Data\seek().

Référencé par Data\offsetExists().

__toString()

__toString

(

)

Renvoie

string

Références $value, Data\count(), Data\getType(), et Data\getValue().

count()

count

(

)

Renvoie

int

Références Data\getValue().

Référencé par Data\__toString(), Data\dumpChildren(), Data\dumpItem(), et Data\getStub().

dump()

dump

(

DumperInterface

$dumper

)

Dumps data with a DumperInterface dumper.

Références $this, class, Data\dumpItem(), et DumperInterface\dumpScalar().

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

dumpChildren()

dumpChildren ( DumperInterface  $dumper, Cursor  $parentCursor, array &  $refs, array  $children, int  $hashCut, int  $hashType, bool  $dumpKeys  )

private

Dumps children of hash structures.

Renvoie

int The final number of removed items

Références Data\$key, $this, Data\count(), Data\dumpItem(), et null.

Référencé par Data\dumpItem().

dumpItem()

dumpItem ( DumperInterface  $dumper, Cursor  $cursor, array &  $refs,   $item  )

private

Depth-first dumping of items.

Paramètres

mixed

$item

A Stub object or the original value being dumped

Références $item, Data\$maxItemsPerDepth, $r, $type, Data\count(), Data\dumpChildren(), DumperInterface\dumpScalar(), DumperInterface\dumpString(), elseif, DumperInterface\enterHash(), Data\getStub(), Cursor\HASH_INDEXED, DumperInterface\leaveHash(), null, Stub\STRING_BINARY, Stub\TYPE_ARRAY, Stub\TYPE_OBJECT, Stub\TYPE_REF, Stub\TYPE_RESOURCE, et Stub\TYPE_STRING.

Référencé par Data\dump(), et Data\dumpChildren().

getIterator()

getIterator

(

)

Renvoie

Références $value, class, et Data\getValue().

getStub()

getStub (   $item )

private

Références $item, Data\count(), et Stub\TYPE_ARRAY.

Référencé par Data\__get(), Data\dumpItem(), Data\getValue(), et Data\seek().

getType()

getType

(

)

Renvoie

string|null

Références $item, Data\$key, Data\$position, null, Stub\TYPE_ARRAY, Stub\TYPE_OBJECT, Stub\TYPE_REF, Stub\TYPE_RESOURCE, et Stub\TYPE_STRING.

Référencé par Data\__toString().

getValue()

getValue

(

$recursive = false

)

Returns a native representation of the original value.

Paramètres

array | bool

$recursive

Whether values should be resolved recursively or not

Renvoie

string|int|float|bool|array|Data[]|null

Références $item, Data\$key, Data\$position, $this, Data\getStub(), Stub\TYPE_REF, et Stub\TYPE_STRING.

Référencé par Data\__toString(), Data\count(), et Data\getIterator().

offsetExists()

offsetExists

(

$key

)

Renvoie

bool

Références Data\$key, et Data\__isset().

offsetGet()

offsetGet

(

$key

)

Renvoie

mixed

Références Data\$key, et Data\__get().

offsetSet()

offsetSet	(		$key,
			$value
	)

Renvoie

void

Références class.

offsetUnset()

offsetUnset

(

$key

)

Renvoie

void

Références class.

seek()

seek

(

$key

)

Seeks to a specific key in nested data structures.

Paramètres

string | int

$key

The key to seek to

Renvoie

static|null

Références Data\$data, $item, Data\$key, Data\$position, $this, Data\getStub(), null, Caster\PREFIX_DYNAMIC, Caster\PREFIX_PROTECTED, Caster\PREFIX_VIRTUAL, Stub\TYPE_ARRAY, Stub\TYPE_OBJECT, Stub\TYPE_REF, et Stub\TYPE_RESOURCE.

Référencé par Data\__get(), et Data\__isset().

withContext()

withContext

(

array

$context

)

Renvoie

static

Références Data\$context, Data\$data, et $this.

withMaxDepth()

withMaxDepth

(

int

$maxDepth

)

Returns a depth limited clone of $this.

Renvoie

static

Références Data\$data, Data\$maxDepth, et $this.

withMaxItemsPerDepth()

withMaxItemsPerDepth

(

int

$maxItemsPerDepth

)

Limits the number of elements per depth level.

Renvoie

static

Références Data\$data, Data\$maxItemsPerDepth, et $this.

withRefHandles()

withRefHandles

(

bool

$useRefHandles

)

Enables/disables objects' identifiers tracking.

Paramètres

bool

$useRefHandles

False to hide global ref. handles

Renvoie

static

Références Data\$data, $this, et Data\$useRefHandles.

Documentation des champs

$context

$context = []

private

Référencé par Data\withContext().

$data

$data

private

Référencé par Data\__construct(), Data\__get(), SeekingData\dump(), SeekingData\seek(), Data\seek(), Data\withContext(), Data\withMaxDepth(), Data\withMaxItemsPerDepth(), et Data\withRefHandles().

$key

$key = 0

private

Référencé par Data\dumpChildren(), Data\getType(), Data\getValue(), Data\offsetExists(), Data\offsetGet(), et Data\seek().

$maxDepth

$maxDepth = 20

private

Référencé par Data\withMaxDepth().

$maxItemsPerDepth

$maxItemsPerDepth = -1

private

Référencé par Data\dumpItem(), et Data\withMaxItemsPerDepth().

$position

$position = 0

private

Référencé par Data\getType(), Data\getValue(), et Data\seek().

$useRefHandles

$useRefHandles = -1

private

Référencé par Data\withRefHandles().

---

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

• Data.php