Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

   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   * Mysqli specific recordset.
  19   *
  20   * @package    core_dml
  21   * @copyright  2008 Petr Skoda (http://skodak.org)
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  require_once (__DIR__.'/moodle_recordset.php');
  28  
  29  /**
  30   * Mysqli specific moodle recordset class
  31   *
  32   * @package    core
  33   * @subpackage dml_driver
  34   * @copyright  2008 Petr Skoda (http://skodak.org)
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class mysqli_native_moodle_recordset extends moodle_recordset {
  38  
  39      protected $result;
  40      protected $current;
  41  
  42      public function __construct($result) {
  43          $this->result  = $result;
  44          $this->current = $this->fetch_next();
  45      }
  46  
  47      public function __destruct() {
  48          $this->close();
  49      }
  50  
  51      private function fetch_next() {
  52          if (!$this->result) {
  53              return false;
  54          }
  55          if (!$row = $this->result->fetch_assoc()) {
  56              $this->result->close();
  57              $this->result = null;
  58              return false;
  59          }
  60  
  61          $row = array_change_key_case($row, CASE_LOWER);
  62          return $row;
  63      }
  64  
  65      public function current(): stdClass {
  66          return (object)$this->current;
  67      }
  68  
  69      #[\ReturnTypeWillChange]
  70      public function key() {
  71          // return first column value as key
  72          if (!$this->current) {
  73              return false;
  74          }
  75          $key = reset($this->current);
  76          return $key;
  77      }
  78  
  79      public function next(): void {
  80          $this->current = $this->fetch_next();
  81      }
  82  
  83      public function valid(): bool {
  84          return !empty($this->current);
  85      }
  86  
  87      public function close() {
  88          if ($this->result) {
  89              $this->result->close();
  90              $this->result  = null;
  91          }
  92          $this->current = null;
  93      }
  94  }