-
Notifications
You must be signed in to change notification settings - Fork 397
/
OnDemandIterator.php
141 lines (122 loc) · 3.48 KB
/
OnDemandIterator.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<?php
/**
* This file is part of the Propel package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
namespace Propel\Runtime\Collection;
use Propel\Runtime\Propel;
use Propel\Runtime\Exception\PropelException;
use Propel\Runtime\Formatter\AbstractFormatter;
use Propel\Runtime\Connection\StatementInterface;
/**
* Class for iterating over a statement and returning one Propel object at a time
*
* @author Francois Zaninotto
*/
class OnDemandIterator implements \Iterator
{
/**
* @var ObjectFormatter
*/
protected $formatter;
/**
* @var PDOStatement
*/
protected $stmt;
protected $currentRow;
protected $currentKey;
protected $isValid;
protected $enableInstancePoolingOnFinish;
/**
* @param AbstractFormatter $formatter
* @param StatementInterface $stmt
*/
public function __construct(AbstractFormatter $formatter, StatementInterface $stmt)
{
$this->currentKey = -1;
$this->formatter = $formatter;
$this->stmt = $stmt;
$this->enableInstancePoolingOnFinish = Propel::disableInstancePooling();
}
public function closeCursor()
{
$this->stmt->closeCursor();
}
/**
* Returns the number of rows in the resultset
* Warning: this number is inaccurate for most databases. Do not rely on it for a portable application.
*
* @return integer Number of results
*/
public function count()
{
return $this->stmt->rowCount();
}
// Iterator Interface
/**
* Gets the current Model object in the collection
* This is where the hydration takes place.
*
* @see ObjectFormatter::getAllObjectsFromRow()
*
* @return BaseObject
*/
public function current()
{
return $this->formatter->getAllObjectsFromRow($this->currentRow);
}
/**
* Gets the current key in the iterator
*
* @return string
*/
public function key()
{
return $this->currentKey;
}
/**
* Advances the cursor in the statement
* Closes the cursor if the end of the statement is reached
*/
public function next()
{
$this->currentRow = $this->stmt->fetch(\PDO::FETCH_NUM);
$this->currentKey++;
$this->isValid = (Boolean) $this->currentRow;
if (!$this->isValid) {
$this->closeCursor();
if ($this->enableInstancePoolingOnFinish) {
Propel::enableInstancePooling();
}
}
}
/**
* Initializes the iterator by advancing to the first position
* This method can only be called once (this is a NoRewindIterator)
*/
public function rewind()
{
// check that the hydration can begin
if (null === $this->formatter) {
throw new PropelException('The On Demand collection requires a formatter. Add it by calling setFormatter()');
}
if (null === $this->stmt) {
throw new PropelException('The On Demand collection requires a statement. Add it by calling setStatement()');
}
if (null !== $this->isValid) {
throw new PropelException('The On Demand collection can only be iterated once');
}
// initialize the current row and key
$this->next();
}
/**
* @return boolean
*/
public function valid()
{
return (Boolean) $this->isValid;
}
}