<?php

/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */

/**
 * Image_Graph - PEAR PHP OO Graph Rendering Utility.
 *
 * PHP versions 4 and 5
 *
 * LICENSE: This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version. This library is distributed in the hope that it
 * will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
 * General Public License for more details. You should have received a copy of
 * the GNU Lesser General Public License along with this library; if not, write
 * to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 * 02111-1307 USA
 *
 * @category   Images
 * @package    Image_Graph
 * @subpackage Fill
 * @author     Jesper Veggerby <pear.nosey@veggerby.dk>
 * @copyright  Copyright (C) 2003, 2004 Jesper Veggerby Hansen
 * @license    http://www.gnu.org/copyleft/lesser.html  LGPL License 2.1
 * @version    CVS: $Id$
 * @link       http://pear.php.net/package/Image_Graph
 */
 
/**
 * Include file Image/Graph/Fill.php
 */
require_once 'Image/Graph/Fill.php';

/**
 * A sequential array of fillstyles.
 *
 * This is used for filling multiple objects within the same element with
 * different styles. This is done by adding multiple fillstyles to a FillArrray
 * structure. The fillarray will then when requested return the 'next' fillstyle
 * in sequential order. It is possible to specify ID tags to each fillstyle,
 * which is used to make sure some data uses a specific fillstyle (i.e. in a
 * multiple-/stackedbarchart you name the {@link Image_Graph_Dataset}s and uses
 * this name as ID tag when adding the dataset's associated fillstyle to the
 * fillarray.
 *
 * @category   Images
 * @package    Image_Graph
 * @subpackage Fill
 * @author     Jesper Veggerby <pear.nosey@veggerby.dk>
 * @copyright  Copyright (C) 2003, 2004 Jesper Veggerby Hansen
 * @license    http://www.gnu.org/copyleft/lesser.html  LGPL License 2.1
 * @version    Release: @package_version@
 * @link       http://pear.php.net/package/Image_Graph
 */
class Image_Graph_Fill_Array extends Image_Graph_Fill
{

    /**
     * The fill array
     * @var array
     * @access private
     */
    var $_fillStyles = array ();

    /**
     * Resets the fillstyle
     *
     * @access private
     */
    function _reset()
    {
        reset($this->_fillStyles);
    }

    /**
     * Add a fill style to the array
     *
     * @param Image_Graph_Fill $style The style to add
     * @param string $id The id or name of the style
     */
    function &add(& $style, $id = '')
    {
        if ($id == '') {
            $this->_fillStyles[] =& $style;
        } else {
            $this->_fillStyles[$id] =& $style;
        }
        reset($this->_fillStyles);
        return $style;
    }

    /**
     * Add a color to the array
     *
     * @param int $color The color
     * @param string $id The id or name of the color
     */
    function addColor($color, $id = false)
    {
        if ($id !== false) {
            $this->_fillStyles[$id] = $color;
        } else {
            $this->_fillStyles[] = $color;
        }
        reset($this->_fillStyles);
    }

    /**
     * Return the fillstyle
     *
     * @return int A GD fillstyle
     * @access private
     */
    function _getFillStyle($ID = false)
    {
        if (($ID === false) || (!isset($this->_fillStyles[$ID]))) {
            $ID = key($this->_fillStyles);
            if (!next($this->_fillStyles)) {
                reset($this->_fillStyles);
            }
        }
        $fillStyle =& $this->_fillStyles[$ID];

        if (is_object($fillStyle)) {
            return $fillStyle->_getFillStyle($ID);
        } elseif ($fillStyle !== null) {
            return $fillStyle;
        } else {
            return parent::_getFillStyle($ID);
        }
    }

}

?>