[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/library/ezc/Graph/src/datasets/ -> numeric.php (summary)

File containing the ezcGraphNumericDataSet 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: 287 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ezcGraphNumericDataSet:: (13 methods):
  __construct()
  __set()
  __get()
  getKey()
  offsetExists()
  offsetGet()
  offsetSet()
  current()
  next()
  key()
  valid()
  rewind()
  count()


Class: ezcGraphNumericDataSet  - X-Ref

Dataset for numeric data.

Uses user defined functions for numeric data creation

__construct( $start = null, $end = null, $callback = null )   X-Ref
Constructor

param: float $start Start value for x axis values of function
param: float $end End value for x axis values of function
param: callback $callback Callback function
return: void

__set( $propertyName, $propertyValue )   X-Ref
Options write access

param: mixed $propertyName   Option name
param: mixed $propertyValue  Option value;
return: mixed

__get( $propertyName )   X-Ref
Property get access.
Simply returns a given option.

param: string $propertyName The name of the option to get.
return: mixed The option value.

getKey()   X-Ref
Get the x coordinate for the current position

param: int $position Position
return: float x coordinate

offsetExists( $key )   X-Ref
Returns true if the given datapoint exists
Allows isset() using ArrayAccess.

param: string $key The key of the datapoint to get.
return: bool Wether the key exists.

offsetGet( $key )   X-Ref
Returns the value for the given datapoint
Get an datapoint value by ArrayAccess.

param: string $key The key of the datapoint to get.
return: float The datapoint value.

offsetSet( $key, $value )   X-Ref
Throws a ezcBasePropertyPermissionException because single datapoints
cannot be set in average datasets.

param: string $key The kex of a datapoint to set.
param: float $value The value for the datapoint.
return: void

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

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

return: string The currently selected datapoint.

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

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

return: float datapoint if it exists, or false.

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

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

return: string The key of the currently selected datapoint.

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

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

return: bool If the current datapoint is valid

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

return: float The very first datapoint.

count()   X-Ref
Returns the number of elements in this dataset

return: int



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