SplObjectStorage

class SplObjectStorage implements Countable, SeekableIterator, Serializable, ArrayAccess (View source)

Methods

void
attach(TObject $object, TValue $info = null)

Adds an object in the storage

void
detach(TObject $object)

Removes an object from the storage

bool
contains(TObject $object)

Checks if the storage contains a specific object

int
addAll(TValue> $storage)

Adds all objects from another storage

int
removeAll(TValue> $storage)

Removes objects contained in another storage from the current storage

int
removeAllExcept(TValue> $storage)

Removes all objects except for those contained in another storage from the current storage

TValue
getInfo()

Returns the data associated with the current iterator entry

void
setInfo(TValue $info)

Sets the data associated with the current iterator entry

int<0, max>
count(int $mode = COUNT_NORMAL)

Returns the number of objects in the storage

void
rewind()

Rewind the iterator to the first storage element

bool
valid()

Returns if the current iterator entry is valid

TKey|null
key()

Returns the index at which the iterator currently is

TValue
current()

Returns the current storage entry

void
next()

Move to the next entry

void
unserialize(string $data)

Unserializes a storage from its string representation

string|null
serialize()

Serializes the storage

bool
offsetExists(TObject $object)

Checks whether an object exists in the storage

void
offsetSet(TObject $object, TValue $info = null)

Associates data to an object in the storage

void
offsetUnset(TObject $object)

Removes an object from the storage

TValue
offsetGet(TObject $object)

Returns the data associated with an object

string
getHash(TObject $object)

Calculate a unique identifier for the contained objects

array
__serialize()

No description

__unserialize(array $data)

No description

array
__debugInfo()

No description

void
seek(int $offset)

No description

Details

at line 2291
void attach(TObject $object, TValue $info = null)

Adds an object in the storage

Parameters

TObject $object

The object to add.

TValue $info

[optional]

The data to associate with the object.

Return Value

void

at line 2307
void detach(TObject $object)

Removes an object from the storage

Parameters

TObject $object

The object to remove.

Return Value

void

at line 2320
bool contains(TObject $object)

Checks if the storage contains a specific object

Parameters

TObject $object

The object to look for.

Return Value

bool

true if the object is in the storage, false otherwise.

at line 2333
int addAll(TValue> $storage)

Adds all objects from another storage

Parameters

TValue> $storage

The storage you want to import.

Return Value

int

at line 2345
int removeAll(TValue> $storage)

Removes objects contained in another storage from the current storage

Parameters

TValue> $storage

The storage containing the elements to remove.

Return Value

int

at line 2358
int removeAllExcept(TValue> $storage)

Since: 5.3

Removes all objects except for those contained in another storage from the current storage

Parameters

TValue> $storage

The storage containing the elements to retain in the current storage.

Return Value

int

at line 2367
TValue getInfo()

Returns the data associated with the current iterator entry

Return Value

TValue

The data associated with the current iterator position.

at line 2379
void setInfo(TValue $info)

Sets the data associated with the current iterator entry

Parameters

TValue $info

The data to associate with the current iterator entry.

Return Value

void

at line 2389
int<0, max> count(int $mode = COUNT_NORMAL)

Returns the number of objects in the storage

Parameters

int $mode [optional]

Return Value

int<0, max>

The custom count as an integer.

The return value is cast to an integer.

at line 2398
void rewind()

Rewind the iterator to the first storage element

Return Value

void

Any returned value is ignored.

at line 2407
bool valid()

Returns if the current iterator entry is valid

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 2416
TKey|null key()

Returns the index at which the iterator currently is

Return Value

TKey|null

TKey on success, or null on failure.

at line 2425
TValue current()

Returns the current storage entry

Return Value

TValue

Can return any type.

at line 2434
void next()

Move to the next entry

Return Value

void

Any returned value is ignored.

at line 2447
void unserialize(string $data)

Since: 5.2

Unserializes a storage from its string representation

Parameters

string $data

The string representation of the object.

Return Value

void

at line 2457
string|null serialize()

Since: 5.2

Serializes the storage

Return Value

string|null

The string representation of the object or null

at line 2470
bool offsetExists(TObject $object)

Checks whether an object exists in the storage

Parameters

TObject $object

The object to look for.

Return Value

bool

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

at line 2485
void offsetSet(TObject $object, TValue $info = null)

Associates data to an object in the storage

Parameters

TObject $object

The object to associate data with.

TValue $info

[optional]

The data to associate with the object.

Return Value

void

at line 2500
void offsetUnset(TObject $object)

Removes an object from the storage

Parameters

TObject $object

The object to remove.

Return Value

void

at line 2512
TValue offsetGet(TObject $object)

Returns the data associated with an object

Parameters

TObject $object

The object to look for.

Return Value

TValue

Can return all value types.

at line 2525
string getHash(TObject $object)

Since: 5.4

Calculate a unique identifier for the contained objects

Parameters

TObject $object

object whose identifier is to be calculated.

Return Value

string

A string with the calculated identifier.

at line 2533
array __serialize()

Since: 7.4

No description

Return Value

array

at line 2541
__unserialize(array $data)

Since: 7.4

No description

Parameters

array $data

at line 2549
array __debugInfo()

Since: 7.4

No description

Return Value

array

at line 2556
void seek(int $offset)

Since: 8.4

No description

Parameters

int $offset

The position to seek to.

Return Value

void