class.ilChartData.php

Go to the documentation of this file.

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

class ilChartData
{
        protected $type; // [string]
        protected $label; // [string]
        protected $data; // [array]
        protected $line_width; // [int]
        protected $bar_width; // [float] bar
        protected $bar_align; // [string] bar
        protected $bar_horizontal; // [bool] bar
        protected $radius; // [int] points
        protected $steps; // [bool] lines       
        protected $fill; // [float]
        protected $fill_color; // [color/gradient]
        protected $hidden; // [bool]

        public function __construct($a_type)
        {
                $this->setType($a_type);
        }

        public function setType($a_value)
        {
                if($this->isValidType($a_value))
                {
                        $this->type = (string)$a_value;
                }
        }

        public function getType()
        {
                return $this->type;
        }

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

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

        public function isValidType($a_value)
        {
                $all = array("lines", "bars", "points", "pie");
                if(in_array((string)$a_value, $all))
                {
                        return true;
                }
                return false;
        }

        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 setLineWidth($a_value)
        {
                $this->line_width = (int)$a_value;
        }

        public function getLineWidth()
        {
                return $this->line_width;
        }

        public function setLineSteps($a_value)
        {
                $this->steps = (bool)$a_value;
        }

        public function getLineSteps()
        {
                return $this->steps;
        }

        public function setBarOptions($a_width, $a_align = "center", $a_horizontal = false)
        {
                $this->bar_width = (float)$a_width;
                if(in_array((string)$a_align, array("center", "left")))
                {
                        $this->bar_align = (string)$a_align;
                }
                $this->bar_horizontal = (bool)$a_horizontal;
        }

        public function getBarOptions()
        {
                return array("width" => $this->bar_width,
                        "align" => $this->bar_align,
                        "horizontal" => $this->bar_horizontal);
        }

        public function setPointRadius($a_value)
        {
                $this->radius = (int)$a_value;
        }

        public function getPointRadius()
        {
                return $this->radius;
        }

        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);
        }
}

?>