[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/library/ezc/Graph/src/data_container/ -> base.php (summary)

File containing the abstract ezcGraphChartDataContainer class

Copyright: Copyright (C) 2005-2009 eZ Systems AS. All rights reserved.
License: http://ez.no/licenses/new_bsd New BSD License
Version: 1.5
File Size: 225 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ezcGraphChartDataContainer:: (12 methods):
  __construct()
  addDataSet()
  offsetExists()
  offsetGet()
  offsetSet()
  offsetUnset()
  current()
  next()
  key()
  valid()
  rewind()
  count()


Class: ezcGraphChartDataContainer  - X-Ref

Container class for datasets used by the chart classes. Implements usefull
interfaces for convenient access to the datasets.

__construct( ezcGraphChart $chart )   X-Ref
Constructor

param: ezcGraphChart $chart
return: void

addDataSet( $name, ezcGraphDataSet $dataSet )   X-Ref
Adds a dataset to the charts data

param: string $name Name of dataset
param: ezcGraphDataSet $dataSet
param: mixed $values Values to create dataset with
return: ezcGraphDataSet

offsetExists( $key )   X-Ref
Returns if the given offset exists.

This method is part of the ArrayAccess interface to allow access to the
data of this object as if it was an array.

param: string $key Identifier of dataset.
return: bool True when the offset exists, otherwise false.

offsetGet( $key )   X-Ref
Returns the element with the given offset.

This method is part of the ArrayAccess interface to allow access to the
data of this object as if it was an array.

param: string $key Identifier of dataset.
return: ezcGraphDataSet

offsetSet( $key, $value )   X-Ref
Set the element with the given offset.

This method is part of the ArrayAccess interface to allow access to the
data of this object as if it was an array.

param: string $key
param: ezcGraphDataSet $value
return: void

offsetUnset( $key )   X-Ref
Unset the element with the given offset.

This method is part of the ArrayAccess interface to allow access to the
data of this object as if it was an array.

param: string $key
return: void

current()   X-Ref
Returns the currently selected dataset.

This method is part of the Iterator interface to allow access to the
datasets of this row by iterating over it like an array (e.g. using
foreach).

return: ezcGraphDataSet The currently selected dataset.

next()   X-Ref
Returns the next dataset and selects it or false on the last dataset.

This method is part of the Iterator interface to allow access to the
datasets of this row by iterating over it like an array (e.g. using
foreach).

return: mixed ezcGraphDataSet if the next dataset exists, or false.

key()   X-Ref
Returns the key of the currently selected dataset.

This method is part of the Iterator interface to allow access to the
datasets of this row by iterating over it like an array (e.g. using
foreach).

return: int The key of the currently selected dataset.

valid()   X-Ref
Returns if the current dataset is valid.

This method is part of the Iterator interface to allow access to the
datasets of this row by iterating over it like an array (e.g. using
foreach).

return: bool If the current dataset is valid

rewind()   X-Ref
Selects the very first dataset and returns it.
This method is part of the Iterator interface to allow access to the
datasets of this row by iterating over it like an array (e.g. using
foreach).

return: ezcGraphDataSet The very first dataset.

count()   X-Ref
Returns the number of datasets in the row.

This method is part of the Countable interface to allow the usage of
PHP's count() function to check how many datasets exist.

return: int Number of datasets.



Generated: Thu Jul 28 15:48:31 2011 Cross-referenced by PHPXref 0.7