Merge pull request #11 from bessl/patch-2
[gitphp.git] / include / git / reflist / RefList.class.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
142
143
144
145
146
147
148
149
150
151
152
153
154
<?php
/**
 * Base class representing a list of refs
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright (c) 2012 Christopher Han
 * @package GitPHP
 * @subpackage Git\RefList
 */
abstract class GitPHP_RefList implements Iterator
{
        /**
         * The project
         *
         * @var GitPHP_Project
         */
        protected $project;
 
        /**
         * The refs
         *
         * @var array
         */
        protected $refs = array();
 
        /**
         * The inverted refs
         *
         * @var array
         */
        protected $invertedRefs = array();
 
 
        /**
         * Whether data has been loaded
         *
         * @var boolean
         */
        protected $dataLoaded = false;
 
        /**
         * Constructor
         *
         * @param GitPHP_Project $project project
         */
        public function __construct($project)
        {
                if (!$project)
                        throw new Exception('Project is required');
 
                $this->project = $project;
        }
 
        /**
         * Gets the project
         *
         * @return GitPHP_Project project
         */
        public function GetProject()
        {
                return $this->project;
        }
 
        /**
         * Loads data for this ref list
         */
        protected abstract function LoadData();
 
        /**
         * Checks if a ref exists
         *
         * @param string $ref ref name
         * @return boolean true if exists
         */
        public function Exists($ref)
        {
                if (!$this->dataLoaded)
                        $this->LoadData();
 
                return isset($this->refs[$ref]);
        }
 
        /**
         * Rewinds the iterator
         *
         * @return mixed
         */
        function rewind()
        {
                if (!$this->dataLoaded) {
                        $this->LoadData();
                }
 
                return reset($this->refs);
        }
 
        /**
         * Returns the current ref
         *
         * @return mixed
         */
        function current()
        {
                if (!$this->dataLoaded) {
                        $this->LoadData();
                }
 
                return current($this->refs);
        }
 
        /**
         * Returns the current key
         *
         * @return mixed
         */
        function key()
        {
                if (!$this->dataLoaded) {
                        $this->LoadData();
                }
 
                return key($this->refs);
        }
 
        /**
         * Advance the pointer
         *
         * @return mixed
         */
        function next()
        {
                if (!$this->dataLoaded) {
                        $this->LoadData();
                }
 
                return next($this->refs);
        }
 
        /**
         * Test for a valid pointer
         *
         * @return boolean
         */
        function valid()
        {
                if (!$this->dataLoaded) {
                        $this->LoadData();
                }
 
                return key($this->refs) !== null;
        }
 
}
 
comments