Also fix displayed commit for renamed files
[gitphp.git] / include / git / ProjectListBase.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
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
<?php
/**
 * GitPHP ProjectListBase
 *
 * Base class that all projectlist classes extend
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Git
 */
 
require_once(GITPHP_GITOBJECTDIR . 'Project.class.php');
 
define('GITPHP_SORT_PROJECT', 'project');
define('GITPHP_SORT_DESCRIPTION', 'descr');
define('GITPHP_SORT_OWNER', 'owner');
define('GITPHP_SORT_AGE', 'age');
 
/**
 * ProjectListBase class
 *
 * @package GitPHP
 * @subpackage Git
 * @abstract
 */
abstract class GitPHP_ProjectListBase implements Iterator
{
        /**
         * projects
         *
         * Stores array of projects internally
         *
         * @access protected
         */
        protected $projects;
 
        /**
         * projectConfig
         *
         * Stores the project configuration internally
         *
         * @access protected
         */
        protected $projectConfig = null;
 
        /**
         * projectSettings
         *
         * Stores the project settings internally
         *
         * @access protected
         */
        protected $projectSettings = null;
 
        /**
         * __construct
         *
         * Constructor
         *
         * @access public
         */
        public function __construct()
        {
                $this->projects = array();
                $this->PopulateProjects();
                $this->Sort();
        }
 
        /**
         * HasProject
         *
         * Test if the projectlist contains
         * the given project
         *
         * @access public
         * @return boolean true if project exists in list
         * @param string $project the project string to find
         */
        public function HasProject($project)
        {
                return ($this->GetProject($project) !== null);
        }
 
        /**
         * GetProject
         *
         * Gets a particular project
         *
         * @access public
         * @return mixed project object or null
         * @param string $project the project to find
         */
        public function GetProject($project)
        {
                if (empty($project))
                        return null;
 
                if (isset($this->projects[$project]))
                        return $this->projects[$project];
 
                return null;
        }
 
        /**
         * GetConfig
         *
         * Gets the config defined for this ProjectList
         *
         * @access public
         */
        public function GetConfig()
        {
                return $this->projectConfig;
        }
 
        /**
         * GetSettings
         *
         * Gets the settings applied to this projectlist
         *
         * @access public
         */
        public function GetSettings()
        {
                return $this->projectSettings;
        }
 
        /**
         * PopulateProjects
         *
         * Populates the internal list of projects
         *
         * @access protected
         */
        abstract protected function PopulateProjects();
 
        /**
         * rewind
         *
         * Rewinds the iterator
         */
        function rewind()
        {
                return reset($this->projects);
        }
 
        /**
         * current
         *
         * Returns the current element in the array
         */
        function current()
        {
                return current($this->projects);
        }
 
        /**
         * key
         *
         * Returns the current key
         */
        function key()
        {
                return key($this->projects);
        }
 
        /**
         * next
         * 
         * Advance the pointer
         */
        function next()
        {
                return next($this->projects);
        }
 
        /**
         * valid
         *
         * Test for a valid pointer
         */
        function valid()
        {
                return key($this->projects) !== null;
        }
 
        /**
         * Sort
         *
         * Sorts the project list
         *
         * @access public
         * @param string $sortBy sort method
         */
        public function Sort($sortBy = GITPHP_SORT_PROJECT)
        {
                switch ($sortBy) {
                        case GITPHP_SORT_DESCRIPTION:
                                uasort($this->projects, array('GitPHP_Project', 'CompareDescription'));
                                break;
                        case GITPHP_SORT_OWNER:
                                uasort($this->projects, array('GitPHP_Project', 'CompareOwner'));
                                break;
                        case GITPHP_SORT_AGE:
                                uasort($this->projects, array('GitPHP_Project', 'CompareAge'));
                                break;
                        case GITPHP_SORT_PROJECT:
                        default:
                                uasort($this->projects, array('GitPHP_Project', 'CompareProject'));
                                break;
                }
        }
 
        /**
         * Count
         *
         * Gets the count of projects
         *
         * @access public
         * @return integer number of projects
         */
        public function Count()
        {
                return count($this->projects);
        }
 
        /**
         * Filter
         *
         * Returns a filtered list of projects
         *
         * @access public
         * @param string $filter filter pattern
         * @return array array of filtered projects
         */
        public function Filter($pattern = null)
        {
                if (empty($pattern))
                        return $this->projects;
 
                $matches = array();
 
                foreach ($this->projects as $proj) {
                        if ((stripos($proj->GetProject(), $pattern) !== false) ||
                            (stripos($proj->GetDescription(), $pattern) !== false) ||
                            (stripos($proj->GetOwner(), $pattern) !== false)) {
                                $matches[] = $proj;
                        }
                }
 
                return $matches;
        }
 
        /**
         * ApplyProjectSettings
         *
         * Applies override settings for a project
         *
         * @access protected
         * @param string $project the project path
         * @param array $projData project data array
         */
        protected function ApplyProjectSettings($project, $projData)
        {
                if (empty($project)) {
                        if (isset($projData['project']) && !empty($projData['project']))
                                $project = $projData['project'];
                        else
                                return;
                }
 
                $projectObj = $this->GetProject($project);
                if (!$projectObj)
                        return;
 
                if (isset($projData['category']) && is_string($projData['category'])) {
                        $projectObj->SetCategory($projData['category']);
                }
                if (isset($projData['owner']) && is_string($projData['owner'])) {
                        $projectObj->SetOwner($projData['owner']);
                }
                if (isset($projData['description']) && is_string($projData['description'])) {
                        $projectObj->SetDescription($projData['description']);
                }
                if (isset($projData['cloneurl']) && is_string($projData['cloneurl'])) {
                        $projectObj->SetCloneUrl($projData['cloneurl']);
                }
                if (isset($projData['pushurl']) && is_string($projData['pushurl'])) {
                        $projectObj->SetPushUrl($projData['pushurl']);
                }
                if (isset($projData['bugpattern']) && is_string($projData['bugpattern'])) {
                        $projectObj->SetBugPattern($projData['bugpattern']);
                }
                if (isset($projData['bugurl']) && is_string($projData['bugurl'])) {
                        $projectObj->SetBugUrl($projData['bugurl']);
                }
                if (isset($projData['compat'])) {
                        $projectObj->SetCompat($projData['compat']);
                }
                if (isset($projData['website']) && is_string($projData['website'])) {
                        $projectObj->SetWebsite($projData['website']);
                }
        }
 
        /**
         * ApplySettings
         *
         * Applies a list of settings to the project list
         *
         * @access protected
         * @param array $settings the array of settings
         */
        public function ApplySettings($settings)
        {
                if ((!$settings) || (count($settings) < 1))
                        return;
 
                foreach ($settings as $proj => $setting) {
                        $this->ApplyProjectSettings($proj, $setting);
                }
 
                $this->projectSettings = $settings;
        }
 
}
 
comments