/
Cachetaggable.php
498 lines (406 loc) · 11.9 KB
/
Cachetaggable.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
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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
<?php
/*
* This file is part of the sfCacheTaggingPlugin package.
* (c) 2009-2012 Ilya Sabelnikov <fruit.dev@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* Adds preSave, postSave, preDelete hocks to object
* version be valid and fresh
*
* @package sfCacheTaggingPlugin
* @subpackage doctrine
* @author Ilya Sabelnikov <fruit.dev@gmail.com>
*/
class Doctrine_Template_Listener_Cachetaggable
extends Doctrine_Record_Listener
{
/**
* Array of sortable options
*
* @var array
*/
protected $_options = array();
/**
* Removed object does not have relations
* This variable keeps tag names to remove till postDelete hook is executed
*
* @var array
*/
protected $preDeleteTagNames = array();
/**
* Removed object does not have relations
* This variable keeps tag names to invalidate till postDelete hook is executed
*
* @var array
*/
protected $preInvalidateTagNames = array();
/**
* Flag to be clear in self::postSave() if saved object was new or not
*
* @var boolean
*/
protected $wasObjectNew = null;
/**
* Flag if nothing was changed in object or changes are expected and useless.
*
* @var boolean
*/
protected $skipVersionUpdate = null;
/**
* __construct
*
* @param array $options
*/
public function __construct(array $options)
{
$this->_options = $options;
}
/**
* Returns cache class to work with cache data, keys and locks
*
* @return sfTaggingCache
*/
protected function getTaggingCache ()
{
return sfCacheTaggingToolkit::getTaggingCache();
}
/**
* Checks if passed modified columns are all in skipOnChange list
*
* @param array $modified
* @return boolean
*/
protected function isModifiedInSkipList ($modified)
{
$skipOnChange = (array) $this->getOption('skipOnChange');
if (
0 < count($skipOnChange)
&&
0 == count(array_diff($modified, $skipOnChange))
)
{
return true;
}
return false;
}
/**
* Checks if passed modified is a SoftDelete "deleted_at" column
*
* @param array $modified
* @param Doctrine_Table $table
* @return boolean
*/
protected function isModifiedIsASoftDeleteColumn ($modified, Doctrine_Table $table)
{
# When SoftDelete behavior saves "deleted" object
# do not update object version on when "deleted" object is saving
if ($table->hasTemplate('SoftDelete'))
{
$softDeleteTemplate = $table->getTemplate('SoftDelete');
$deleteAtField = $softDeleteTemplate->getOption('name');
# skip if SoftDelete sets deleted_at field
if (in_array($deleteAtField, $modified))
{
return true;
}
}
return false;
}
/**
* Checks if one of modified columns are in list of defined columns, that
* can invalidate collection version
*
* @param array $modified
* @return boolean
*/
protected function isModifiedAffectsCollectionVersion ($modified)
{
$affectsCollectionColumns = (array) $this->getOption(
'invalidateCollectionVersionByChangingColumns'
);
if (
0 < count($affectsCollectionColumns)
&&
0 < count(array_intersect($affectsCollectionColumns, $modified))
)
{
return true;
}
return false;
}
/**
* Pre deletion hook - saves object tag_name to remove it on postDelete
*
* @param Doctrine_Event $event
* @return null
*/
public function preDelete (Doctrine_Event $event)
{
$this->preDeleteTagNames = array();
$this->preInvalidateTagNames = array();
try
{
$taggingCache = $this->getTaggingCache();
$invoker = $event->getInvoker();
$unitOfWork = new Doctrine_Connection_CachetaggableUnitOfWork(
$invoker->getTable()->getConnection()
);
$unitOfWork->collectDeletionsAndInvalidations($invoker);
$this->preDeleteTagNames = $unitOfWork->getDeletions();
$this->preInvalidateTagNames = $unitOfWork->getInvalidations();
$taggingCache->setTag(
$invoker->obtainCollectionName(),
sfCacheTaggingToolkit::generateVersion()
);
unset($unitOfWork);
}
catch (sfCacheException $e)
{
}
}
/**
* Post deletion hook - removes object tag
*
* @param Doctrine_Event $event
*/
public function postDelete (Doctrine_Event $event)
{
try
{
$taggingCache = $this->getTaggingCache();
$invoker = $event->getInvoker();
$taggingCache->deleteTags($this->preDeleteTagNames);
$taggingCache->invalidateTags($this->preInvalidateTagNames);
$taggingCache->setTag(
$invoker->obtainCollectionName(),
sfCacheTaggingToolkit::generateVersion()
);
}
catch (sfCacheException $e)
{
}
}
/**
* pre saving hook - sets new object`s version to store it in the database
*
* @param Doctrine_Event $event
* @return null
*/
public function preSave (Doctrine_Event $event)
{
$this->skipVersionUpdate = true;
$invoker = $event->getInvoker();
$this->wasObjectNew = $invoker->isNew();
if (! $invoker->isModified(true))
{
return;
}
$modified = array_keys($invoker->getModified());
if ($this->isModifiedInSkipList($modified))
{
return;
}
$table = $invoker->getTable();
if ($this->isModifiedIsASoftDeleteColumn($modified, $table))
{
return;
}
$invoker->assignObjectVersion(sfCacheTaggingToolkit::generateVersion());
$this->skipVersionUpdate = false;
}
/**
* post saving hook - updates/creates the version tag (in the cache)
* of the stored object
*
* @param Doctrine_Event $event
* @return null
*/
public function postSave (Doctrine_Event $event)
{
if ($this->skipVersionUpdate)
{
return;
}
$taggingCache = null;
try
{
$taggingCache = $this->getTaggingCache();
}
catch (sfCacheException $e)
{
return;
}
$invoker = $event->getInvoker();
$invokerObjectVersion = $invoker->obtainObjectVersion();
$isToInvalidateCollectionVersion
= (boolean) $this->getOption('invalidateCollectionVersionOnUpdate');
if (! $isToInvalidateCollectionVersion)
{
$lastModifiedColumns = array_keys($invoker->getLastModified());
if ($this->isModifiedAffectsCollectionVersion($lastModifiedColumns))
{
$isToInvalidateCollectionVersion = true;
}
}
/**
* ->exists() returns false if it was ->replace()
* When replace(), $this->wasObjectNew is always "true"
*/
if ($isToInvalidateCollectionVersion || ($invoker->exists() && $this->wasObjectNew))
{
$table = $invoker->getTable();
$formatedClassName = sfCacheTaggingToolkit::getBaseClassName(
$table->getClassnameToReturn()
);
$taggingCache->setTag($formatedClassName, $invokerObjectVersion);
$invoker->addCacheTag($formatedClassName, $invokerObjectVersion);
}
$invokerTagName = $invoker->obtainTagName();
$taggingCache->setTag($invokerTagName, $invokerObjectVersion);
$invoker->addCacheTag($invokerTagName, $invokerObjectVersion);
}
/**
* pre dql update hook - add updated
*
* @param Doctrine_Event $event
* @return null
*/
public function preDqlUpdate (Doctrine_Event $event)
{
$taggingCache = null;
try
{
$taggingCache = $this->getTaggingCache();
}
catch (sfCacheException $e)
{
return;
}
/* @var $q Doctrine_Query */
$q = $event->getQuery();
$columnsToModify = array();
foreach ($q->getDqlPart('set') as $set)
{
$matches = null;
/**
* Replace cases:
* Catalogue.is_visible = 1 => is_visible
* is_visible = -1 => is_visible
*/
if (preg_match('/(\w+)\ =\ /', $set, $matches))
{
$columnsToModify[] = $matches[1];
}
}
if ($this->isModifiedInSkipList($columnsToModify))
{
return false;
}
$table = $event->getInvoker()->getTable();
$collectionVersionName = sfCacheTaggingToolkit::getBaseClassName(
$table->getClassnameToReturn()
);
/**
* @todo test, not coveraged (SoftDelete everywhere is after Cachetaggable
*/
if ($this->isModifiedIsASoftDeleteColumn($columnsToModify, $table))
{
# invalidate collection, if soft delete sets deleted_at field
$taggingCache->setTag(
$collectionVersionName,
sfCacheTaggingToolkit::generateVersion()
);
}
$updateVersion = sfCacheTaggingToolkit::generateVersion();
$q->set($this->getOption('versionColumn'), $updateVersion);
$selectQuery = $table->createQuery();
$selectQuery->select();
$where = trim(implode(' ', $q->getDqlPart('where')));
if (! empty ($where))
{
$selectQuery->addWhere($where);
}
$params = $q->getParams();
$params['set'] = array();
$selectQuery->setParams($params);
$tags = array();
$template = $table->getTemplate(sfCacheTaggingToolkit::TEMPLATE_NAME);
foreach ($selectQuery->fetchArray() as $objectArray)
{
$tagName = sfCacheTaggingToolkit::obtainTagName($template, $objectArray);
$tags[$tagName] = $updateVersion;
}
$taggingCache->setTags($tags);
$isToInvalidateCollectionVersion
= (boolean) $this->getOption('invalidateCollectionVersionOnUpdate');
if (! $isToInvalidateCollectionVersion)
{
if ($this->isModifiedAffectsCollectionVersion($columnsToModify))
{
$isToInvalidateCollectionVersion = true;
}
}
if ($isToInvalidateCollectionVersion)
{
$taggingCache->setTag(
$collectionVersionName,
sfCacheTaggingToolkit::generateVersion()
);
}
}
/**
* pre dql delete hook - remove object tags from tagger
*
* @param Doctrine_Event $event
* @return null
*/
public function preDqlDelete (Doctrine_Event $event)
{
$taggingCache = null;
try
{
$taggingCache = $this->getTaggingCache();
}
catch (sfCacheException $e)
{
return;
}
$table = $event->getInvoker()->getTable();
/* @var $q Doctrine_Query */
$q = clone $event->getQuery();
/**
* This happens, when SoftDelete is declared before Cachetaggable
*/
if (Doctrine_Query::UPDATE === $q->getType())
{
$event->getQuery()->set(
$this->getOption('versionColumn'),
sfCacheTaggingToolkit::generateVersion()
);
$q->removeDqlQueryPart('set');
}
$params = $q->getParams();
$params['set'] = array();
$q->setParams($params);
$objects = $q->select()->execute();
$unitOfWork = new Doctrine_Connection_CachetaggableUnitOfWork(
$q->getConnection()
);
foreach ($objects as $object)
{
$unitOfWork->collectDeletionsAndInvalidations($object);
$taggingCache->deleteTags($unitOfWork->getDeletions());
$taggingCache->invalidateTags($unitOfWork->getInvalidations());
}
unset($unitOfWork);
$taggingCache->setTag(
sfCacheTaggingToolkit::getBaseClassName(
$table->getClassnameToReturn()
),
sfCacheTaggingToolkit::generateVersion()
);
}
}