Joomla! API

package	Joomla.Platform
subpackage	Application
since	11.1

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null)

inherited

since	11.1

Arguments

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

Magic method to convert the object to a string gracefully.

__toString() : string

inherited deprecated

since	11.1
deprecated	12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

Create the filename for a resource

_createFileName(string $type, array $parts = array()) : string

inherited static

since	11.1

Arguments

$type: stringThe resource type to create the filename for.
$parts: arrayAn associative array of filename information.

Response

stringThe filename

Method to load and return a model object.

_createTable(string $name, string $prefix = 'Table', array $config = array()) : mixed

inherited

since	11.1
see	\JTable::getInstance

Arguments

$name: stringThe name of the view
$prefix: stringThe class prefix. Optional.
$config: arrayConfiguration settings to pass to JTable::getInstance

Response

mixedModel object or boolean false if failed

Gets an array of objects from the results of database query.

_getList(string $query, integer $limitstart, integer $limit) : array

inherited

since	11.1

Arguments

$query: stringThe query.
$limitstart: integerOffset.
$limit: integerThe number of records.

Response

arrayAn array of results.

Returns a record count for the query

_getListCount(string $query) : integer

inherited

since	11.1

Arguments

$query: stringThe query.

Response

integerNumber of rows for query

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

addIncludePath(mixed $path = '', string $prefix = '') : array

inherited static

since	11.1

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.

Adds to the stack of model table paths in LIFO order.

addTablePath(mixed $path) : void

inherited static

since	11.1

Arguments

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

Method to perform batch operations on an item or a set of items.

batch(array $commands, array $pks, array $contexts) : boolean

since	11.1

Arguments

$commands: arrayAn array of commands to perform.
$pks: arrayAn array of item ids.
$contexts: arrayAn array of item contexts.

Response

booleanReturns true on success, false on failure.

Batch access level changes for a group of rows.

batchAccess(integer $value, array $pks, array $contexts) : boolean

since	11.1

Arguments

$value: integerThe new value matching an Asset Group ID.
$pks: arrayAn array of row IDs.
$contexts: arrayAn array of item contexts.

Response

booleanTrue if successful, false otherwise and internal error is set.

Batch copy items to a new category or current.

batchCopy(integer $value, array $pks, array $contexts) : mixed

since	11.1

Arguments

$value: integerThe new category.
$pks: arrayAn array of row IDs.
$contexts: arrayAn array of item contexts.

Response

mixedAn array of new IDs on success, boolean false on failure.

Batch language changes for a group of rows.

batchLanguage(string $value, array $pks, array $contexts) : boolean

since	11.3

Arguments

$value: stringThe new value matching a language.
$pks: arrayAn array of row IDs.
$contexts: arrayAn array of item contexts.

Response

booleanTrue if successful, false otherwise and internal error is set.

Batch move items to a new category

batchMove(integer $value, array $pks, array $contexts) : boolean

since	11.1

Arguments

$value: integerThe new category ID.
$pks: arrayAn array of row IDs.
$contexts: arrayAn array of item contexts.

Response

booleanTrue if successful, false otherwise and internal error is set.

Method to test whether a record can be deleted.

canDelete(object $record) : boolean

since	11.1

Arguments

$record: objectA record object.

Response

booleanTrue if allowed to delete the record. Defaults to the permission for the component.

Method to test whether a record can be deleted.

canEditState(object $record) : boolean

since	11.1

Arguments

$record: objectA record object.

Response

booleanTrue if allowed to change the state of the record. Defaults to the permission for the component.

Method to checkin a row.

checkin(integer $pk = null) : boolean

inherited

since	11.1

Arguments

$pk: integerThe numeric id of the primary key.

Response

booleanFalse on failure or error, true otherwise.

Method to check-out a row for editing.

checkout(integer $pk = null) : boolean

inherited

since	11.1

Arguments

$pk: integerThe numeric id of the primary key.

Response

booleanFalse on failure or error, true otherwise.

Clean the cache

cleanCache(string $group = null, integer $client_id) : void

inherited

since	11.1

Arguments

$group: stringThe cache group
$client_id: integerThe ID of the client

Sets a default value if not alreay assigned

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

inherited

