lib/classes/chart_pie.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/>.
  16
  17 /**
  18  * Chart pie.
  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
  25 namespace core;
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 /**
  29  * Chart pie 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_pie extends chart_base {
  36
  37     /** @var bool $doughnut Whether the chart should be displayed as doughnut. */
  38     protected $doughnut = null;
  39
  40     /**
  41      * Get parent JSON and add specific pie related attributes and values.
  42      *
  43      * @return array
  44      */
  45     public function jsonSerialize() { // @codingStandardsIgnoreLine (CONTRIB-6469).
  46         $data = parent::jsonSerialize();
  47         $data['doughnut'] = $this->get_doughnut();
  48         return $data;
  49     }
  50
  51     /**
  52      * Get whether the chart should be displayed as doughnut.
  53      *
  54      * @return bool
  55      */
  56     public function get_doughnut() {
  57         return $this->doughnut;
  58     }
  59
  60     /**
  61      * Set whether the chart should be displayed as doughnut.
  62      *
  63      * @param bool $doughnut True for doughnut type, false for pie.
  64      */
  65     public function set_doughnut($doughnut) {
  66         $this->doughnut = $doughnut;
  67     }
  68 }