SebastianBergmann\RecursionContext\Context Class Reference

Detailed Description

A context containing previously processed arrays and objects when recursively processing a value.

Public Member Functions
	__construct ()
	add (&$value)
	contains (&$value)
	__destruct ()

Constructor & Destructor Documentation

__construct()

SebastianBergmann\RecursionContext\Context::__construct

(

)

Initialises the context

__destruct()

SebastianBergmann\RecursionContext\Context::__destruct

(

)

Member Function Documentation

add()

SebastianBergmann\RecursionContext\Context::add

(

&

$value

)

Adds a value to the context.

Parameters

array | object

$value

The value to add.

Returns

int|string The ID of the stored value, either as a string or integer.

Exceptions

InvalidArgumentException

Thrown if $value is not an array or object

contains()

SebastianBergmann\RecursionContext\Context::contains

(

&

$value

)

Checks if the given value exists within the context.

Parameters

array | object

$value

The value to check.

Returns

int|string|false The string or integer ID of the stored value if it has already been seen, or false if the value is not stored.

Exceptions

InvalidArgumentException

Thrown if $value is not an array or object

---

The documentation for this class was generated from the following file:

• vendor/sebastian/recursion-context/src/Context.php