Class JModelLegacy

Base class for a Joomla Model

Acts as a Factory class for application specific objects and provides many supporting API functions.

JObject

JModelLegacy

Direct known subclasses

JModelForm, JModelItem, JModelList

Indirect known subclasses

JModelAdmin

Abstract
Package: Joomla\Legacy\Model
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.5.5
Located at legacy/model/legacy.php

Methods summary

`public static array`	# `addIncludePath( mixed $path = '', string $prefix = '' )` Add a directory where JModelLegacy should search for models. You may either pass a string or an array of directories. Add a directory where JModelLegacy should search for models. You may either pass a string or an array of directories. Parameters `$path` `mixed` - $path A path or array[sting] of paths to search. `$prefix` `string` - $prefix A prefix for models. Returns `array` - An array with directory elements. If prefix is equal to '', all directories are returned. Since 3.0
`public static`	# `addTablePath( mixed $path )` Adds to the stack of model table paths in LIFO order. Adds to the stack of model table paths in LIFO order. Parameters `$path` `mixed` - $path The directory as a string or directories as an array to add. Since 3.0
`protected static string`	# `_createFileName( string $type, array $parts = array() )` Create the filename for a resource Create the filename for a resource Parameters `$type` `string` - $type The resource type to create the filename for. `$parts` `array` - $parts An associative array of filename information. Returns `string` - The filename Since 3.0
`public static JModelLegacy\|boolean`	# `getInstance( string $type, string $prefix = '', array $config = array() )` Returns a Model object, always creating it Returns a Model object, always creating it Parameters `$type` `string` - $type The model type to instantiate `$prefix` `string` - $prefix Prefix for the model class name. Optional. `$config` `array` - $config Configuration array for model. Optional. Returns `JModelLegacy\|boolean` - A JModelLegacy instance or false on failure Since 3.0
`public`	# `__construct( array $config = array() )` Constructor Constructor Parameters `$config` `array` - $config An array of configuration options (name, state, dbo, table_path, ignore_request). Throws `Exception` Since 3.0 Overrides `JObject::__construct`
`protected object[]`	# `_getList( string $query, integer $limitstart = 0, integer $limit = 0 )` Gets an array of objects from the results of database query. Gets an array of objects from the results of database query. Parameters `$query` `string` - $query The query. `$limitstart` `integer` - $limitstart Offset. `$limit` `integer` - $limit The number of records. Returns `object[]` - An array of results. Throws `RuntimeException` Since 3.0
`protected integer`	# `_getListCount( JDatabaseQuery\|string $query )` Returns a record count for the query. Returns a record count for the query. Parameters `$query` `JDatabaseQuery\|string` - $query The query. Returns `integer` - Number of rows for query. Since 3.0
`protected JTable\|boolean`	# `_createTable( string $name, string $prefix = 'Table', array $config = array() )` Method to load and return a model object. Method to load and return a model object. Parameters `$name` `string` - $name The name of the view `$prefix` `string` - $prefix The class prefix. Optional. `$config` `array` - $config Configuration settings to pass to JTable::getInstance Returns `JTable\|boolean` - Table object or boolean false if failed Since 3.0 See `JTable::getInstance()`
`public JDatabaseDriver`	# `getDbo( )` Method to get the database driver object Method to get the database driver object Returns `JDatabaseDriver` Since 3.0
`public string`	# `getName( )` Method to get the model name Method to get the model name The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor Returns `string` - The name of the model Throws `Exception` Since 3.0
`public mixed`	# `getState( string $property = null, mixed $default = null )` Method to get model state variables Method to get model state variables Parameters `$property` `string` - $property Optional parameter name `$default` `mixed` - $default Optional default value Returns `mixed` - The property where specified, the state object where omitted Since 3.0
`public JTable`	# `getTable( string $name = '', string $prefix = 'Table', array $options = array() )` Method to get a table object, load it if necessary. Method to get a table object, load it if necessary. Parameters `$name` `string` - $name The table name. Optional. `$prefix` `string` - $prefix The class prefix. Optional. `$options` `array` - $options Configuration array for model. Optional. Returns `JTable` - A JTable object Throws `Exception` Since 3.0
`public boolean`	# `loadHistory( integer $version_id, JTable & $table )` Method to load a row for editing from the version history table. Method to load a row for editing from the version history table. Parameters `$version_id` `integer` - $version_id Key to the version history table. `$table` `JTable` - &$table Content table object being loaded. Returns `boolean` - False on failure or error, true otherwise. Since 3.2
`protected`	# `populateState( )` Method to auto-populate the model state. Method to auto-populate the model state. 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. Since 3.0 Note Calling getState in this method will result in recursion.
`public`	# `setDbo( JDatabaseDriver $db )` Method to set the database driver object Method to set the database driver object Parameters `$db` `JDatabaseDriver` - $db A JDatabaseDriver based object Since 3.0
`public mixed`	# `setState( string $property, mixed $value = null )` Method to set model state variables Method to set model state variables Parameters `$property` `string` - $property The name of the property. `$value` `mixed` - $value The value of the property to set or null. Returns `mixed` - The previous value of the property or null if not set. Since 3.0
`protected`	# `cleanCache( string $group = null, integer $client_id = 0 )` Clean the cache Clean the cache Parameters `$group` `string` - $group The cache group `$client_id` `integer` - $client_id The ID of the client Since 3.0

Methods inherited from JObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`protected boolean`	`$__state_set`	# Indicates if the internal state has been set Indicates if the internal state has been set Since 3.0
`protected JDatabaseDriver`	`$_db`	# Database Connector Database Connector Since 3.0
`protected string`	`$name`	# The model (base) name The model (base) name Since 3.0
`protected string`	`$option`	# The URL option for the component. The URL option for the component. Since 3.0
`protected JObject`	`$state`	# A state object A state object Since 3.0
`protected string`	`$event_clean_cache`	# The event to trigger when cleaning cache. The event to trigger when cleaning cache. Since 3.0

Properties inherited from JObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JModelLegacy

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Returns

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Throws

Since

Overrides

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

See

Returns

Since

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Since

Note

Parameters

Since

Parameters

Returns

Since

Parameters

Since

Methods inherited from JObject

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Properties inherited from JObject