[Summary view]

Differences Between: [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]

   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  declare(strict_types=1);
  18  
  19  namespace core_reportbuilder\local\helpers;
  20  
  21  use stdClass;
  22  
  23  /**
  24   * Class containing helper methods for formatting column data via callbacks
  25   *
  26   * Note that type hints for each $value argument are avoided to allow for these callbacks to be executed when columns are
  27   * aggregated using one of the "Group concatenation" methods, where the value is typically stringified
  28   *
  29   * @package     core_reportbuilder
  30   * @copyright   2021 Sara Arjona <sara@moodle.com> based on Alberto Lara Hernández <albertolara@moodle.com> code.
  31   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  32   */
  33  class format {
  34  
  35      /**
  36       * Returns formatted date.
  37       *
  38       * @param int|null $value Unix timestamp
  39       * @param stdClass $row
  40       * @param string|null $format Format string for strftime
  41       * @return string
  42       */
  43      public static function userdate($value, stdClass $row, ?string $format = null): string {
  44          return $value ? userdate((int) $value, $format) : '';
  45      }
  46  
  47      /**
  48       * Returns yes/no string depending on the given value
  49       *
  50       * @param bool|null $value
  51       * @return string
  52       */
  53      public static function boolean_as_text($value): string {
  54          if ($value === null) {
  55              return '';
  56          }
  57          return (bool) $value ? get_string('yes') : get_string('no');
  58      }
  59  
  60      /**
  61       * Returns float value as a percentage
  62       *
  63       * @param float|null $value
  64       * @return string
  65       */
  66      public static function percent($value): string {
  67          if ($value === null) {
  68              return '';
  69          }
  70          return get_string('percents', 'moodle', format_float((float) $value));
  71      }
  72  }