BaseModel

Extends \Joomla\CMS\Object\CMSObject Implements \Joomla\CMS\MVC\Model\ModelInterface, \Joomla\CMS\MVC\Model\StatefulModelInterface

Base class for a Joomla Model

abstract

This class allows for simple but smart objects with get and set methods and an internal error handler.

since

4.0.0

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null) 
inherited
since

1.7.0

Arguments

$properties

mixedEither and associative array or another object to set the initial properties of the object.

__toString

Magic method to convert the object to a string gracefully.

__toString() : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 Classes should provide their own __toString() implementation.

Response

stringThe classname.

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
static deprecated
since

3.0

deprecated

5.0 See LegacyModelLoaderTrait\getInstance

Arguments

$path

mixedA path or array[sting] of paths to search.

$prefix

stringA prefix for models.

Response

arrayAn array with directory elements. If prefix is equal to '', all directories are returned.

def

Sets a default value if not already assigned

def(string $property, mixed $default = null) : mixed
inherited
since

1.7.0

Arguments

$property

stringThe name of the property.

$default

mixedThe 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
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if Exception objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Response

arrayArray of error messages.

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

\Exception

Response

stringThe name of the model

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

getState

Method to get state variables.

getState(string $property = null, mixed $default = null) : mixed
inherited
since

4.0.0

Arguments

$property

stringOptional parameter name

$default

mixedOptional default value

Response

mixedThe property where specified, the state object where omitted

populateState

Method to auto-populate the state.

populateState() : void
inherited

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
inherited
since

1.7.0

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

$error

stringError message.

setProperties

Set the object properties based on a named array/hash.

setProperties(mixed $properties) : boolean
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

setState

Method to set state variables.

setState(string $property, mixed $value = null) : mixed
inherited
since

4.0.0

Arguments

$property

stringThe name of the property

$value

mixedThe value of the property to set or null

Response

mixedThe previous value of the property or null if not set

Properties

name

The model (base) name

since

4.0.0

Type(s)

string

paths

The include paths

static
since

4.0.0

Type(s)

array

__state_set

Indicates if the internal state has been set

inherited
since

4.0.0

Type(s)

boolean

state

A state object

inherited
since

4.0.0

Type(s)

\Joomla\CMS\Object\CMSObject

_errors

An array of error messages or Exception objects.

inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Type(s)

array