JModel
Description
Base class for a Joomla Model
Acts as a Factory class for application specific objects and provides many supporting API functions.
Located in /joomla/application/component/model.php (line 32)
JObject (Subpackage Base) JModel (Subpackage Application)
Method Summary
Variables
Methods
Constructor __construct (line 71)
Constructor
JModel
__construct
([ $config = array()])
- $config
Redefinition of:
- JObject::__construct()
- Class constructor, overridden in descendant classes.
addIncludePath (line 237)
Add a directory where JModel should search for models. You may either pass a string or an array of directories.
array
addIncludePath
([string $path = ''])
- string $path: A path to search.
addTablePath (line 257)
Adds to the stack of model table paths in LIFO order.
void
addTablePath
(string|array $path)
- string|array $path: The directory (-ies) to add.
getInstance (line 109)
Returns a reference to the a Model object, always creating it
mixed
&getInstance
(string $type, [string $prefix = ''])
- string $type: The model type to instantiate
- string $prefix: Prefix for the model class name
getState (line 160)
Method to get model state variables
object The
getState
([string $property = null])
- string $property: Optional parameter name
getTable (line 214)
Method to get a table object, load it if necessary.
object The
&getTable
([string $name = ''], [string $prefix = 'Table'])
- string $name: The table name
- string $prefix: The class prefix
setError (line 199)
Sets the error message
string
setError
(string $value)
- string $value: The error message
setState (line 147)
Method to set model state variables
mixed
setState
(string $property, [mixed $value = null])
- string $property: The name of the property
- mixed $value: The value of the property to set
_getList (line 272)
Returns an object list
array
&_getList
(string $query, int $limitstart, int $limit)
- string $query: The query
- int $limitstart: Offset
- int $limit: The number of records
_getListCount (line 289)
Returns a record count for the query
int
_getListCount
(string $query)
- string $query: The query
Inherited Methods
Inherited From JObject
JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 21:10:54 +0000 by phpDocumentor 1.3.1