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
468
469
470
471
472
473
474
475
476
477
|
<?
/**
* @TODO: give me a description
*/
class Model
{
/**
* @b Private. The name of the database table its linked to.
* @private
*/
public $tableName;
/**
* @b public. Boolean if we use object caching or not. you should understand the object caching system before you use this.
*/
public $useObjectCaching = false;
/**
* how long we cache the object data in seconds. defaults to a bit over a month (3 million seconds)
*/
public static $objectCacheLife = 3000000;
/**
* The id that references the table.
*/
public $id = 0;
/**
* @b Private. Array of fields that are dirty.
*/
private $dirtyFields = array();
/**
* @b Protected. Internal data array
*/
private $data = array();
/**
* Creates a new BaseObject.
*
* @param $data if $data is an integer id, in which case it will load the data from the database.
* If $data is an array, it will load the data from the array to the equivalent properties of the object.
*
* @param $tableName the name of the table to reference.
*/
public function __construct($data, $tableName)
{
//set our table name...
$this->tableName = $tableName;
//omg noob... dont forget to load!
$this->load($data);
}
/**
* This function translates the object to a string.
* @return the string value for the funtction
**/
public function __toString()
{
return $this->getName();
}
/**
* This function is for getting at the various data internal to the object
* @param $name is the name of the field
* @return the value from the data array or the id
*/
public function get($name)
{
return $this->data[$name];
}
/**
* Function to set data values for the object
* @param $name is the name of the field
* @param $value is the stored value
*/
public function set($name, $value)
{
$this->dirtyFields[$name] = 1;
$this->data[$name] = $value;
}
/**
* This function handles loading the data into the object.
*
* @todo this will change in v2.2 to load the data from cache or look it up from the db.
*
* @param $data either an id of an object or an array of data that
* represents that object.
*/
public function load($data)
{
//did we get an array of data to set?
if (is_array($data))
$this->hydrate($data);
//nope, maybe its an id for the database...
else if ($data)
$this->loadData($data, $deep);
}
/**
* load our objects data.
*
* @depreciated this will be changed around in v2.2
* @todo remove and put comments / tags into load. also make a loadfromdb function
*/
protected function loadData($id)
{
$id = (int)$id;
if ($id > 0)
{
//set our id first.
$this->id = $id;
//try our cache.. if it works, then we're good.
if (!$this->loadCacheData())
{
$this->lookupData();
if ($this->useObjectCaching)
$this->setCache();
}
}
}
/**
* get our data from the db.
*
* @todo update this whole data loading process to be much smoother
*/
protected function lookupData()
{
//nope, load it normally.
$data = $this->getData(true);
if (count($data) && is_array($data))
if (!empty($data))
$this->hydrate($data);
}
/**
* load data from cache
*/
protected function loadCacheData()
{
//is it enabled?
if ($this->useObjectCaching)
{
//get our cache data... is it there?
$data = $this->getCache();
if ($data)
{
//load it, and we're good.
$this->hydrate($data);
return true;
}
}
return false;
}
/**
* This function handles saving the object.
*
* @return true on success, false on failure.
*/
public function save()
{
//we should do any cleanup if possible
if ($this->isDirty())
$this->clean();
//save it to wherever
$data = $this->saveData();
//bust our cache.
if ($this->useObjectCaching)
$this->deleteCache();
return $data;
}
/**
* This function handles any validation/cleaning of our data.
*/
public function clean()
{
foreach ($this->dirtyFields AS $field)
$this->cleanField($field);
}
/**
* Clean a field's data. called from clean()
*
* @param $field the name of the field to clean.
*/
public function cleanField($field)
{
//by default... we dont clean anything
}
/**
* Tells us if the object is dirty or not. Used to determine if we clean and/or if we need to save.
*/
public function isDirty()
{
return (bool)count($this->dirtyFields);
}
/**
* This function handles deleting our object.
*
* @return ture on success, false on failure.
*/
public function delete()
{
//delete our cache.
if ($this->useObjectCaching)
$this->deleteCache();
return $this->deleteDb();
}
/**
* This function gets an associative array of the object's members most
* commonly this will be from a db, but you never know.
*
* @return an associative array of the objects data.
*/
protected function getData($useDb = true)
{
$data = array();
if ($useDb)
{
$row = $this->getDbData();
//format it properly.
$data['id'] = $row['id'];
unset($row['id']);
$data['data'] = $row;
}
else
{
$data = $this->data;
$data['id'] = $this->id;
}
return $data;
}
/**
* This function sets all the data for the object.
*
* @param $data an associative array of data. The keys must match up with
* the object properties.
* @param $ignore the fields to ignore and not set
*/
//equivalent object members to that (if they exist)
public function setData($data, $ignore = null)
{
//make sure we have an array here =)
if (is_array($data))
{
if (!is_array($ignore))
$ignore = array($ignore);
//okay loop thur our data...
foreach ($data AS $key => $val)
{
//if we ignore it... continue
if (in_array($key, $ignore))
continue;
//make sure this key exists for us....
if ($key === 'id')
$this->id = (int)$val;
else
$this->data[$key] = $val;
}
return true;
}
else
return false;
}
/**
* This function handles saving the data to wherever.
*
* @return true on success, false on failure
*/
protected function saveData()
{
return $this->saveDb();
}
/**
* This function gets all the member information from a database.
*
* @return an associative array of data or false on failure.
*/
private function getDbData()
{
//make sure we have an id....
if ($this->id)
{
$result = db()->getRow("
SELECT *
FROM $this->tableName
WHERE id = '$this->id'
");
if (is_array($result))
return $result;
}
return false;
}
/**
* This function saves the object back to the database. It is a bit
* trickier. It will smartly insert or update depending on if there is an
* id or not. It also only saves the properties of the object that are
* named the same as the table fields, all automatically.
*/
private function saveDb()
{
//format our sql statements w/ the valid fields
$fields = array();
//loop thru all our dirty fields.
foreach ($this->dirtyFields AS $key => $foo)
{
//get our value.
if (isset($this->data[$key]) && $key != 'id')
{
$val = $this->data[$key];
//slashes replacement..
$val = str_replace("\\\\", "\\", $val);
$val = str_replace("\'", "'", $val);
$val = str_replace("\\\"", "\"", $val);
//add it if we have it...
$fields[] = "`$key` = '" . addslashes($val) . "'";
}
}
//update if we have an id....
if (count($fields))
{
//now make our array
$sqlFields = implode(",\n", $fields) . "\n";
//update it?
if ($this->id)
{
$sql = "UPDATE $this->tableName SET\n";
$sql .= $sqlFields;
$sql .= "WHERE id = '$this->id'\n";
$sql .= "LIMIT 1";
db()->execute($sql);
}
//otherwise insert it...
else
{
$sql = "INSERT INTO $this->tableName SET\n";
$sql .= $sqlFields;
$this->id = db()->insert($sql);
}
}
}
/**
* This function deletes the object from the database.
*
* @return true on success, false on failure
*/
private function deleteDb()
{
//do we have an id?
if ($this->id)
{
db()->execute("
DELETE FROM $this->tableName
WHERE id = '$this->id'
");
return true;
}
return false;
}
/**
* this function creates our key to use with caching. no need to override
*
* @return a key used with CacheBot to cache the object.
*/
public function getCacheKey($id = null)
{
if ($id === null)
$id = $this->id;
return "BaseJumper:object:" . get_class($this) . ":" . $id;
}
/**
* this is the funciton that gets the data we need saved to cache. by
* default it saves our data, and will save the comments or tags objects if
* needed. its recommended to extend this to add data that you'd like cached
* by the object
*
* @return an array of data to cache
*/
protected function getDataToCache($deep = true)
{
$data = array();
//obviously we want our data.
$data['id'] = $this->id;
$data['data'] = $this->data;
return $data;
}
/**
* this function sets the data in the object from the data we retrieved from
* the cache. it takes the data from the array and puts it in the object.
* you'll want to override this one if you added custome data in
* getDataToCache() and load it into the object.
*
* @param $data the data we got from teh cache
*/
public function hydrate($data)
{
if (is_array($data))
{
//get our id back
$this->id = $data['id'];
//obviously we want to load our data.
$this->data = $data['data'];
}
}
/**
* this function gets our data from the cache. no need to override
*/
public function getCache()
{
return CacheBot::get($this->getCacheKey(), self::$objectCacheLife);
}
/**
* this function saves our data to the cache. no need to override
*/
public function setCache()
{
return CacheBot::set($this->getCacheKey(), $this->getDataToCache(), self::$objectCacheLife);
}
/**
* this funciton deletes our data from teh cache. no need to override
*/
public function deleteCache()
{
return CacheBot::delete($this->getCacheKey());
}
}
?>
|