blob: 5d49e1f155ce267863af6c77dde763ad6228202d (
plain)
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
|
/**
* Iterator.h
*
* Base class for iterators. Extension writers that want to create traversable
* classes, should override the Php::Traversable base class. This base class
* forces you to implement a getIterator() method that returns an instance of
* a Php::Iterator class.
*
* In this file you find the signature of the Php::Iterator class. It mostly has
* pure virtual methods, which means that you should create a derived class
* that implements all these methods.
*
* @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
* @copyright 2014 Copernica BV
*/
/**
* Set up namespace
*/
namespace Php {
/**
* Class definition
*/
class PHPCPP_EXPORT Iterator
{
public:
/**
* Constructor
* @param base Class over which the iterator is iterating
*/
Iterator(Base *base) : _object(base) {}
/**
* Destructor
*/
virtual ~Iterator() {}
/**
* Is the iterator on a valid position
* @return bool
*/
virtual bool valid() = 0;
/**
* The value at the current position
* @return Value
*/
virtual Value current() = 0;
/**
* The key at the current position
* @return Value
*/
virtual Value key() = 0;
/**
* Move to the next position
*/
virtual void next() = 0;
/**
* Rewind the iterator to the front position
*/
virtual void rewind() = 0;
protected:
/**
* During the lifetime of the iterator, the object over which
* it iterates is keps as a private variable. This ensures that
* this object is not destructed as long as the iterator exists
* @var Value
*/
Value _object;
};
/**
* End namespace
*/
}
|
