Docs For Class Xyster_Data

Description

Implements interfaces:

Xyster_Data_Clause_Interface

Abstract clause of symbols

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

Direct descendents

Class	Description
Xyster_Data_Sort_Clause	A sort clause
Xyster_Data_Field_Clause	A field clause

Variable Summary

array $_items

Method Summary

Xyster_Data_Clause __construct ( $type, [Xyster_Data_Symbol $symbol = null])

Xyster_Data_Clause add (Xyster_Data_Symbol $symbol)

int count ()

Iterator getIterator ()

Xyster_Data_Clause merge (Xyster_Data_Clause $clause)

boolean remove (Xyster_Data_Symbol $symbol)

array toArray ()

string __toString ()

Variables

array $_items = array() (line 37)

access: protected

Methods

Constructor __construct (line 53)

Creates a new data clause

Extending classes MUST pass the type to this constructor for the class to work as expected.

access: public

Xyster_Data_Clause __construct ( $type, [Xyster_Data_Symbol $symbol = null])

Xyster_Type $type: The class type allowed in this clause
Xyster_Data_Symbol $symbol: A clause or symbol to add

Redefined in descendants as:

Xyster_Data_Sort_Clause::__construct() : Creates a new Sort clause
Xyster_Data_Field_Clause::__construct() : Creates a new Sort clause

add (line 73)

Adds an item to this clause

return: provides a fluent interface
access: public

Xyster_Data_Clause add (Xyster_Data_Symbol $symbol)

Xyster_Data_Symbol $symbol

count (line 88)

Gets the number of entries in the clause

access: public

int count ()

getIterator (line 98)

Gets the iterator for this clause

access: public

Iterator getIterator ()

merge (line 116)

Adds the items from one clause to the end of this one

return: provides a fluent interface
access: public

Xyster_Data_Clause merge (Xyster_Data_Clause $clause)

Xyster_Data_Clause $clause

remove (line 132)

Removes an entry in the clause

return: Whether the clause was changed
access: public

boolean remove (Xyster_Data_Symbol $symbol)

Xyster_Data_Symbol $symbol

toArray (line 148)

Converts the clause into an array of its symbols

access: public

array toArray ()

Implementation of:

Xyster_Data_Clause_Interface::toArray(): Converts the clause into an array of its symbols

__toString (line 159)

Gets the string representation of this object

magic:
access: public

string __toString ()

Implementation of:

Xyster_Data_Symbol::__toString(): Gets the string representation of this object

Class Xyster_Data_Clause