forked from joomla/joomla-platform
/
model.php
392 lines (346 loc) · 8.84 KB
/
model.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
<?php
/**
* @version $Id$
* @package Joomla.Framework
* @subpackage Application
* @copyright Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// No direct access
defined('JPATH_BASE') or die;
/**
* Base class for a Joomla Model
*
* Acts as a Factory class for application specific objects and
* provides many supporting API functions.
*
* @abstract
* @package Joomla.Framework
* @subpackage Application
* @since 1.5
*/
abstract class JModel extends JObject
{
/**
* Indicates if the internal state has been set
*
* @var boolean
* @since 1.6
*/
protected $__state_set = null;
/**
* Database Connector
*
* @var object
* @since 1.5
*/
protected $_db;
/**
* The model (base) name
*
* @var string
* @since 1.6 (replaces _name variable in 1.5)
*/
protected $name;
/**
* @var string The URL option for the component.
* @since 1.6
*/
protected $option = null;
/**
* An state object
*
* @var string
* @since 1.6 (replaces _state variable in 1.5)
*/
protected $state;
/**
* Add a directory where JModel should search for models. You may
* either pass a string or an array of directories.
*
* @param string A path to search.
* @param string A prefix for models
* @return array An array with directory elements. If prefix is equal to '', all directories are returned
*/
public static function addIncludePath($path='', $prefix='')
{
static $paths;
if (!isset($paths)) {
$paths = array();
}
if (!isset($paths[$prefix])) {
$paths[$prefix] = array();
}
if (!isset($paths[''])) {
$paths[''] = array();
}
if (!empty($path))
{
jimport('joomla.filesystem.path');
if(!in_array($path, $paths[$prefix])) {
array_unshift($paths[$prefix], JPath::clean($path));
}
if(!in_array($path, $paths[''])) {
array_unshift($paths[''], JPath::clean($path));
}
}
return $paths[$prefix];
}
/**
* Adds to the stack of model table paths in LIFO order.
*
* @static
* @param string|array The directory (-ies) to add.
* @return void
*/
public static function addTablePath($path)
{
jimport('joomla.database.table');
JTable::addIncludePath($path);
}
/**
* Create the filename for a resource
*
* @param string The resource type to create the filename for
* @param array An associative array of filename information
* @return string The filename
*/
private static function _createFileName($type, $parts = array())
{
$filename = '';
switch($type) {
case 'model':
$filename = strtolower($parts['name']).'.php';
break;
}
return $filename;
}
/**
* Returns a Model object, always creating it
*
* @param string The model type to instantiate
* @param string Prefix for the model class name. Optional.
* @param array Configuration array for model. Optional.
* @return mixed A model object, or false on failure
*/
public static function getInstance($type, $prefix = '', $config = array())
{
$type = preg_replace('/[^A-Z0-9_\.-]/i', '', $type);
$modelClass = $prefix.ucfirst($type);
if (!class_exists($modelClass)) {
jimport('joomla.filesystem.path');
$path = JPath::find(
JModel::addIncludePath(null, $prefix),
JModel::_createFileName('model', array('name' => $type))
);
if(!$path) {
$path = JPath::find(
JModel::addIncludePath(null, ''),
JModel::_createFileName('model', array('name' => $type))
);
}
if ($path) {
require_once $path;
if (!class_exists($modelClass)) {
JError::raiseWarning(0, JText::sprintf('JLIB_APPLICATION_ERROR_MODELCLASS_NOT_FOUND', $modelClass ));
return false;
}
}
else return false;
}
return new $modelClass($config);
}
/**
* Constructor
*
* @since 1.5
*/
public function __construct($config = array())
{
// Guess the option from the class name (Option)Model(View).
if (empty($this->option)) {
$r = null;
if (!preg_match('/(.*)Model/i', get_class($this), $r)) {
JError::raiseError(500, JText::_('JLIB_APPLICATION_ERROR_MODEL_GET_NAME'));
}
$this->option = 'com_'.strtolower($r[1]);
}
//set the view name
if (empty($this->name)) {
if (array_key_exists('name', $config)) {
$this->name = $config['name'];
} else {
$this->name = $this->getName();
}
}
//set the model state
if (array_key_exists('state', $config)) {
$this->state = $config['state'];
} else {
$this->state = new JObject();
}
//set the model dbo
if (array_key_exists('dbo', $config)) {
$this->_db = $config['dbo'];
} else {
$this->_db = JFactory::getDbo();
}
// set the default view search path
if (array_key_exists('table_path', $config)) {
$this->addTablePath($config['table_path']);
} else if (defined('JPATH_COMPONENT_ADMINISTRATOR')){
$this->addTablePath(JPATH_COMPONENT_ADMINISTRATOR.DS.'tables');
}
// set the internal state marker - used to ignore setting state from the request
if (!empty($config['ignore_request'])) {
$this->__state_set = true;
}
}
/**
* Returns an object list
*
* @param string The query
* @param int Offset
* @param int The number of records
* @return array
* @since 1.5
*/
protected function _getList($query, $limitstart=0, $limit=0)
{
$this->_db->setQuery($query, $limitstart, $limit);
$result = $this->_db->loadObjectList();
return $result;
}
/**
* Returns a record count for the query
*
* @param string The query
* @return int
* @since 1.5
*/
protected function _getListCount($query)
{
$this->_db->setQuery($query);
$this->_db->query();
return $this->_db->getNumRows();
}
/**
* Method to load and return a model object.
*
* @param string The name of the view
* @param string The class prefix. Optional.
* @return mixed Model object or boolean false if failed
*/
private function _createTable($name, $prefix = 'Table', $config = array())
{
// Clean the model name
$name = preg_replace('/[^A-Z0-9_]/i', '', $name);
$prefix = preg_replace('/[^A-Z0-9_]/i', '', $prefix);
//Make sure we are returning a DBO object
if (!array_key_exists('dbo', $config)) {
$config['dbo'] = $this->getDbo();;
}
return JTable::getInstance($name, $prefix, $config);;
}
/**
* Method to get the database connector object
*
* @return object JDatabase connector object
*/
public function getDbo()
{
return $this->_db;
}
/**
* Method to get the model name
*
* The model name by default parsed using the classname, or it can be set
* by passing a $config['name'] in the class constructor
*
* @return string The name of the model
*/
public function getName()
{
$name = $this->name;
if (empty($name)) {
$r = null;
if (!preg_match('/Model(.*)/i', get_class($this), $r)) {
JError::raiseError (500, 'JLIB_APPLICATION_ERROR_MODEL_GET_NAME');
}
$name = strtolower($r[1]);
}
return $name;
}
/**
* Method to get model state variables
*
* @param string Optional parameter name
* @param mixed Optional default value
* @return object The property where specified, the state object where omitted
*/
public function getState($property = null, $default = null)
{
if (!$this->__state_set) {
// Private method to auto-populate the model state.
$this->populateState();
// Set the model state set flat to true.
$this->__state_set = true;
}
return $property === null ? $this->state : $this->state->get($property, $default);
}
/**
* Method to get a table object, load it if necessary.
*
* @param string The table name. Optional.
* @param string The class prefix. Optional.
* @param array Configuration array for model. Optional.
* @return object The table
*/
public function getTable($name='', $prefix='Table', $options = array())
{
if (empty($name)) {
$name = $this->getName();
}
if ($table = $this->_createTable($name, $prefix, $options)) {
return $table;
}
JError::raiseError(0, JText::sprintf('JLIB_APPLICATION_ERROR_TABLE_NAME_NOT_SUPPORTED', $name));
return null;
}
/**
* Method to auto-populate the model state.
*
* This method should only be called once per instantiation and is designed
* to be called on the first call to the getState() method unless the model
* configuration flag to ignore the request is set.
*
* Note. Calling getState in this method will result in recursion.
*
* @return void
* @since 1.6
*/
protected function populateState()
{
}
/**
* Method to set the database connector object
*
* @param object A JDatabase based object
* @return void
*/
public function setDbo(&$db)
{
$this->_db = &$db;
}
/**
* Method to set model state variables
*
* @param string The name of the property
* @param mixed The value of the property to set
* @return mixed The previous value of the property
*/
public function setState($property, $value=null)
{
return $this->state->set($property, $value);
}
}