[Summary view] [Print] [Text view]

   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 bar.
  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 bar 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_bar extends chart_base {
  36  
  37      /** @var bool Whether the bars should be displayed horizontally or not. */
  38      protected $horizontal = false;
  39  
  40      /**
  41       * Add the horizontal to the parent and return the serialized data.
  42       *
  43       * @return array
  44       */
  45      public function jsonSerialize() { // @codingStandardsIgnoreLine (CONTRIB-6469).
  46          $data = parent::jsonSerialize();
  47          $data['horizontal'] = $this->get_horizontal();
  48          return $data;
  49      }
  50  
  51      /**
  52       * Set the defaults.
  53       */
  54      protected function set_defaults() {
  55          parent::set_defaults();
  56          $yaxis = $this->get_yaxis(0, true);
  57          $yaxis->set_min(0);
  58      }
  59  
  60      /**
  61       * Get whether the bars should be displayed horizontally or not.
  62       *
  63       * @return bool
  64       */
  65      public function get_horizontal() {
  66          return $this->horizontal;
  67      }
  68  
  69      /**
  70       * Get Set whether the bars should be displayed horizontally or not.
  71       *
  72       * @param bool $horizontal True if the bars should be displayed horizontally, false otherwise.
  73       */
  74      public function set_horizontal($horizontal) {
  75          $this->horizontal = $horizontal;
  76      }
  77  }