MDL-55015 core: Add support for axis label in charts
[moodle.git] / lib / classes / chart_axis.php
CommitLineData
f5474e65
FM
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/>.
16
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 */
24
25namespace core;
26defined('MOODLE_INTERNAL') || die();
27
28use coding_exception;
29use JsonSerializable;
30use renderable;
31
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 */
39class chart_axis implements JsonSerializable {
40
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';
46
47 protected $label = null;
48 protected $position = self::POS_DEFAULT;
49
50 public function __construct() {
51 }
52
53 public function get_label() {
54 return $this->label;
55 }
56
57 public function get_position() {
58 return $this->position;
59 }
60
61 public function jsonSerialize() {
62 return [
63 'label' => $this->label,
64 'position' => $this->position,
65 ];
66 }
67
68 public function set_label($label) {
69 return $this->label = $label;
70 }
71
72 public function set_position($position) {
73 return $this->position = $position;
74 }
75
76}