lib/dml/pdo_moodle_recordset.php

   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  * Experimental pdo recordset
  19  *
  20  * @package    core_dml
  21  * @copyright  2008 Andrei Bautu
  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  * Experimental pdo recordset
  31  *
  32  * @package    core_dml
  33  * @copyright  2008 Andrei Bautu
  34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35  */
  36 class pdo_moodle_recordset extends moodle_recordset {
  37
  38     private $sth;
  39     protected $current;
  40
  41     public function __construct($sth) {
  42         $this->sth = $sth;
  43         $this->sth->setFetchMode(PDO::FETCH_ASSOC);
  44         $this->current = $this->fetch_next();
  45     }
  46
  47     public function __destruct() {
  48         $this->close();
  49     }
  50
  51     private function fetch_next() {
  52         if ($row = $this->sth->fetch()) {
  53             $row = array_change_key_case($row, CASE_LOWER);
  54         }
  55         return $row;
  56     }
  57
  58     public function current(): stdClass {
  59         return (object)$this->current;
  60     }
  61
  62     #[\ReturnTypeWillChange]
  63     public function key() {
  64         // return first column value as key
  65         if (!$this->current) {
  66             return false;
  67         }
  68         $key = reset($this->current);
  69         return $key;
  70     }
  71
  72     public function next(): void {
  73         $this->current = $this->fetch_next();
  74     }
  75
  76     public function valid(): bool {
  77         return !empty($this->current);
  78     }
  79
  80     public function close() {
  81         if ($this->sth) {
  82             $this->sth->closeCursor();
  83             $this->sth = null;
  84         }
  85         $this->current = null;
  86     }
  87 }