since	11.1

Arguments

$property: stringThe name of the property.
$default: mixedThe default value.

Response

mixed

Method to delete one or more records.

delete( &$pks) : boolean

since	11.1

Arguments

$pks

Response

booleanTrue if successful, false if an error occurs.

Method to change the title & alias.

generateNewTitle(integer $category_id, string $alias, string $title) : array

since	11.1

Arguments

$category_id: integerThe id of the category.
$alias: stringThe alias.
$title: stringThe title.

Response

arrayContains the modified title and alias.

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	11.1
see	\JObject::getProperties()

Arguments

$property: stringThe name of the property.
$default: mixedThe default value.

Response

mixedThe value of the property.

Method to get the database driver object

getDbo() : \JDatabase

inherited

Response

\JDatabase

Get the most recent error message.

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

inherited deprecated

since	11.1
see	\JError
deprecated	12.3 JError has been deprecated

Arguments

$i: integerOption error index.
$toString: booleanIndicates if JError objects should return their error message.

Response

stringError message

Return all errors, if any.

getErrors() : array

inherited deprecated

since	11.1
see	\JError
deprecated	12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

Abstract method for getting the form from the model.

getForm(array $data = array(), boolean $loadData = true) : mixed

inherited abstract

since	11.1

Arguments

$data: arrayData for the form.
$loadData: booleanTrue if the form is to load its own data (default case), false if not.

Response

mixedA JForm object on success, false on failure

Returns a Model object, always creating it

getInstance(string $type, string $prefix = '', array $config = array()) : mixed

inherited static

since	11.1

Arguments

$type: stringThe model type to instantiate
$prefix: stringPrefix for the model class name. Optional.
$config: arrayConfiguration array for model. Optional.

Response

mixedA model object or false on failure

Method to get a single record.

getItem(integer $pk = null) : mixed

since	11.1

Arguments

$pk: integerThe id of the primary key.

Response

mixedObject on success, false on failure.

Method to get the model name

getName() : string

inherited

The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor

since	11.1

Response

stringThe name of the model

Returns an associative array of object properties.

getProperties(boolean $public = true) : array

inherited

since	11.1
see	\JObject::get()

Arguments

$public: booleanIf true, returns only the public properties.

Response

array

A protected method to get a set of ordering conditions.

getReorderConditions(\JTable $table) : array

since	11.1

Arguments

$table: \JTableA JTable object.

Response

arrayAn array of conditions to add to ordering queries.

Method to get model state variables

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

inherited

since	11.1

Arguments

$property: stringOptional parameter name
$default: mixedOptional default value

Response

objectThe property where specified, the state object where omitted

Method to get a table object, load it if necessary.

getTable(string $name = '', string $prefix = 'Table', array $options = array()) : \JTable

inherited

since	11.1

Arguments

$name: stringThe table name. Optional.
$prefix: stringThe class prefix. Optional.
$options: arrayConfiguration array for model. Optional.

Response

\JTableA JTable object

Method to get a form object.

loadForm(string $name, string $source = null, array $options = array(), boolean $clear = false, string $xpath = false) : mixed

inherited

see	\JForm
since	11.1

Arguments

$name: stringThe name of the form.
$source: stringThe form source. Can be XML string if file flag is set to false.
$options: arrayOptional array of options for the form creation.
$clear: booleanOptional argument to force load a new form.
$xpath: stringAn optional xpath to search for the fields.

Response

mixedJForm object on success, False on error.

Method to get the data that should be injected in the form.

loadFormData() : array

inherited

since	11.1

Response

arrayThe default data is an empty array.

Method to auto-populate the model 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 model configuration flag to ignore the request is set.

note	Calling getState in this method will result in recursion.
since	11.1

Prepare and sanitise the table data prior to saving.

prepareTable( &$table) : void

since	11.1

Arguments

$table

Method to allow derived classes to preprocess the form.

preprocessForm(\JForm $form, mixed $data, string $group = 'content') : void

inherited

see	\JFormField
since	11.1
throws	`\Exception`if there is an error in the form event.

Arguments

$form: \JFormA JForm object.
$data: mixedThe data expected for the form.
$group: stringThe name of the plugin group to import (defaults to "content").

