/
Abstract.php
313 lines (270 loc) · 5.76 KB
/
Abstract.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
<?php
/**
* @category Fishpig
* @package Fishpig_Wordpress
* @license http://fishpig.co.uk/license.txt
* @author Ben Tideswell <help@fishpig.co.uk>
* @info http://fishpig.co.uk/wordpress-integration.html
*/
abstract class Fishpig_Wordpress_Model_Abstract extends Mage_Core_Model_Abstract
{
/**
* Name of entity meta table
* false if entity does not have a meta table
*
* @var string
*/
protected $_metaTable = false;
/**
* Name of entity meta field
*
* @var false|string
*/
protected $_metaTableObjectField = false;
/**
* Determine whether some meta fields have a prefix
* if true, the database table prefix is used
*
* @var bool
*/
protected $_metaHasPrefix = false;
/**
* Array of entity's meta values
*
* @var array
*/
protected $_meta = array();
/**
* An array of all meta keys that have changed
*
* @var array
*/
protected $_metaKeysChanged = array();
/**
* Cache for objects to avoid re-use
*
* @var array (static)
*/
static $_objectCache = array();
/**
* Override load method to provide object cache
*
* @param mixed $id
* @param string $field = null
* @return $this
*/
public function load($id, $field=null)
{
if (!is_null($field)) {
$id = $this->_encodeLoadingValue($id, $field);
}
if ($this->getSkipObjectCache()) {
return parent::load($id, $field);
}
$class = get_class($this);
if ($this->getPostType()) {
$class = '::' . $this->getPostType();
}
if (!isset(self::$_objectCache[$class])) {
self::$_objectCache[$class] = array();
}
if (is_null($field) && isset(self::$_objectCache[$class][$id])) {
return self::$_objectCache[$class][$id];
}
parent::load($id, $field);
if ($this->getId()) {
self::$_objectCache[$class][$id] = $this;
}
return $this;
}
/**
* Encode the loading value
*
* @param mixed $value
* @param string $field
* @return string
*/
protected function _encodeLoadingValue($value, $field)
{
return strpos($field, 'email') === false
? urlencode($value)
: $value;
}
/**
* Retrieve the name of the meta database table
*
* @return false|string
*/
public function getMetaTable()
{
if ($this->hasMeta()) {
return $this->getResource()->getTable($this->_metaTable);
}
return false;
}
/**
* Retrieve the name of the column used to identify the entity
*
* @return string
*/
public function getMetaObjectField()
{
return $this->_metaTableObjectField;
}
/**
* Retrieve the column name of the primary key fields
*
* @return string
*/
public function getMetaPrimaryKeyField()
{
return 'meta_id';
}
/**
* Determine whether the entity type has a meta table
*
* @return bool
*/
public function hasMeta()
{
return $this->_metaTable !== false && $this->_metaTableObjectField !== false;
}
/**
* Retrieve a meta value
*
* @param string $key
* @return false|string
*/
public function getMetaValue($key)
{
if ($this->hasMeta()) {
if (!isset($this->_meta[$key])) {
$value = $this->getResource()->getMetaValue($this, $this->_getRealMetaKey($key));
$meta = new Varien_Object(array(
'key' => $key,
'value' => $value,
));
Mage::dispatchEvent($this->_eventPrefix . '_get_meta_value', array('object' => $this, $this->_eventObject => $this, 'meta' => $meta));
$this->_meta[$key] = $meta->getValue();
}
return $this->_meta[$key];
}
return false;
}
/**
* Retrieve all of the meta data as an array
*
* @return false|array
*/
public function getMetaData()
{
if ($this->hasMeta()) {
return $this->_meta;
}
return false;
}
/**
* Set a custom field
* value isn't saved until entity is saved
*
* @param string $key
* @param mixed $value
* @return $this
*/
public function setMetaValue($key, $value)
{
if ($this->hasMeta()) {
$this->_meta[$key] = $value;
$this->_metaKeysChanged[$key] = $key;
$this->_hasDataChanges = true;
}
return $this;
}
/**
* Save any meta key values that have changed
*
* @return $this
*/
public function afterCommitCallback()
{
parent::afterCommitCallback();
if ($this->hasMeta()) {
foreach($this->_metaKeysChanged as $index => $key) {
if (isset($this->_meta[$key])) {
$this->getResource()->setMetaValue($this, $this->_getRealMetaKey($key), $this->_meta[$key]);
}
unset($this->_metaKeysChanged[$index]);
}
}
return $this;
}
/**
* Changes the wp_ to the correct table prefix
*
* @param string $key
* @return string
*/
protected function _getRealMetaKey($key)
{
if ($this->_metaHasPrefix) {
$tablePrefix = Mage::helper('wordpress/database')->getTablePrefix();
if ($tablePrefix !== 'wp_') {
if (preg_match('/^(wp_)(.*)$/', $key, $matches)) {
return $tablePrefix . $matches[2];
}
}
}
return $key;
}
/**
* Deprecreated from version 2.4.0
* use self::getMetaValue
*
* @param string $key
* @return mixed
*/
public function getCustomField($key)
{
return $this->getMetaValue($key);
}
/**
* Deprecreated from version 2.4.0
* use self::getMetaValue
*
* @param string $key
* @return mixed
*/
public function setCustomField($key, $value)
{
return $this->setMetaValue($key, $value);
}
/**
* Retrieve the event prefix
*
* @return string
*/
public function getEventPrefix()
{
return $this->_eventPrefix;
}
/**
* Retrieve the event object name
*
* @return string
*/
public function getEventObject()
{
return $this->_eventObject;
}
/**
* Get a collection of posts
* Child class should filter posts accordingly
*
* @return Fishpig_Wordpress_Model_Resource_Post_Collection
*/
public function getPostCollection()
{
return Mage::getResourceModel('wordpress/post_collection')
->setFlag('source', $this);
}
}