/
Cachetaggable.php
253 lines (217 loc) · 6.05 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
<?php
/*
* This file is part of the sfCacheTaggingPlugin package.
* (c) 2009-2010 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();
/**
* Removing object does not have a tag name
* This variable keeps tag name till postDelete hook is executed
*
* @var string
*/
protected $preDeleteTagName = null;
/**
* __construct
*
* @param array $options
* @return void
*/
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();
}
/**
* Pre deletion hook - saves object tag_name to remove it on postDelete
*
* @param Doctrine_Event $event
* @return void
*/
public function preDelete (Doctrine_Event $event)
{
$this->preDeleteTagName = $event->getInvoker()->getTagName();
}
/**
* Post deletion hook - removes object tag
*
* @param Doctrine_Event $event
*/
public function postDelete (Doctrine_Event $event)
{
try
{
$taggingCache = $this->getTaggingCache();
if (null !== $this->preDeleteTagName)
{
$taggingCache->deleteTag($this->preDeleteTagName);
}
}
catch (sfCacheException $e)
{
}
$this->preDeleteTagName = null;
}
/**
* pre saving hook - sets new object`s version to store it in the database
*
* @param Doctrine_Event $event
* @return void
*/
public function preSave (Doctrine_Event $event)
{
$object = $event->getInvoker();
# do not set new object version if no fields are modified
if (! $object->isNew() && 0 == count($object->getModified()))
{
return;
}
$object->setObjectVersion(sfCacheTaggingToolkit::generateVersion());
}
/**
* post saving hook - updates/creates the version tag (in the cache)
* of the stored object
*
* @param Doctrine_Event $event
* @return void
*/
public function postSave (Doctrine_Event $event)
{
try
{
$taggingCache = $this->getTaggingCache();
}
catch (sfCacheException $e)
{
return;
}
$object = $event->getInvoker();
$lastModifiedColumns = $object->getLastModified();
# do not update tags in cache if no fields was modified
if (0 == count($lastModifiedColumns))
{
return;
}
# When SoftDelete behavior saves "deleted" object
# do not update object version on when "deleted" object is saving
if ($object->getTable()->hasTemplate('SoftDelete'))
{
$softDeleteTemplate = $object->getTable()->getTemplate('SoftDelete');
$deleteAtField = $softDeleteTemplate->getOption('name');
if (array_key_exists($deleteAtField, $lastModifiedColumns))
{
# skip if SoftDeletes sets deleted_at field
return;
}
}
$taggingCache->setTag($object->getTagName(), $object->getObjectVersion());
$formatedClassName = sfCacheTaggingToolkit::getBaseClassName(
get_class($object)
);
$taggingCache->setTag($formatedClassName, $object->getObjectVersion());
# updating object tags
$object->addTag($object->getTagName(), $object->getObjectVersion());
$object->addTag(
$formatedClassName,
$object->getObjectVersion()
);
}
/**
* pre dql update hook - add updated
*
* @param Doctrine_Event $event
* @return void
*/
public function preDqlUpdate (Doctrine_Event $event)
{
try
{
$taggingCache = $this->getTaggingCache();
}
catch (sfCacheException $e)
{
return;
}
/* @var $q Doctrine_Query */
$q = $event->getQuery();
$updateVersion = sfCacheTaggingToolkit::generateVersion();
$q->set($this->getOption('versionColumn'), $updateVersion);
$selectQuery = $event->getInvoker()->getTable()->createQuery();
$selectQuery->select();
foreach ($q->getDqlPart('where') as $whereCondition)
{
$selectQuery->addWhere($whereCondition);
}
$params = $q->getParams();
$params['set'] = array();
$selectQuery->setParams($params);
foreach ($selectQuery->execute() as $object)
{
$taggingCache->setTag($object->getTagName(), $updateVersion);
}
$taggingCache->setTag(
sfCacheTaggingToolkit::getBaseClassName(get_class($object)),
$updateVersion,
$lifetime
);
}
/**
* pre dql delete hook - remove object tags from tagger
*
* @param Doctrine_Event $event
* @return void
*/
public function preDqlDelete (Doctrine_Event $event)
{
try
{
$taggingCache = $this->getTaggingCache();
}
catch (sfCacheException $e)
{
return;
}
/* @var $q Doctrine_Query */
$q = clone $event->getQuery();
# conflicts with build-in SoftDelete behavior
# SoftDelete passes UPDATE query to the preDqlDelete event
if ($q->getType() != Doctrine_Query::DELETE)
{
return;
}
$params = $q->getParams();
$params['set'] = array();
$q->setParams($params);
foreach ($q->select()->execute() as $object)
{
$taggingCache->deleteTag($object->getTagName());
}
}
}