Method to change the published state of one or more records.

publish( &$pks, integer $value = 1) : boolean

since	11.1

Arguments

$pks
$value: integerThe value of the published state.

Response

booleanTrue on success.

Method to adjust the ordering of a row.

reorder(integer $pks, integer $delta) : mixed

Returns NULL if the user did not have edit privileges for any of the selected primary keys.

since	11.1

Arguments

$pks: integerThe ID of the primary key to move.
$delta: integerIncrement, usually +1 or -1

Response

mixedFalse on failure or error, true on success, null if the $pk is empty (no items selected).

Method to save the form data.

save(array $data) : boolean

since	11.1

Arguments

$data: arrayThe form data.

Response

booleanTrue on success, False on error.

Saves the manually set order of records.

saveorder(array $pks = null, integer $order = null) : mixed

since	11.1

Arguments

$pks: arrayAn array of primary key ids.
$order: integer+1 or -1

Response

mixed

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

set(string $property, mixed $value = null) : mixed

inherited

since	11.1

Arguments

$property: stringThe name of the property.
$value: mixedThe value of the property to set.

Response

mixedPrevious value of the property.

Method to set the database driver object

setDbo( &$db) : void

inherited

since	11.1

Arguments

$db

Add an error message.

setError(string $error) : void

inherited deprecated

since	11.1
see	\JError
deprecated	12.3 JError has been deprecated

Arguments

$error: stringError message.

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

setProperties(mixed $properties) : boolean

inherited

since	11.1
see	\JObject::set()

Arguments

$properties: mixedEither an associative array or another object.

Response

boolean

Method to set model state variables

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

inherited

since	11.1

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.

Converts the object to a string (the class name).

toString() : string

inherited deprecated

since	11.1
deprecated	12.1 Use magic method __toString()
see	\JObject::__toString()

Response

string

Method to validate the form data.

validate(\JForm $form, array $data, string $group = null) : mixed

inherited

see	\JFormRule \JFilterInput
since	11.1

Arguments

$form: \JFormThe form to validate against.
$data: arrayThe data to validate.
$group: stringThe name of the field group to validate.

Response

mixedArray of filtered data if valid, false otherwise.

The prefix to use with controller messages.

since	11.1

Type(s)

string

The event to trigger after deleting the data.

since	11.1

Type(s)

string

The event to trigger after saving the data.

since	11.1

Type(s)

string

The event to trigger before deleting the data.

since	11.1

Type(s)

string

The event to trigger before saving the data.

since	11.1

Type(s)

string

The event to trigger after changing the published state of the data.

since	11.1

Type(s)

string

Array of form objects.

inherited

since	11.1

Type(s)

array

Indicates if the internal state has been set

inherited

since	11.1

Type(s)

boolean

Database Connector

inherited

since	11.1

Type(s)

object

The model (base) name

inherited

note	Replaces _name variable in 11.1
since	11.1

Type(s)

string

The URL option for the component.

inherited

since	11.1

Type(s)

string

A state object

inherited

note	Replaces _state variable in 11.1
since	11.1

Type(s)

string

The event to trigger when cleaning cache.

inherited

since	11.1

Type(s)

string

An array of error messages or Exception objects.

inherited deprecated

since	11.1
see	\JError
deprecated	12.3 JError has been deprecated

Type(s)

array

JModelAdmin

Methods

__construct

Arguments

__toString

Response

_createFileName

Arguments

Response

_createTable

Arguments

Response

_getList

Arguments

Response

_getListCount

Arguments

Response

addIncludePath

Arguments

Response

addTablePath

Arguments

batch

Arguments

Response

batchAccess

Arguments

Response

batchCopy

Arguments

Response

batchLanguage

Arguments

Response

batchMove

Arguments

Response

canDelete

Arguments

Response

canEditState

Arguments

Response

checkin

Arguments

Response

checkout

Arguments

Response

cleanCache

Arguments

def

Arguments

Response

delete

Arguments

Response

generateNewTitle

Arguments

Response

get

Arguments

Response

getDbo

Response

getError

Arguments

Response

getErrors

Response

getForm

Arguments

Response

getInstance

Arguments

Response

getItem

Arguments

Response