SplObjectStorage Class Reference

Object storage. More...

Inheritance diagram for SplObjectStorage:

[legend]Collaboration diagram for SplObjectStorage:

[legend]List of all members.

Public Member Functions
	attach ($obj)
	contains ($obj)
	count ()
	current ()
	detach ($obj)
	key ()
	next ()
	rewind ()
	valid ()
Private Attributes
	$index = 0
	$storage = array()

---

Detailed Description

Object storage.

Author:

Marcus Boerger

Version:

1.0

Since:

PHP 6.0

This container allows to store objects uniquly without the need to compare them one by one. This is only possible internally. The code represenation here therefore has a complexity of O(n) while the actual implementation has complexity O(1).

Definition at line 23 of file splobjectstorage.inc.

---

Member Function Documentation

SplObjectStorage::attach

(

$

obj

)

Parameters:

$obj

new object to attach to storage if not yet contained

Definition at line 91 of file splobjectstorage.inc.

References contains().

    {
        if (is_object($obj) && !$this->contains($obj))
        {
            $this->storage[] = $obj;
        }
    }

Here is the call graph for this function:

SplObjectStorage::contains

(

$

obj

)

Parameters:

obj

object to look for

Returns:

whether $obj is contained in storage

Definition at line 74 of file splobjectstorage.inc.

Referenced by attach().

    {
        if (is_object($obj))
        {
            foreach($this->storage as $object)
            {
                if ($object === $obj)
                {
                    return true;
                }
            }
        }
        return false;
    }

SplObjectStorage::count

(

)

Returns:

number of objects in storage

Implements Countable.

Definition at line 66 of file splobjectstorage.inc.

    {
        return count($this->storage);
    }

SplObjectStorage::current

(

)

Returns:

current object

Implements Iterator.

Definition at line 51 of file splobjectstorage.inc.

    {
        return current($this->storage);
    }

SplObjectStorage::detach

(

$

obj

)

Parameters:

$obj

object to remove from storage

Definition at line 101 of file splobjectstorage.inc.

References rewind().

    {
        if (is_object($obj))
        {
            foreach($this->storage as $idx => $object)
            {
                if ($object === $obj)
                {
                    unset($this->storage[$idx]);
                    $this->rewind();
                    return;
                }
            }
        }
    }

Here is the call graph for this function:

SplObjectStorage::key

(

)

Returns:

current key

Implements Iterator.

Definition at line 44 of file splobjectstorage.inc.

Referenced by valid().

    {
        return $this->index;
    }

SplObjectStorage::next

(

)

Forward to next element.

Implements Iterator.

Definition at line 58 of file splobjectstorage.inc.

    {
        next($this->storage);
        $this->index++;
    }

SplObjectStorage::rewind

(

)

Rewind to top iterator as set in constructor.

Implements Iterator.

Definition at line 30 of file splobjectstorage.inc.

Referenced by detach().

    {
        rewind($this->storage);
    }

SplObjectStorage::valid

(

)

Returns:

whether iterator is valid

Implements Iterator.

Definition at line 37 of file splobjectstorage.inc.

References key().

    {
        return key($this->storage) !== false;
    }

Here is the call graph for this function:

---

Member Data Documentation

SplObjectStorage::$index = 0 [private]

Definition at line 26 of file splobjectstorage.inc.

SplObjectStorage::$storage = array() [private]

Definition at line 25 of file splobjectstorage.inc.

---

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

• splobjectstorage.inc

---