-
Notifications
You must be signed in to change notification settings - Fork 0
/
Server.php
428 lines (367 loc) · 10.6 KB
/
Server.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
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
<?php
namespace mongoglue;
/**
* This object represents a server for MongoDB. It can huose a connection pool allowing it to be reused for multiple servers
* by simply switching the connections.
*
* The default scope for none explicitly defined variables and functions is public
*
* @example $mongo = new mongoglue\Server(new MongoClient(), array('DocumentDir' => __DIRECTORY__.'/Documents'));
*/
class Server{
/**
* Default safe mode unless stated otherwise.
* @var int|string
*/
public $writeConcern = 1;
/**
* Default value for journal writes
* @var boolean
*/
public $journaled = false;
/**
* The root of all evil, where the very base of all files reside
*
* @var string
*/
public $includeRoot;
/**
* This is where the document models are based
*
* @var string
*/
public $documentDir;
/**
* This is the namespace where documents are stored
* @var string
*/
public $documentns;
/**
* Server Name, default is null
*
* @var string
*/
private $name;
/**
* The active MongoClient object representing a connection to a server
*
* @var MongoClient
*/
private $connection;
/**
* An array of cached MongoClient connections
*
* @var array
*/
private $connectionList = array();
/**
* The namespace separator
*
* @var string
*/
private $namespaceSeparator = '\\';
/**
* The default file extension for all files you make
*
* @var string
*/
private $fileExtension = '.php';
/**
* This holds object cache of fields for model and reflection results
* so we don't have to go get it everytime and waste resources
* @var array
*/
private $objCache;
/**
* This will select a database automatically
*/
function __get($k){
return $this->selectDB($k);
}
/**
* Run the setup stuff that needs to be run
*
* @param MongoClient $connection
* @param array $options
*/
function __construct($connection, $options = array()){
$this->addConnection('default', $connection);
$this->setConnection('default');
foreach($options as $k=>$v){
$this->$k = $v;
}
// We take the folder above for our runtime root since all calls will be mongoglue\server etc.
$this->includeRoot = dirname(dirname(__FILE__));
$this->registerAutoloader();
}
/**
* This method will call stuff on the current active connection (MongoClient) so
* as to create a transparency between the Server and it connection. I am still unsure
* about this so best not to rely on it
*
* @param string $method
* @param mixed $params
*/
function __call($method, $params = array()){
if(method_exists($this->connection, $method)){
return call_user_func_array(array($this->connection, $method), $params);
}
}
/**
* Gets the server name
*
* @return string $name
*/
function getName(){
return $this->name;
}
/**
* Gets the connection pool
*
* @return array of MongoClient
*/
function getConnectionList(){
return $this->connectionList;
}
/**
* This will select a database and return it
*
* @param string $db
* @return \mongoglue\mongoglue\Database
*/
function selectDB($db){
return new \mongoglue\Database($db, $this);
}
/**
* This function would normally allow you to select a collection from a database on the server level
* however I have deprecated this function since I see it as a confusion of roles within the driver.
* You can get this more easily by just using the __get down to the database class.
*
* @deprecated
* @param string $db
* @param string $collection
*/
function selectCollection($db, $collection){
trigger_error('Please use the database class for this by doing a __get() or selectDB() on this class', E_DEPRECATED);
}
/**
* This adds a possible connection to the pool for use
*
* @param string|int $k
* @param MongoClient $connection
*
* @return int|string $k either the input or the output of adding it to the connectionList
*/
function addConnection($k = false /* I want to add ability to not have to use $k */, $connection){
if(!$k){
if(version_compare(phpversion('mongo'), '1.3.0', '<')){
// If this is previous version make sure we are connected
$connection->connect();
}
$this->connectionList[] = $connection;
return key($this->connectionList);
}else{
$this->connectionList[$k] = $connection;
return $k;
}
}
/**
* Returns the active connection
*
* @return \mongoglue\MongoClient
*/
function connection(){
return $this->connection;
}
/**
* This sets the active connection to via either a MongoClient object or name of a connection
*
* @param MongoClient|string|int $connection
*/
function setConnection($connection){
if($connection instanceof \MongoClient || $connection instanceof \Mongo){
$this->name = '';
$this->connection = $connection;
return true;
}elseif(isset($this->connectionList[$connection])){
$this->name = $connection;
$this->connection = $this->connectionList[$connection];
return true;
}
return false;
}
/**
* This removes a connection from the pool and if it is the active connection it will disconnect
*
* @param string|MongoClient $k
*/
function removeConnection($k){
if($k instanceof \MongoClient || $k instanceof \Mongo){
foreach($this->connectionList as $k => $connection){
if($k===$connection) unset($this->connectionList[$k]);
}
if($this->connection===$k){
$this->name = '';
$this->connection = null;
}
return true;
}elseif(isset($this->connectionList[$k])){
$connection = $this->connectionList[$k];
$connection->close();
if($this->name == $k){
$this->name = '';
$this->connection = null;
}
unset($this->connectionList[$k]);
return true;
}
return false; // No remove needed
}
/**
* Registers our Autoloader
*/
function registerAutoloader(){
spl_autoload_register(array($this, 'loadClass'));
}
/**
* Unregisters the autoloader, useful for when you need to put something before it
*/
function unregisterAutoloader(){
spl_autoload_unregister(array($this, 'loadClass'));
}
/**
* Our actual autoloader
*
* @param string $cname
* @param string $type
* @return boolean or the loaded file contents
*/
function loadClass($cname, $type = null){
// What I need to do is resolve the namespace of the class signature to understand what I am loading
// unless the type is set in which case I kow exactly what I am doing
if($filename = $this->canLoadClass($cname, $type)){
return require_once $filename;
}else{
//trigger_error("The file {$cname} does not exist within mongoglue");
return false;
}
}
/**
* Checks to see if the file we want to load really exists
*
* @param string $cname
* @param string $type
* @return boolean|string
*/
function canLoadClass($cname, $type = null){
if(strlen(trim($cname)) <= 0)
return false;
// If there is any trailing \ lets get rid of them
$cname = trim($cname, '\\');
// If this is looking for a core file then let it, otherwise do not
if(preg_match('/^mongoglue/', $cname) > 0){
$resolved_namespace = str_replace($this->namespaceSeparator, DIRECTORY_SEPARATOR, $cname);
$resolved_filename = ( $this->includeRoot !== null ? $this->includeRoot . DIRECTORY_SEPARATOR : '' ) .
$resolved_namespace . $this->fileExtension;
if(file_exists($resolved_filename)){
return $resolved_filename;
}
}
// Then I am dealing with most likely a document, if not then I dunno what you are
$resolved_filename = ( $this->documentDir !== null ? $this->documentDir . DIRECTORY_SEPARATOR : '' ) .
$cname . $this->fileExtension;
if(file_exists($resolved_filename)){
return $resolved_filename;
}
return false;
}
/**
* Basically returns a document class name with it's namespace so we can load it in other places.
* @param string $cname
* @return string
*/
function resolveDocumentClassName($cname){
return $this->documentns ? $this->documentns . $this->namespaceSeparator . $cname : $cname;
}
/**
* Provides a method by which to set some sort of cache for a Document to
* remember things such as reflection of fields
* @param string $name
* @param array $virtualFields
* @param array $documentFields
*/
function setObjectCache($name, $virtualFields = null, $documentFields = null){
if($virtualFields)
$this->objCache[$name]['virtual'] = $virtualFields;
if($documentFields)
$this->objCache[$name]['document'] = $documentFields;
}
/**
* Gets the virtual fields of a Document from cache
* @param string $name
* @return NULL|array
*/
function getVirtualObjCache($name){
return isset($this->objCache[$name], $this->objCache[$name]['virtual']) ? $this->objCache[$name]['virtual'] : null;
}
/**
* Gets the field of a Document from cache
* @param string $name
* @return NULL|array
*/
function getFieldObjCache($name){
return isset($this->objCache[$name], $this->objCache[$name]['document']) ? $this->objCache[$name]['document'] : null;
}
/**
* Just gets the object cache for a Document
* @param string $name
* @return NULL|array
*/
function getObjCache($name){
return isset($this->objCache[$name]) ? $this->objCache[$name] : null;
}
/**
* This recursively merges two arrays and returns the result
* @return void|array
*/
function merge(){
if (func_num_args() < 2) {
trigger_error(__FUNCTION__ .' needs two or more array arguments', E_USER_WARNING);
return;
}
$arrays = func_get_args();
$merged = array();
while ($arrays) {
$array = array_shift($arrays);
if (!is_array($array)) {
trigger_error(__FUNCTION__ .' encountered a non array argument', E_USER_WARNING);
return;
}
if (!$array)
continue;
foreach ($array as $key => $value)
if (is_string($key))
if (is_array($value) && array_key_exists($key, $merged) && is_array($merged[$key]))
$merged[$key] = call_user_func(array($this,__FUNCTION__), $merged[$key], $value);
else
$merged[$key] = $value;
else
$merged[] = $value;
}
return $merged;
}
/**
* Gets the default write concern options for all queries through active record
* @return array
*/
function getDefaultWriteConcern(){
if(version_compare(phpversion('mongo'), '1.3.0', '<')){
if((bool)$this->writeConcern){
return array('safe' => true);
}
}else{
return array('w' => $this->writeConern, 'j' => $this->journaled);
}
return array();
}
}