-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathXPath2NodeIterator.php
More file actions
467 lines (413 loc) · 8.98 KB
/
XPath2NodeIterator.php
File metadata and controls
467 lines (413 loc) · 8.98 KB
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
<?php
/**
* XPath 2.0 for PHP
* _ _ _ _ _
* | | _ _ __ _ _ _(_) __| (_) |_ _ _
* | | | | | |/ _` | | | | |/ _` | | __| | | |
* | |__| |_| | (_| | |_| | | (_| | | |_| |_| |
* |_____\__, |\__, |\__,_|_|\__,_|_|\__|\__, |
* |___/ |_| |___/
*
* @author Bill Seddon
* @version 0.9
* @Copyright (C) 2017 Lyquidity Solutions Limited
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace lyquidity\XPath2;
use lyquidity\XPath2\XPath2NodeIterator\Enumerator;
use lyquidity\XPath2\XPath2NodeIterator\SingleIterator;
use lyquidity\xml\xpath\XPathItem;
use lyquidity\xml\interfaces\ICloneable;
use lyquidity\xml\interfaces\IEnumerable;
use lyquidity\xml\interfaces\IEnumerator;
use lyquidity\XPath2\Iterator\EmptyIterator;
use lyquidity\XPath2\Iterator\ExprIterator;
use lyquidity\xml\xpath\XPathNavigator;
use lyquidity\xml\xpath\XPathNodeType;
use lyquidity\XPath2\DOM\DOMXPathNavigator;
use lyquidity\xml\exceptions\InvalidOperationException;
/**
* XPath2NodeIterator (public abstract)
*/
class XPath2NodeIterator implements ICloneable, IEnumerable //, \Iterator
{
/**
* Used for debugging because it can become confusing which iterator is being processed
* @var string
*/
public $name;
/**
* count
* @var int $count = -1
*/
protected $count = -1;
/**
* curr
* @var XPathItem $curr
*/
private $curr;
/**
* pos
* @var int $pos
*/
private $pos;
/**
* iteratorStarted
* @var bool $iteratorStarted
*/
private $iteratorStarted;
/**
* iteratorFinished
* @var bool $iteratorFinished
*/
private $iteratorFinished;
/**
* Constructor
*/
public function __construct() {}
/**
* Clone
* @return XPath2NodeIterator
*/
public function CloneInstance() {}
/**
* Count the number of nodes of a specific type (default: all)
* @return int
*/
public function getCount()
{
if ( $this->count == -1 )
{
$this->count = $this->getCountType();
}
return $this->count;
}
/**
* Count the number of nodes of a specific type (default: all)
* @param XPathNodeType $kind
* @return int
*/
public function getCountType( $kind = XPathNodeType::All )
{
$count = 0;
/**
* @var XPath2NodeIterator $iter
*/
$iter = $this->CloneInstance();
$iter->Reset();
while ( $iter->MoveNext() )
{
$result = $iter->getCurrent();
if ( $result instanceof ExprIterator )
{
$count += $result->getCount( $kind );
}
else
{
if ( $kind == XPathNodeType::All || $kind == $result->getNodeType() )
{
$count++;
}
}
}
return $count;
}
/**
* Check to see if the iterator is empty
* @returns bool
*/
public function getIsEmpty()
{
/**
* @var XPath2NodeIterator $iter
*/
$iter = $this->CloneInstance();
return ! $iter->MoveNext();
}
/**
* Check to see if the iterator has just one item
* @return bool
*/
public function getIsSingleIterator()
{
/**
* @var XPath2NodeIterator $iter
*/
$iter = $this->CloneInstance();
// $iter->named = "Original";
$part1 = $iter->MoveNext();
if ( $part1 )
{
$part2 = ! $iter->MoveNext();
if ( $part2 ) return true;
}
return false;
}
/**
* check to see if the iterator is a range (always false)
* @return bool
*/
public function getIsRange()
{
return false;
}
/**
* Get the current item
* @return XPathNavigator
*/
public function getCurrent()
{
if ( ! $this->iteratorStarted )
{
throw new InvalidOperationException();
}
return $this->curr;
}
/**
* Get the current position
* @return int
*/
public function getCurrentPosition()
{
if ( ! $this->iteratorStarted )
throw new InvalidOperationException();
return $this->pos;
}
/**
* Get the sequential position
* @return int
*/
public function getSequentialPosition()
{
return $this->getCurrentPosition() + 1;
}
/**
* ResetSequentialPosition
* @return void
*/
public function ResetSequentialPosition()
{
return;
}
/**
* Has the iterator started
* @return bool
*/
public function getIsStarted()
{
return $this->iteratorStarted;
}
/**
* Find out if the iterator has finished (reached the end)
* @return bool
*/
public function getIsFinished()
{
return $this->iteratorFinished;
}
/**
* MoveNext
* @return bool
*/
public function MoveNext()
{
if ( ! $this->iteratorStarted )
{
$this->Init();
$this->pos = -1;
$this->iteratorStarted = true;
}
/**
* @var XPathItem $item
*/
$item = $this->NextItem();
if ( ! is_null( $item ) )
{
$this->pos++;
$this->curr = $item;
return true;
}
$this->iteratorFinished = true;
return false;
}
/**
* Allow the iterators to be reset
*/
public function Reset()
{
$this->iteratorStarted = false;
$this->iteratorFinished = false;
$this->pos = -1;
}
/**
* ToList
* @return array List<XPathItem>
*/
public function ToList()
{
/**
* @var XPath2NodeIterator $iter
*/
$iter = $this->CloneInstance();
/**
* @var \Traversable $iter List<XPathItem>
*/
return iterator_to_array( $iter );
}
/**
* CreateBufferedIterator
* @return XPath2NodeIterator
*/
public function CreateBufferedIterator()
{}
/**
* ToString
* @return string
*/
public function ToString()
{
$sb = array_reduce( $this->ToList(), function( $carry, /** @var XPath2Item $item */ $item )
{
$carry[] = $item->ToString();
return $carry;
}, array() );
$s = implode( ", ", $sb );
return $s;
$sb = array();
foreach ( $this->ToList() as $node )
{
$sb[] = is_object( $node ) ? $node->ToString() : $node;
}
$s = implode( ", ", $sb );
return empty( $s)
? "<empty>"
: $s;
}
/**
* Init
* @return void
*/
protected function Init()
{}
/**
* NextItem
* @return XPathItem
*/
protected function NextItem()
{}
/**
* Create
* @param object $value
* @return XPath2NodeIterator
*/
public static function Create( $value )
{
if ( $value instanceof Undefined )
{
return EmptyIterator::$Shared;
}
if ( $value instanceof XPath2NodeIterator )
{
/**
* @var XPath2NodeIterator $iter
*/
$iter = $value;
return $iter->CloneInstance();
}
$item = $value instanceof XPathItem
? $value
: XPath2Item::fromValue( $value );
return new SingleIterator( $item );
}
/**
* Clone
* @return object
*/
// function CloneInstance()
// {
// return $this->CloneInstance();
// }
/**
* GetEnumerator
* @return IEnumerator
*/
public function GetEnumerator()
{
return new Enumerator( $this );
}
/**
* unit tests
* @param \XBRL_Instance $instance
*/
public static function tests( $instance )
{
$nav = new DOM\DOMXPathNavigator( $instance->getInstanceXml() );
$provider = new NodeProvider( $nav );
$nav2 = $provider->getContext();
$iter = XPath2NodeIterator::Create( $nav );
$result = $iter->getIsSingleIterator();
}
// These functions implement iterator
/**
* Rewind the iterator
* @return boolean
*/
public function rewind()
{
// BMS 2017-07-07 This was originally in the commented.
// Uncommenting now because it appear to be needed in
// /MinimalConformance/Expressions/Operators/SeqOp test fn-union-node-args-001
// $this->pos = -1;
// $this->iteratorStarted = false;
// $this->iteratorFinished = false;
$this->Reset();
return $this->MoveNext();
}
/**
* Get the current value
* @return \lyquidity\xml\xpath\XPathNavigator
*/
public function current()
{
return $this->getCurrent();
}
/**
* Get the current key
* @return number
*/
public function key()
{
return $this->pos;
}
/**
* Move to the next iterator. Return true if the iterator has moved or false.
* @return boolean
*/
public function next()
{
$result = $this->MoveNext();
return $result;
}
/**
* Find out if the iterator is valid (started and not finished)s
* @return boolean
*/
public function valid()
{
return ! is_null( $this->iteratorFinished ) && ! $this->iteratorFinished; // $this->pos >= 0 && $this->pos < $this->count;
}
}
?>