class.ilChartData.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

abstract class ilChartData
{
    protected $type; // [string]
    protected $label; // [string]
    protected $data; // [array]
    protected $fill; // [float]
    protected $fill_color; // [color/gradient]
    protected $hidden; // [bool]

    abstract protected function getTypeString();
    
    public function setHidden($a_value)
    {
        $this->hidden = (bool) $a_value;
    }

    public function isHidden()
    {
        return $this->hidden;
    }

    public function setLabel($a_value)
    {
        $this->label = (string) $a_value;
    }

    public function getLabel()
    {
        return $this->label;
    }

    public function addPoint($a_x, $a_y = null)
    {
        if ($a_y !== null) {
            $this->data[] = array($a_x, $a_y);
        } else {
            $this->data[] = $a_x;
        }
    }

    public function getData()
    {
        return $this->data;
    }

    public function setFill($a_value, $a_color = null)
    {
        $this->fill = $a_value;
        if (ilChart::isValidColor($a_color)) {
            $this->fill_color = $a_color;
        }
    }

    public function getFill()
    {
        return array("fill"=>$this->fill, "color"=>$this->fill_color);
    }
    
    protected function parseDataOptions(array &$a_options)
    {
    }
    
    public function parseData(array &$a_data)
    {
        $series = new stdClass();
        $series->label = str_replace("\"", "\\\"", $this->getLabel());
        
        $series->data = array();
        foreach ($this->getData() as $point) {
            $series->data[] = array($point[0], $point[1]);
        }
            
        $options = array("show"=>($this->isHidden() ? false : true));
                
        $fill = $this->getFill();
        if ($fill["fill"]) {
            $options["fill"] = $fill["fill"];
            if ($fill["color"]) {
                $options["fillColor"] = ilChart::renderColor($fill["color"], $fill["fill"]);
            }
        }
        
        $this->parseDataOptions($options);
        
        $series->{$this->getTypeString()} = $options;
        
        $a_data[] = $series;
    }
    
    public function parseGlobalOptions(stdClass $a_options, ilChart $a_chart)
    {
    }
}