includes/db/ORMResult.php

   1 <?php
   2 /**
   3  * Result of a ORMTable::select, which returns ORMRow objects.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @since 1.20
  21  *
  22  * @file ORMResult.php
  23  *
  24  * @licence GNU GPL v2 or later
  25  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  26  */
  27
  28 class ORMResult implements Iterator {
  29
  30         /**
  31          * @var ResultWrapper
  32          */
  33         protected $res;
  34
  35         /**
  36          * @var integer
  37          */
  38         protected  $key;
  39
  40         /**
  41          * @var ORMRow
  42          */
  43         protected $current;
  44
  45         /**
  46          * @var ORMTable
  47          */
  48         protected $table;
  49
  50         /**
  51          * @param ORMTable $table
  52          * @param ResultWrapper $res
  53          */
  54         public function __construct( ORMTable $table, ResultWrapper $res ) {
  55                 $this->table = $table;
  56                 $this->res = $res;
  57                 $this->key = 0;
  58                 $this->setCurrent( $this->res->current() );
  59         }
  60
  61         /**
  62          * @param $row
  63          */
  64         protected function setCurrent( $row ) {
  65                 if ( $row === false ) {
  66                         $this->current = false;
  67                 } else {
  68                         $this->current = $this->table->newFromDBResult( $row );
  69                 }
  70         }
  71
  72         /**
  73          * @return integer
  74          */
  75         public function count() {
  76                 return $this->res->numRows();
  77         }
  78
  79         /**
  80          * @return boolean
  81          */
  82         public function isEmpty() {
  83                 return $this->res->numRows() === 0;
  84         }
  85
  86         /**
  87          * @return ORMRow
  88          */
  89         public function current() {
  90                 return $this->current;
  91         }
  92
  93         /**
  94          * @return integer
  95          */
  96         public function key() {
  97                 return $this->key;
  98         }
  99
 100         public function next() {
 101                 $row = $this->res->next();
 102                 $this->setCurrent( $row );
 103                 $this->key++;
 104         }
 105
 106         public function rewind() {
 107                 $this->res->rewind();
 108                 $this->key = 0;
 109                 $this->setCurrent( $this->res->current() );
 110         }
 111
 112         /**
 113          * @return boolean
 114          */
 115         public function valid() {
 116                 return $this->current !== false;
 117         }
 118
 119 }