class.ilChartLegend.php

Go to the documentation of this file.

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

class ilChartLegend
{
    protected $position; // [string]
    protected $columns; // [int]
    protected $margin_x; // [int]
    protected $margin_y; // [int]
    protected $background; // [color]
    protected $opacity; // [float] 0-1
    protected $border; // [color]
    protected $container; // [string]

    public function __construct()
    {
        $this->setPosition("ne");
        $this->setColumns(1);
        $this->setMargin(5, 5);
        $this->setBackground("#888");
        $this->setOpacity(0.1);
        $this->setLabelBorder("#bbb");
    }

    public function setPosition($a_position)
    {
        $all = array("ne", "nw", "se", "sw");
        if (in_array((string) $a_position, $all)) {
            $this->position = (string) $a_position;
        }
    }

    public function getPosition()
    {
        return $this->position;
    }

    public function setColumns($a_value)
    {
        $this->columns = (int) $a_value;
    }

    public function getColumns()
    {
        return $this->columns;
    }

    public function setMargin($a_x, $a_y)
    {
        $this->margin_x = (int) $a_x;
        $this->margin_y = (int) $a_y;
    }

    public function getMargin()
    {
        return array("x" => $this->margin_x, "y" => $this->margin_y);
    }

    public function setBackground($a_color)
    {
        if (ilChart::isValidColor($a_color)) {
            $this->background = $a_color;
        }
    }

    public function getBackground()
    {
        return $this->background;
    }

    public function setOpacity($a_value)
    {
        $a_value = (float) $a_value;
        if ($a_value >= 0 && $a_value <= 1) {
            $this->opacity = $a_value;
        }
    }

    public function getOpacity()
    {
        return $this->opacity;
    }

    public function setLabelBorder($a_color)
    {
        if (ilChart::isValidColor($a_color)) {
            $this->border = $a_color;
        }
    }

    public function getLabelBorder()
    {
        return $this->border;
    }
    
    public function setContainer($a_value)
    {
        $this->container = trim($a_value);
    }
    
    public function getContainer()
    {
        return $this->container;
    }
    
    public function parseOptions(stdClass $a_options)
    {
        $a_options->show = true;
        
        $a_options->noColumns = $this->getColumns();
        $a_options->position = $this->getPosition();
        
        $margin = $this->getMargin();
        $a_options->margin = array($margin["x"], $margin["y"]);
        
        $a_options->backgroundColor = ilChart::renderColor($this->getBackground());
        $a_options->backgroundOpacity = str_replace(",", ".", $this->getOpacity());
        $a_options->labelBoxBorderColor = ilChart::renderColor($this->getLabelBorder());
        
        $container = $this->getContainer();
        if ($container) {
            $a_options->container = '#' . $container;
        }
    }
}