Joomla! API

Download
Launch

BaseModel

Extends CMSObject Implements ModelInterface, StatefulModelInterface

Base class for a Joomla Model

abstract
since

4.0.0
package

Joomla CMS

Methods

__construct

Constructor

__construct(mixed||string|int config = []) :
since

4.0.0
throws

Exception

Arguments

config

array<string|int, mixed>An array of configuration options (name, state, ignore_request).

Response

mixed

__toString

Magic method to convert the object to a string gracefully.

__toString() :
inherited deprecated
since

1.7.0
deprecated

4.3 will be removed in 6.0 Classes should provide their own __toString() implementation.

Response

stringThe classname.

_createFileName

Create the filename for a resource

_createFileName( type, mixed||string|int parts = []) :
inherited static deprecated
since

3.0
deprecated

4.3 will be removed in 6.0 Will be removed without replacement

Arguments

type

stringThe resource type to create the filename for.

parts

array<string|int, mixed>An associative array of filename information.

Response

stringThe filename

addIncludePath

Add a directory where \JModelLegacy should search for models. You may either pass a string or an array of directories.

addIncludePath( path = '',  prefix = '') : mixed||string|int
static deprecated
since

3.0
deprecated

4.3 will be removed in 6.0 Will be removed without replacement. Get the model through the MVCFactory + namespace instead
see

Arguments

path

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

prefix

stringA prefix for models.

Response

array<string|int, mixed>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( path) :
inherited static deprecated
since

3.0
deprecated

4.3 will be removed in 6.0 Will be removed without replacement. Get the model through the MVCFactory instead

Arguments

path

mixedThe directory as a string or directories as an array to add.

Response

void

createModelFromComponent

Returns a Model object by loading the component from the prefix.

createModelFromComponent( type,  prefix = '', mixed||string|int config = []) : \Joomla\CMS\MVC\Model\ModelInterface|null
inherited static deprecated
since

4.0.0
deprecated

4.3 will be removed in 6.0 Will be removed without replacement

Arguments

type

stringThe model type to instantiate

prefix

stringPrefix for the model class name. Optional.

config

array<string|int, mixed>Configuration array for model. Optional.

Response

ModelInterface|nullA ModelInterface instance or null on failure

def

Sets a default value if not already assigned

def( property,  default = null) :
inherited deprecated
since

1.7.0
deprecated

4.3.0 will be removed in 6.0 Defining dynamic properties should not be used anymore

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( property,  default = null) :
inherited deprecated
since

1.7.0
see CMSObject::getProperties()
deprecated

4.3.0 will be removed in 6.0 Create a proper getter function for the property

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( i = null,  toString = true) :
inherited deprecated
since

1.7.0
deprecated

3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getError

Arguments

i

intOption error index.

toString

boolIndicates if Exception objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : mixed||string|int
inherited deprecated
since

1.7.0
deprecated

3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getErrors

Response

array<string|int, mixed>Array of error messages.

getInstance

Returns a Model object, always creating it

getInstance( type,  prefix = '', mixed||string|int config = []) : self|bool
inherited static deprecated
since

3.0
deprecated

4.3 will be removed in 6.0 Will be removed without replacement. Get the model through the MVCFactory instead Example: Factory::getApplication->bootComponent('com_xxx')->getMVCFactory()->createModel($type, $prefix, $config);

Arguments

type

stringThe model type to instantiate

prefix

stringPrefix for the model class name. Optional.

config

array<string|int, mixed>Configuration array for model. Optional.

Response

self|boolA \JModelLegacy instance or false on failure

getName

Method to get the model name

getName() :

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( public = true) : mixed||string|int
inherited deprecated
since

1.7.0
see CMSObject::get()
deprecated

4.3.0 will be removed in 6.0 Create a proper getter function for the property

Arguments

public

boolIf true, returns only the public properties.

Response

array<string|int, mixed>

getState

Method to get state variables.

getState( property = null,  default = null) :
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() :
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

Response

void

set

Modifies a property of the object, creating it if it does not already exist.

set( property,  value = null) :
inherited deprecated
since

1.7.0
deprecated

4.3.0 will be removed in 6.0 Create a proper setter function for the property

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( error) :
inherited deprecated
since

1.7.0
deprecated

3.1.4 will be removed in 6.0 Will be removed without replacement Throw an Exception instead of using setError

Arguments

error

stringError message.

Response

void

setProperties

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

setProperties( properties) :
inherited deprecated
since

1.7.0
see CMSObject::set()
deprecated

4.3.0 will be removed in 6.0 Create a proper setter function for the property

Arguments

properties

mixedEither an associative array or another object.

Response

bool

setState

Method to set state variables.

setState( property,  value = null) :
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

_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<string|int, mixed>

__state_set

Indicates if the internal state has been set

inherited
since

4.0.0

Type(s)

bool

state

A state object

inherited
since

4.0.0

Type(s)

CMSObject

name

The model (base) name

since

4.0.0

Type(s)

string

paths

The include paths

static
since

4.0.0

Type(s)

array<string|int, mixed>
  • \ Joomla
  • \ CMS
  • \ MVC
  • \ Model
  • \ BaseModel