diff options
author | Kore Nordmann <github@kore-nordmann.de> | 2006-09-20 15:12:20 +0000 |
---|---|---|
committer | Kore Nordmann <github@kore-nordmann.de> | 2006-09-20 15:12:20 +0000 |
commit | 9d8baefbdf52a83adfb2efed5ebe4bd7b7f765a7 (patch) | |
tree | a5b7b9bdd5be0ffcbf3456fdb0c6c681d3de2c14 /src/datasets | |
parent | 3fe622918bd1c3e2694ecb2c7d244b9c33eb5693 (diff) | |
download | zetacomponents-graph-9d8baefbdf52a83adfb2efed5ebe4bd7b7f765a7.zip zetacomponents-graph-9d8baefbdf52a83adfb2efed5ebe4bd7b7f765a7.tar.gz |
- Added and improved documentation
Diffstat (limited to 'src/datasets')
-rw-r--r-- | src/datasets/array.php | 4 | ||||
-rw-r--r-- | src/datasets/average.php | 32 | ||||
-rw-r--r-- | src/datasets/base.php | 21 |
3 files changed, 54 insertions, 3 deletions
diff --git a/src/datasets/array.php b/src/datasets/array.php index 1d28aa0..c50665c 100644 --- a/src/datasets/array.php +++ b/src/datasets/array.php @@ -1,6 +1,6 @@ <?php /** - * File containing the abstract ezcGraphArrayDataSet class + * File containing the ezcGraphArrayDataSet class * * @package Graph * @version //autogentag// @@ -8,7 +8,7 @@ * @license http://ez.no/licenses/new_bsd New BSD License */ /** - * Basic class to contain the charts data + * Dataset class which receives arrays and use them as a base for datasets. * * @package Graph */ diff --git a/src/datasets/average.php b/src/datasets/average.php index ade2e49..54d7fd2 100644 --- a/src/datasets/average.php +++ b/src/datasets/average.php @@ -1,6 +1,6 @@ <?php /** - * File containing the abstract ezcGraphDataSetAverage class + * File containing the ezcGraphDataSetAverage class * * @package Graph * @version //autogentag// @@ -21,16 +21,46 @@ class ezcGraphDataSetAveragePolynom extends ezcGraphDataSet { + /** + * Source dataset to base averation on. + * + * @var ezcGraphDataSet + */ protected $source; + /** + * Calculated averation polynom + * + * @var ezcGraphPolynom + */ protected $polynom = false; + /** + * Minimum key + * + * @var float + */ protected $min = false; + /** + * Maximum key + * + * @var float + */ protected $max = false; + /** + * Position of the data iterator. Depends on the configured resolution. + * + * @var int + */ protected $position = 0; + /** + * Container to hold the properties + * + * @var array(string=>mixed) + */ protected $properties; /** diff --git a/src/datasets/base.php b/src/datasets/base.php index 8ab6e5d..e7880c7 100644 --- a/src/datasets/base.php +++ b/src/datasets/base.php @@ -6,11 +6,13 @@ * @version //autogentag// * @copyright Copyright (C) 2005, 2006 eZ systems as. All rights reserved. * @license http://ez.no/licenses/new_bsd New BSD License + * @access private */ /** * Basic class to contain the charts data * * @package Graph + * @access private */ abstract class ezcGraphDataSet implements ArrayAccess, Iterator { @@ -73,6 +75,13 @@ abstract class ezcGraphDataSet implements ArrayAccess, Iterator */ protected $pallet; + /** + * Constructor + * + * @param array $options Default option array + * @return void + * @ignore + */ public function __construct() { $this->label = new ezcGraphDataSetStringProperty( $this ); @@ -84,6 +93,18 @@ abstract class ezcGraphDataSet implements ArrayAccess, Iterator $this->highlight->default = false; } + /** + * Options write access + * + * @throws ezcBasePropertyNotFoundException + * If Option could not be found + * @throws ezcBaseValueException + * If value is out of range + * @param mixed $propertyName Option name + * @param mixed $propertyValue Option value; + * @return void + * @ignore + */ public function __set( $propertyName, $propertyValue ) { switch ( $propertyName ) |