Docs For Class Xyster_Data

Description

A set that holds rows and columns

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

Xyster_Collection_Abstract
   |
   --Xyster_Collection_Set_Abstract
      |
      --Xyster_Collection_Set_Sortable
         |
         --Xyster_Data_Set
            |
            --Xyster_Data_Tuple

Variable Summary

mixed $_names

mixed $_values

Method Summary

static void makeTuples (Xyster_Data_Set $rs, mixed $collection, Xyster_Data_Field_Clause $fields, [ $having = null], [int $limit = 0], [int $offset = 0])

Xyster_Data_Tuple __construct ( $values, [ $contents = null])

array getNames ()

string getValue (string $name)

array getValues ()

array toRow (Xyster_Data_Field_Clause $fields)

Variables

mixed $_names = array() (line 29)

access: protected

mixed $_values = array() (line 30)

access: protected

Inherited Variables

Inherited from Xyster_Data_Set

Xyster_Data_Set::$_columns

Inherited from Xyster_Collection_Abstract

Xyster_Collection_Abstract::$_items

Methods

static method makeTuples (line 104)

Creates the Tuples for a collection

throws: Xyster_Data_Set_Exception if there are no grouped columns in the $fields array
access: public

static void makeTuples (Xyster_Data_Set $rs, mixed $collection, Xyster_Data_Field_Clause $fields, [ $having = null], [int $limit = 0], [int $offset = 0])

Xyster_Data_Set $rs: The dataset to add rows representing the tuples
mixed $collection: The collection of objects/hashtables to use
Xyster_Data_Field_Clause $fields: The field objects to evaluate
array $having: Optional. An array of Xyster_Data_Criterion objects
int $limit: Optional. The maximum number of tuples to create
int $offset: Optional. The number of tuples to skip before adding

Constructor __construct (line 38)

Creates a new tuple

access: public

Xyster_Data_Tuple __construct ( $values, [ $contents = null])

array $values: An associative array of group names and their values
Xyster_Collection_Interface $contents: The objects or arrays to add to the tuple

Redefinition of:

Xyster_Data_Set::__construct(): Creates a new data set

getNames (line 51)

Gets the names of the groups

access: public

array getNames ()

getValue (line 62)

Gets the value of a group

access: public

string getValue (string $name)

string $name: The group name

getValues (line 72)

Gets the values for the groups

access: public

array getValues ()

toRow (line 83)

Flattens the tuple into a data row

access: public

array toRow (Xyster_Data_Field_Clause $fields)

Xyster_Data_Field_Clause $fields

Inherited Methods

Inherited From Xyster_Data_Set

Xyster_Data_Set::__construct()
Xyster_Data_Set::add()
Xyster_Data_Set::addColumn()
Xyster_Data_Set::aggregate()
Xyster_Data_Set::fetchColumn()
Xyster_Data_Set::fetchOne()
Xyster_Data_Set::fetchPairs()
Xyster_Data_Set::filter()
Xyster_Data_Set::getColumns()
Xyster_Data_Set::sortBy()
Xyster_Data_Set::_createColumnsFromItem()

Inherited From Xyster_Collection_Set_Sortable

Xyster_Collection_Set_Sortable::__construct()
Xyster_Collection_Set_Sortable::sort()

Inherited From Xyster_Collection_Set_Abstract

Xyster_Collection_Set_Abstract::add()

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_Data_Tuple

Inherited Variables

Inherited Methods