MDL-55015 core: Add support for axis label in charts
[moodle.git] / lib / classes / chart_base.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Chart base.
19  *
20  * @package    core
21  * @copyright  2016 Frédéric Massart - FMCorz.net
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core;
26 defined('MOODLE_INTERNAL') || die();
28 use coding_exception;
29 use JsonSerializable;
30 use renderable;
32 /**
33  * Chart base class.
34  *
35  * @package    core
36  * @copyright  2016 Frédéric Massart - FMCorz.net
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class chart_base implements JsonSerializable, renderable {
41     protected $series = [];
42     protected $labels = [];
43     protected $title = null;
44     protected $xaxes = [];
45     protected $yaxes = [];
47     public function __construct() {
48     }
50     public function add_series(chart_series $serie) {
51         $this->series[] = $serie;
52     }
54     public function jsonSerialize() {
55         return [
56             'type' => $this->get_type(),
57             'series' => $this->series,
58             'labels' => $this->labels,
59             'title' => $this->title,
60             'axes' => [
61                 'x' => $this->xaxes,
62                 'y' => $this->yaxes,
63             ]
64         ];
65     }
67     private function get_axis($type, $index, $createifnotexists) {
68         if ($type === 'x') {
69             $axes = &$this->xaxes;
70         } else {
71             $axes = &$this->yaxes;
72         }
74         if (!isset($axes[$index])) {
75             if (!$createifnotexists) {
76                 throw new coding_exception('Unknown axis.');
77             }
78             $axes[$index] = new chart_axis();
79         }
81         return $axes[$index];
82     }
84     public function get_labels() {
85         return $this->labels;
86     }
88     public function get_series() {
89         return $this->series;
90     }
92     public function get_title() {
93         return $this->title;
94     }
96     public function get_type() {
97         $classname = get_class($this);
98         return substr($classname, strpos($classname, '_') + 1);
99     }
101     public function get_xaxes() {
102         return $this->xaxes;
103     }
105     public function get_xaxis($index = 0, $createifnotexists = false) {
106         return $this->get_axis('x', $index, $createifnotexists);
107     }
109     public function get_yaxes() {
110         return $this->yaxes;
111     }
113     public function get_yaxis($index = 0, $createifnotexists = false) {
114         return $this->get_axis('y', $index, $createifnotexists);
115     }
117     public function set_labels(array $labels) {
118         $this->labels = $labels;
119     }
121     public function set_title($title) {
122         $this->title = $title;
123     }
125     public function set_xaxis(chart_axis $axis, $index = 0) {
126         return $this->xaxes[$index] = $axis;
127     }
129     public function set_yaxis(chart_axis $axis, $index = 0) {
130         return $this->yaxes[$index] = $axis;
131     }