MDL-55110 core: Add support for smooth lines
[moodle.git] / lib / classes / chart_line.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 line.
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 /**
29  * Chart line class.
30  *
31  * @package    core
32  * @copyright  2016 Frédéric Massart - FMCorz.net
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class chart_line extends chart_base {
37     /** @var bool Whether the line should be smooth or not. */
38     protected $smooth = false;
40     /**
41      * Add the smooth to the parent and return the serialized data.
42      *
43      * @return array
44      */
45     public function jsonSerialize() {
46         $data = parent::jsonSerialize();
47         $data['smooth'] = $this->get_smooth();
48         return $data;
49     }
51     /**
52      * Get whether a lines should be smooth or not.
53      *
54      * @return bool
55      */
56     public function get_smooth() {
57         return $this->smooth;
58     }
60     /**
61      * Set Whether the line should be smooth or not.
62      *
63      * @param bool $smooth True if the line chart should be smooth, false otherwise.
64      */
65     public function set_smooth($smooth) {
66         $this->smooth = $smooth;
67     }
68 }