BaseModel
Extends CMSObject Implements ModelInterface, StatefulModelInterfaceBase class for a Joomla Model
since |
4.0.0 |
---|---|
package |
Joomla CMS |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed properties = null) : mixed
since |
1.7.0 |
---|
Arguments
- properties
mixed
Either and associative array or another object to set the initial properties of the object.
Response
mixed
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
since |
1.7.0 |
---|---|
deprecated |
3.1.4 Classes should provide their own __toString() implementation. |
Response
string
The classname.
_createFileName
Create the filename for a resource
_createFileName(string type, array parts = array()) : string
since |
3.0 |
---|---|
deprecated |
5.0 See getInstance |
Arguments
- type
string
The resource type to create the filename for.- parts
array
An associative array of filename information.
Response
string
The filename
addIncludePath
Add a directory where \JModelLegacy should search for models. You may either pass a string or an array of directories.
addIncludePath(mixed path = '', string prefix = '') : array
since |
3.0 |
---|---|
deprecated |
5.0 See LegacyModelLoaderTrait\getInstance |
Arguments
- path
mixed
A path or array[sting] of paths to search.- prefix
string
A prefix for models.
Response
array
An array with directory elements. If prefix is equal to '', all directories are returned.
addTablePath
Adds to the stack of model table paths in LIFO order.
addTablePath(mixed path) : void
since |
3.0 |
---|---|
deprecated |
5.0 See getInstance |
Arguments
- path
mixed
The directory as a string or directories as an array to add.
createModelFromComponent
Returns a Model object by loading the component from the prefix.
createModelFromComponent(string type, string prefix = '', array config = []) : \Joomla\CMS\MVC\Model\ModelInterface|null
since |
4.0.0 |
---|---|
deprecated |
5.0 See getInstance |
Arguments
- type
string
The model type to instantiate- prefix
string
Prefix for the model class name. Optional.- config
array
Configuration array for model. Optional.
Response
\Joomla\CMS\MVC\Model\ModelInterface|null
A ModelInterface instance or null on failure
def
Sets a default value if not already assigned
def(string property, mixed default = null) : mixed
since |
1.7.0 |
---|
Arguments
- property
string
The name of the property.- default
mixed
The default value.
Response
mixed
get
Returns a property of the object or the default value if the property is not set.
get(string property, mixed default = null) : mixed
since |
1.7.0 |
---|---|
see | CMSObject::getProperties() |
Arguments
- property
string
The name of the property.- default
mixed
The default value.
Response
mixed
The value of the property.
getError
Get the most recent error message.
getError(int i = null, bool toString = true) : string
since |
1.7.0 |
---|---|
deprecated |
3.1.4 JError has been deprecated |
Arguments
- i
int
Option error index.- toString
bool
Indicates if Exception objects should return their error message.
Response
string
Error message
getErrors
Return all errors, if any.
getErrors() : array
since |
1.7.0 |
---|---|
deprecated |
3.1.4 JError has been deprecated |
Response
array
Array of error messages.
getInstance
Returns a Model object, always creating it
getInstance(string type, string prefix = '', array config = array()) : self|bool
since |
3.0 |
---|---|
deprecated |
5.0 Get the model through the MVCFactory instead |
Arguments
- type
string
The model type to instantiate- prefix
string
Prefix for the model class name. Optional.- config
array
Configuration array for model. Optional.
Response
self|bool
A \JModelLegacy instance or false on failure
getName
Method to get the model name
getName() : string
The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor
since |
4.0.0 |
---|---|
throws |
|
Response
string
The name of the model
getProperties
Returns an associative array of object properties.
getProperties(bool public = true) : array
since |
1.7.0 |
---|---|
see | CMSObject::get() |
Arguments
- public
bool
If true, returns only the public properties.
Response
array
getState
Method to get state variables.
getState(string property = null, mixed default = null) : mixed
since |
4.0.0 |
---|
Arguments
- property
string
Optional parameter name- default
mixed
Optional default value
Response
mixed
The property where specified, the state object where omitted
populateState
Method to auto-populate the state.
populateState() : void
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 configuration flag to ignore the request is set.
note |
Calling getState in this method will result in recursion. |
---|---|
since |
4.0.0 |
set
Modifies a property of the object, creating it if it does not already exist.
set(string property, mixed value = null) : mixed
since |
1.7.0 |
---|
Arguments
- property
string
The name of the property.- value
mixed
The value of the property to set.
Response
mixed
Previous value of the property.
setError
Add an error message.
setError(string error) : void
since |
1.7.0 |
---|---|
deprecated |
3.1.4 JError has been deprecated |
Arguments
- error
string
Error message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed properties) : bool
since |
1.7.0 |
---|---|
see | CMSObject::set() |
Arguments
- properties
mixed
Either an associative array or another object.
Response
bool
setState
Method to set state variables.
setState(string property, mixed value = null) : mixed
since |
4.0.0 |
---|
Arguments
- property
string
The name of the property- value
mixed
The value of the property to set or null
Response
mixed
The previous value of the property or null if not set
Properties
_errors
An array of error messages or Exception objects.