EZ-Components

include/ezcomponents/Graph/src/axis/container.php

@@ -0,0 +1,221 @@
+<?php
+/**
+ * File containing the ezcGraphAxisContainer class
+ *
+ * @package Graph
+ * @version 1.3
+ * @copyright Copyright (C) 2005-2008 eZ systems as. All rights reserved.
+ * @license http://ez.no/licenses/new_bsd New BSD License
+ */
+/**
+ * The axis container class is internally used to store and validate sets of
+ * axis, and offering access using the SPL ArrayAccess interface to add or
+ * modify its contents.
+ *
+ * @version 1.3
+ * @package Graph
+ */
+class ezcGraphAxisContainer
+    implements
+        Countable,
+        ArrayAccess,
+        Iterator
+{
+    /**
+     * Chart the container is used with
+     * 
+     * @var ezcGraphLineChart
+     */
+    protected $chart;
+
+    /**
+     * Contains the data of a chart
+     * 
+     * @var array(ezcGraphChartElementAxis)
+     */
+    protected $data = array();
+
+    /**
+     * Construct container with corresponding chart.
+     * 
+     * @param ezcGraphLineChart $chart 
+     * @return void
+     * @ignore
+     */
+    public function __construct( ezcGraphLineChart $chart )
+    {
+        $this->chart = $chart;
+    }
+
+    /**
+     * 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.
+     */
+    public function offsetExists( $key )
+    {
+        return isset( $this->data[$key] );
+    }
+
+    /**
+     * 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 ezcGraphChartElementAxis
+     *
+     * @throws ezcBasePropertyNotFoundException
+     *         If no dataset with identifier exists
+     */
+    public function offsetGet( $key )
+    {
+        if ( !isset( $this->data[$key] ) )
+        {
+            throw new ezcBasePropertyNotFoundException( $key );
+        }
+
+        return $this->data[$key];
+    }
+
+    /**
+     * 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 ezcGraphChartElementAxis $value
+     * @return void
+     *
+     * @throws ezcBaseValueException
+     *         If supplied value is not an ezcGraphChartElementAxis
+     */
+    public function offsetSet( $key, $value )
+    {
+        if ( !$value instanceof ezcGraphChartElementAxis )
+        {
+            throw new ezcBaseValueException( $key, $value, 'ezcGraphChartElementAxis' );
+        }
+
+        if ( $key === null )
+        {
+            $key = count( $this->data );
+        }
+
+        // Add axis and configure it with current font and palette
+        $this->data[$key] = $value;
+        $value->font = $this->chart->options->font;
+        $value->setFromPalette( $this->chart->palette );
+
+        return $value;
+    }
+
+    /**
+     * 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
+     */
+    public function offsetUnset( $key )
+    {
+        if ( !isset( $this->data[$key] ) )
+        {
+            throw new ezcBasePropertyNotFoundException( $key );
+        }
+
+        unset( $this->data[$key] );
+    }
+
+    /**
+     * 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 ezcGraphChartElementAxis The currently selected dataset.
+     */
+    public function current()
+    {
+        return current( $this->data );
+    }
+
+    /**
+     * 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 ezcGraphChartElementAxis if the next dataset exists, or false.
+     */
+    public function next()
+    {
+        return next( $this->data );
+    }
+
+    /**
+     * 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.
+     */
+    public function key()
+    {
+        return key( $this->data );
+    }
+
+    /**
+     * 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
+     */
+    public function valid()
+    {
+        return ( current( $this->data ) !== false );
+    }
+
+    /**
+     * 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 ezcGraphChartElementAxis The very first dataset.
+     */
+    public function rewind()
+    {
+        return reset( $this->data );
+    }
+
+    /**
+     * 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.
+     */
+    public function count()
+    {
+        return count( $this->data );
+    }
+}
+
+?>