Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Differences Between: [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   * @package     core_reportbuilder
  27   * @copyright   2021 Sara Arjona <sara@moodle.com> based on Alberto Lara Hernández <albertolara@moodle.com> code.
  28   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29   */
  30  class format {
  31  
  32      /**
  33       * Returns formatted date.
  34       *
  35       * @param int|null $value Unix timestamp
  36       * @param stdClass $row
  37       * @param string|null $format Format string for strftime
  38       * @return string
  39       */
  40      public static function userdate(?int $value, stdClass $row, ?string $format = null): string {
  41          return $value ? userdate($value, $format) : '';
  42      }
  43  
  44      /**
  45       * Returns yes/no string depending on the given value
  46       *
  47       * @param bool|null $value
  48       * @return string
  49       */
  50      public static function boolean_as_text(?bool $value): string {
  51          if ($value === null) {
  52              return '';
  53          }
  54          return $value ? get_string('yes') : get_string('no');
  55      }
  56  
  57      /**
  58       * Returns float value as a percentage
  59       *
  60       * @param float|null $value
  61       * @return string
  62       */
  63      public static function percent(?float $value): string {
  64          if ($value === null) {
  65              return '';
  66          }
  67          return get_string('percents', 'moodle', format_float($value));
  68      }
  69  }