[Summary 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   * Contains event class for displaying the day name.
  19   *
  20   * @package   core_calendar
  21   * @copyright 2017 Andrew Nicols <andrew@nicols.co.uk>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_calendar\external;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use core\external\exporter;
  30  
  31  /**
  32   * Class for displaying the day view.
  33   *
  34   * @package   core_calendar
  35   * @copyright 2017 Andrew Nicols <andrew@nicols.co.uk>
  36   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class day_name_exporter extends exporter {
  39  
  40      /**
  41       * @var int $dayno The day number.
  42       */
  43      protected $dayno;
  44  
  45      /**
  46       * @var string $shortname The formatted short name of the day.
  47       */
  48      protected $shortname;
  49  
  50      /**
  51       * @var string $fullname The formatted full name of the day.
  52       */
  53      protected $fullname;
  54  
  55      /**
  56       * Constructor.
  57       *
  58       * @param int $dayno The day number.
  59       * @param array $names The list of names.
  60       */
  61      public function __construct($dayno, $names) {
  62          $data = $names + ['dayno' => $dayno];
  63  
  64          parent::__construct($data, []);
  65      }
  66  
  67      /**
  68       * Return the list of properties.
  69       *
  70       * @return array
  71       */
  72      protected static function define_properties() {
  73          return [
  74              'dayno' => [
  75                  'type' => PARAM_INT,
  76              ],
  77              'shortname' => [
  78                  // Note: The calendar type class has already formatted the names.
  79                  'type' => PARAM_RAW,
  80              ],
  81              'fullname' => [
  82                  // Note: The calendar type class has already formatted the names.
  83                  'type' => PARAM_RAW,
  84              ],
  85          ];
  86      }
  87  }