MDL-55030 core: Support min and max in axes
[moodle.git] / lib / classes / chart_axis.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 axis.
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 axis 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_axis implements JsonSerializable {
41     const POS_DEFAULT = null;
42     const POS_BOTTOM = 'bottom';
43     const POS_LEFT = 'left';
44     const POS_RIGHT = 'right';
45     const POS_TOP = 'top';
47     protected $label = null;
48     protected $max = null;
49     protected $min = null;
50     protected $position = self::POS_DEFAULT;
51     protected $stepsize = null;
53     public function __construct() {
54     }
56     public function get_label() {
57         return $this->label;
58     }
60     public function get_max() {
61         return $this->max;
62     }
64     public function get_min() {
65         return $this->min;
66     }
68     public function get_position() {
69         return $this->position;
70     }
72     public function get_stepsize() {
73         return $this->stepsize;
74     }
76     public function jsonSerialize() {
77         return [
78             'label' => $this->label,
79             'max' => $this->max,
80             'min' => $this->min,
81             'position' => $this->position,
82             'stepSize' => $this->stepsize,
83         ];
84     }
86     public function set_label($label) {
87         return $this->label = $label;
88     }
90     public function set_max($max) {
91         return $this->max = $max;
92     }
94     public function set_min($min) {
95         return $this->min = $min;
96     }
98     public function set_position($position) {
99         return $this->position = $position;
100     }
102     public function set_stepsize($stepsize) {
103         return $this->stepsize = $stepsize;
104     }