Docs For Class Xyster_Collection

Description

Implements interfaces:

Xyster_Collection_Set_Interface

Simple implementation of the no-duplicate collection

copyright: Copyright (c) 2007-2008 Irrational Logic (http://irrationallogic.net)
license: New BSD License

Located in /Collection/Set.php (line 31)

Xyster_Collection_Abstract
   |
   --Xyster_Collection
      |
      --Xyster_Collection_Set

Method Summary

Xyster_Collection_Set __construct ([Xyster_Collection_Interface $c = null], [boolean $immutable = false], Xyster_Collection_Interface $set)

boolean add (mixed $item)

Variables

Inherited Variables

Inherited from Xyster_Collection_Abstract

Xyster_Collection_Abstract::$_items

Methods

Constructor __construct (line 39)

Creates a new set

access: public

Xyster_Collection_Set __construct ([Xyster_Collection_Interface $c = null], [boolean $immutable = false], Xyster_Collection_Interface $set)

Xyster_Collection_Interface $set: The values to add to this set
boolean $immutable: Whether the set can be changed
Xyster_Collection_Interface $c

Redefinition of:

Xyster_Collection::__construct(): Creates a new simple collection

add (line 54)

Adds an item to the set

This collection doesn't accept duplicate values, and will return false if the provided value is already in the collection.

return: Whether the set changed as a result of this method
throws: Xyster_Collection_Exception if the collection cannot be modified
access: public

boolean add (mixed $item)

mixed $item: The item to add

Redefinition of:

Xyster_Collection::add(): Adds an item to the collection

Implementation of:

Xyster_Collection_Interface::add(): Adds an item to the collection

Inherited Methods

Inherited From Xyster_Collection

Xyster_Collection::__construct()
Xyster_Collection::add()
Xyster_Collection::clear()
Xyster_Collection::emptyList()
Xyster_Collection::fixedCollection()
Xyster_Collection::fixedList()
Xyster_Collection::fixedMap()
Xyster_Collection::fixedSet()
Xyster_Collection::remove()
Xyster_Collection::removeAll()
Xyster_Collection::retainAll()
Xyster_Collection::using()

Inherited From Xyster_Collection_Abstract

Xyster_Collection_Abstract::add()
Xyster_Collection_Abstract::clear()
Xyster_Collection_Abstract::contains()
Xyster_Collection_Abstract::containsAll()
Xyster_Collection_Abstract::containsAny()
Xyster_Collection_Abstract::count()
Xyster_Collection_Abstract::getIterator()
Xyster_Collection_Abstract::isEmpty()
Xyster_Collection_Abstract::merge()
Xyster_Collection_Abstract::remove()
Xyster_Collection_Abstract::removeAll()
Xyster_Collection_Abstract::retainAll()
Xyster_Collection_Abstract::toArray()
Xyster_Collection_Abstract::__toString()

Class Xyster_Collection_Set

Inherited Variables

Inherited Methods