WeakMap Class Reference

Inheritance diagram for WeakMap:

Collaboration diagram for WeakMap:

Public Member Functions
	__construct ()
	count ()
	current ()
	key ()
	next ()
	offsetExists ($object)
	offsetGet ($object)
	offsetSet ($object, $value)
	offsetUnset ($object)
	rewind ()
	valid ()

Constructor & Destructor Documentation

__construct

(

)

Constructs a new map

Member Function Documentation

count

(

)

Counts the number of live entries in the map

Returns

int

current

(

)

Returns the current value being iterated on in the map.

Returns

mixed

key

(

)

Returns the object serving as key in the map, at the current iterating position.

Returns

mixed

next

(

)

Advances to the next map element.

offsetExists

(

$object

)

Checks whether the passed object is referenced in the map.

Parameters

object

$object

Returns

bool

offsetGet

(

$object

)

Returns the value pointed to by a certain object.

Parameters

object

$object

Returns

mixed

offsetSet	(		$object,
			$value
	)

Updates the map with a new key-value pair. If the key already existed in the map, the old value is replaced with the new.

Parameters

object	$object
mixed	$value

offsetUnset

(

$object

)

Removes an entry from the map.

Parameters

object

$object

rewind

(

)

Rewinds the iterator to the beginning of the map.

valid

(

)

Returns whether the iterator is still on a valid map element.

Returns

bool

---

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

• src/spl/stubs/weakref.php