Docs For Class JModelLegacy

JModelLegacy

Description

Base class for a Joomla Model

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

abstract:
since: 12.2

Located in /libraries/legacy/model/legacy.php (line 22)

JObject
   |
   --JModelLegacy

Direct descendents

Class	Description
AdminModelHelp	Admin Component Help Model
AdminModelSysInfo	Model for the display of system information.
FinderModelIndexer	Indexer model class for Finder.
FinderModelStatistics	Statistics model class for Finder.
InstallerModelInstall	Extension Manager Install Model
JoomlaupdateModelDefault	Joomla! update overview Model
LanguagesModelStrings	Languages Strings Model
LoginModelLogin	Login Model
MediaModelList	Media Component List Model
MediaModelManager	Media Component Manager Model
MenusModelMenutypes	Menu Item Types Model for Menus.
BannersModelBanner	Banner model for the Joomla Banners component.
SearchModelSearch	Search Component Search Model
JModelForm	Prototype form model.
JModelItem	Prototype item model.
JModelList	Model class for handling lists of items.

Variable Summary

string $event_clean_cache

string $name

string $option

string $state

object $_db

boolean $__state_set

Method Summary

static array addIncludePath ([mixed $path = ''], [string $prefix = ''])

static void addTablePath (mixed $path)

static mixed getInstance (string $type, [string $prefix = ''], [array $config = array()])

static string _createFileName (string $type, [array $parts = array()])

JModelLegacy __construct ([array $config = array()])

void cleanCache ([string $group = null], [integer $client_id = 0])

JDatabaseDriver getDbo ()

string getName ()

object The getState ([string $property = null], [mixed $default = null])

JTable getTable ([string $name = ''], [string $prefix = 'Table'], [array $options = array()])

boolean loadHistory (integer $version_id, JTable &$table)

void populateState ()

void setDbo (JDatabaseDriver $db)

mixed setState (string $property, [mixed $value = null])

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

array _getList (string $query, [integer $limitstart = 0], [integer $limit = 0])

integer _getListCount (JDatabaseQuery|string $query)

Variables

string $event_clean_cache = null (line 70)

The event to trigger when cleaning cache.

since: 12.2
access: protected

string $name (line 46)

The model (base) name

since: 12.2
access: protected

string $option = null (line 54)

The URL option for the component.

since: 12.2
access: protected

Redefined in descendants as:

LanguagesModelInstalled::$option

string $state (line 62)

A state object

since: 12.2
access: protected

object $_db (line 38)

Database Connector

since: 12.2
access: protected

boolean $__state_set = null (line 30)

Indicates if the internal state has been set

since: 12.2
access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors

Methods

static addIncludePath (line 83)

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

return: An array with directory elements. If prefix is equal to '', all directories are returned.
since: 12.2
access: public

static array addIncludePath ([mixed $path = ''], [string $prefix = ''])

mixed $path: A path or array[sting] of paths to search.
string $prefix: A prefix for models.

static addTablePath (line 129)

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

since: 12.2
access: public

static void addTablePath (mixed $path)

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

static getInstance (line 169)

Returns a Model object, always creating it

return: A model object or false on failure
since: 12.2
access: public

static mixed getInstance (string $type, [string $prefix = ''], [array $config = array()])

string $type: The model type to instantiate
string $prefix: Prefix for the model class name. Optional.
array $config: Configuration array for model. Optional.

static _createFileName (line 144)

Create the filename for a resource

return: The filename
since: 12.2
access: protected

static string _createFileName (string $type, [array $parts = array()])

string $type: The resource type to create the filename for.
array $parts: An associative array of filename information.

Constructor __construct (line 209)

Constructor

since: 12.2
throws: Exception
access: public

JModelLegacy __construct ([array $config = array()])

array $config: An array of configuration options (name, state, dbo, table_path, ignore_request).

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

Redefined in descendants as:

SearchModelSearch::__construct() : Constructor
UsersModelProfile::__construct()
JModelAdmin::__construct() : Constructor.
CategoriesModelCategory::__construct() : Override parent constructor.
UsersModelUser::__construct() : Constructor.
JModelList::__construct() : Constructor.
BannersModelClients::__construct() : Constructor.
BannersModelTracks::__construct() : Constructor.
CategoriesModelCategories::__construct() : Constructor.
ContactModelContacts::__construct() : Constructor.
ContentModelArticles::__construct() : Constructor.
ContenthistoryModelHistory::__construct() : Constructor.
FinderModelFilters::__construct() : Constructor.
FinderModelIndex::__construct() : Constructor.
FinderModelMaps::__construct() : Constructor.
InstallerModel::__construct() : Constructor.
InstallerModelManage::__construct() : Constructor.
InstallerModelLanguages::__construct() : Constructor override, defines a white list of column filters.
InstallerModelUpdate::__construct() : Constructor.
LanguagesModelLanguages::__construct() : Constructor.
LanguagesModelOverrides::__construct() : Constructor
MenusModelItems::__construct() : Constructor.
MenusModelMenus::__construct() : Constructor.
MessagesModelMessages::__construct() : Constructor.
ModulesModelModules::__construct() : Constructor.
ModulesModelPositions::__construct() : Constructor.
NewsfeedsModelNewsfeeds::__construct() : Constructor.
PluginsModelPlugins::__construct() : Constructor.
RedirectModelLinks::__construct() : Constructor.
SearchModelSearches::__construct() : Constructor.
TemplatesModelStyles::__construct() : Constructor.
TemplatesModelTemplates::__construct() : Constructor.
UsersModelGroups::__construct() : Constructor.
UsersModelLevels::__construct() : Constructor.
UsersModelNotes::__construct() : Class constructor.
UsersModelUsers::__construct() : Constructor.
WeblinksModelWeblinks::__construct() : Constructor.
ContactModelCategory::__construct() : Constructor.
ContactModelFeatured::__construct() : Constructor.
ContentModelCategory::__construct() : Constructor.
NewsfeedsModelCategory::__construct() : Constructor.
TagsModelTag::__construct() : Constructor.
WeblinksModelCategory::__construct() : Constructor.

cleanCache (line 557)

Clean the cache

since: 12.2
access: protected

void cleanCache ([string $group = null], [integer $client_id = 0])

string $group: The cache group
integer $client_id: The ID of the client

Redefined in descendants as:

MenusModelMenu::cleanCache() : Custom clean cache method
CategoriesModelCategory::cleanCache() : Custom clean the cache of com_content and content modules
ContentModelArticle::cleanCache() : Custom clean the cache of com_content and content modules
FinderModelFilter::cleanCache() : Custom clean cache method.
LanguagesModelLanguage::cleanCache() : Custom clean cache method
MenusModelItem::cleanCache() : Custom clean cache method
ModulesModelModule::cleanCache() : Custom clean cache method for different clients
PluginsModelPlugin::cleanCache() : Custom clean cache method, plugins are cached in 2 places for different clients
TemplatesModelStyle::cleanCache() : Custom clean cache method
LanguagesModelLanguages::cleanCache() : Custom clean cache method, 2 places for 2 clients

getDbo (line 369)

Method to get the database driver object

access: public

JDatabaseDriver getDbo ()

getName (line 385)

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

return: The name of the model
since: 12.2
throws: Exception
access: public

string getName ()

getState (line 410)

Method to get model state variables

return: property where specified, the state object where omitted
since: 12.2
access: public

object The getState ([string $property = null], [mixed $default = null])

string $property: Optional parameter name
mixed $default: Optional default value

Redefined in descendants as:

getTable (line 436)

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

return: A JTable object
since: 12.2
throws: Exception
access: public

JTable getTable ([string $name = ''], [string $prefix = 'Table'], [array $options = array()])

string $name: The table name. Optional.
string $prefix: The class prefix. Optional.
array $options: Configuration array for model. Optional.

Redefined in descendants as:

MenusModelMenu::getTable() : Returns a Table object, always creating it
BannersModelBanner::getTable() : Returns a JTable object, always creating it.
BannersModelClient::getTable() : Returns a reference to the a Table object, always creating it.
CategoriesModelCategory::getTable() : Method to get a table object, load it if necessary.
ContactModelContact::getTable() : Returns a Table object, always creating it
ContentModelArticle::getTable() : Returns a Table object, always creating it.
ContentModelFeature::getTable() : Returns a Table object, always creating it.
FinderModelFilter::getTable() : Returns a JTable object, always creating it.
LanguagesModelLanguage::getTable() : Override to get the table
MenusModelItem::getTable() : Returns a Table object, always creating it
MessagesModelMessage::getTable() : Returns a Table object, always creating it.
ModulesModelModule::getTable() : Returns a reference to the a Table object, always creating it.
NewsfeedsModelNewsfeed::getTable() : Returns a Table object, always creating it.
PluginsModelPlugin::getTable() : Returns a reference to the a Table object, always creating it.
RedirectModelLink::getTable() : Returns a reference to the a Table object, always creating it.
TagsModelTag::getTable() : Method to get a table object, load it if necessary.
TemplatesModelStyle::getTable() : Returns a reference to the a Table object, always creating it.
UsersModelGroup::getTable() : Returns a reference to the a Table object, always creating it.
UsersModelLevel::getTable() : Returns a reference to the a Table object, always creating it.
UsersModelNote::getTable() : Method to get a table object, load it if necessary.
UsersModelUser::getTable() : Returns a reference to the a Table object, always creating it.
WeblinksModelWeblink::getTable() : Method to get a table object, load it if necessary.
WeblinksModelWeblink::getTable() : Returns a reference to the a Table object, always creating it.
ContenthistoryModelHistory::getTable() : Method to get a table object, load it if necessary.
FinderModelIndex::getTable() : Returns a JTable object, always creating it.
FinderModelMaps::getTable() : Returns a JTable object, always creating it.

loadHistory (line 461)

Method to load a row for editing from the version history table.

return: False on failure or error, true otherwise.
since: 12.2
access: public

boolean loadHistory (integer $version_id, JTable &$table)

integer $version_id: Key to the version history table.
JTable &$table: Content table object being loaded.

populateState (line 514)

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: 12.2
access: protected

void populateState ()

Redefined in descendants as:

InstallerModelInstall::populateState() : Method to auto-populate the model state.
LoginModelLogin::populateState() : Method to auto-populate the model state.
BannersModelDownload::populateState() : Method to auto-populate the model state.
MenusModelMenu::populateState() : Method to auto-populate the model state.
MessagesModelConfig::populateState() : Method to auto-populate the model state.
TemplatesModelTemplate::populateState() : Method to auto-populate the model state.
ContactModelContact::populateState() : Method to auto-populate the model state.
UsersModelLogin::populateState() : Method to auto-populate the model state.
UsersModelProfile::populateState() : Method to auto-populate the model state.
UsersModelRegistration::populateState() : Method to auto-populate the model state.
UsersModelRemind::populateState() : Method to auto-populate the model state.
UsersModelReset::populateState() : Method to auto-populate the model state.
CategoriesModelCategory::populateState() : Auto-populate the model state.
LanguagesModelLanguage::populateState() : Method to auto-populate the model state.
LanguagesModelOverride::populateState() : Method to auto-populate the model state.
MenusModelItem::populateState() : Auto-populate the model state.
MessagesModelMessage::populateState() : Method to auto-populate the model state.
ModulesModelModule::populateState() : Method to auto-populate the model state.
PluginsModelPlugin::populateState() : Auto-populate the model state.
TagsModelTag::populateState() : Auto-populate the model state.
TemplatesModelStyle::populateState() : Method to auto-populate the model state.
UsersModelNote::populateState() : Method to auto-populate the model state.
ContentModelArticle::populateState() : Method to auto-populate the model state.
ContentModelForm::populateState() : Method to auto-populate the model state.
NewsfeedsModelNewsfeed::populateState() : Method to auto-populate the model state.
WeblinksModelWeblink::populateState() : Method to auto-populate the model state.
WeblinksModelForm::populateState() : Method to auto-populate the model state.
JModelList::populateState() : Method to auto-populate the model state.
BannersModelClients::populateState() : Method to auto-populate the model state.
BannersModelTracks::populateState() : Method to auto-populate the model state.
CacheModelCache::populateState() : Method to auto-populate the model state.
CategoriesModelCategories::populateState() : Method to auto-populate the model state.
CheckinModelCheckin::populateState() : Method to auto-populate the model state.
ContactModelContacts::populateState() : Method to auto-populate the model state.
ContentModelArticles::populateState() : Method to auto-populate the model state.
ContentModelArchive::populateState() : Method to auto-populate the model state.
ContentModelFeatured::populateState() : Method to auto-populate the model state.
ContenthistoryModelHistory::populateState() : Method to auto-populate the model state.
FinderModelFilters::populateState() : Method to auto-populate the model state. Calling getState in this method will result in recursion.
FinderModelIndex::populateState() : Method to auto-populate the model state. Calling getState in this method will result in recursion.
FinderModelMaps::populateState() : Method to auto-populate the model state. Calling getState in this method will result in recursion.
InstallerModelDatabase::populateState() : Method to auto-populate the model state.
InstallerModelDiscover::populateState() : Method to auto-populate the model state.
InstallerModelManage::populateState() : Method to auto-populate the model state.
InstallerModelLanguages::populateState() : Method to auto-populate the model state.
InstallerModelUpdate::populateState() : Method to auto-populate the model state.
LanguagesModelInstalled::populateState() : Method to auto-populate the model state.
LanguagesModelLanguages::populateState() : Method to auto-populate the model state.
LanguagesModelOverrides::populateState() : Method to auto-populate the model state.
MenusModelItems::populateState() : Method to auto-populate the model state.
MenusModelMenus::populateState() : Method to auto-populate the model state.
MessagesModelMessages::populateState() : Method to auto-populate the model state.
ModulesModelModules::populateState() : Method to auto-populate the model state.
ModulesModelPositions::populateState() : Method to auto-populate the model state.
ModulesModelSelect::populateState() : Method to auto-populate the model state.
NewsfeedsModelNewsfeeds::populateState() : Method to auto-populate the model state.
PluginsModelPlugins::populateState() : Method to auto-populate the model state.
RedirectModelLinks::populateState() : Method to auto-populate the model state.
SearchModelSearches::populateState() : Method to auto-populate the model state.
TagsModelTags::populateState() : Method to auto-populate the model state.
TemplatesModelStyles::populateState() : Method to auto-populate the model state.
TemplatesModelTemplates::populateState() : Method to auto-populate the model state.
UsersModelDebuggroup::populateState() : Method to auto-populate the model state.
UsersModelDebugUser::populateState() : Method to auto-populate the model state.
UsersModelGroups::populateState() : Method to auto-populate the model state.
UsersModelLevels::populateState() : Method to auto-populate the model state.
UsersModelNotes::populateState() : Method to auto-populate the model state.
UsersModelUsers::populateState() : Method to auto-populate the model state.
WeblinksModelWeblinks::populateState() : Method to auto-populate the model state.
ContactModelCategories::populateState() : Method to auto-populate the model state.
ContactModelCategory::populateState() : Method to auto-populate the model state.
ContactModelFeatured::populateState() : Method to auto-populate the model state.
ContentModelCategories::populateState() : Method to auto-populate the model state.
ContentModelCategory::populateState() : Method to auto-populate the model state.
FinderModelSearch::populateState() : Method to auto-populate the model state. Calling getState in this method will result in recursion.
FinderModelSuggestions::populateState() : Method to auto-populate the model state. Calling getState in this method will result in recursion.
NewsfeedsModelCategories::populateState() : Method to auto-populate the model state.
NewsfeedsModelCategory::populateState() : Method to auto-populate the model state.
TagsModelTag::populateState() : Method to auto-populate the model state.
WeblinksModelCategories::populateState() : Method to auto-populate the model state.
WeblinksModelCategory::populateState() : Method to auto-populate the model state.

setDbo (line 527)

Method to set the database driver object

since: 12.2
access: public

void setDbo (JDatabaseDriver $db)

JDatabaseDriver $db: A JDatabaseDriver based object

setState (line 542)

Method to set model state variables

return: The previous value of the property or null if not set.
since: 12.2
access: public

mixed setState (string $property, [mixed $value = null])

string $property: The name of the property.
mixed $value: The value of the property to set or null.

_createTable (line 349)

Method to load and return a model object.

return: Model object or boolean false if failed
see: JTable::getInstance()
since: 12.2
access: protected

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

string $name: The name of the view
string $prefix: The class prefix. Optional.
array $config: Configuration settings to pass to JTable::getInstance

_getList (line 298)

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

return: An array of results.
since: 12.2
throws: RuntimeException
access: protected

array _getList (string $query, [integer $limitstart = 0], [integer $limit = 0])

string $query: The query.
integer $limitstart: Offset.
integer $limit: The number of records.

Redefined in descendants as:

ContentModelArchive::_getList()
InstallerModel::_getList() : Returns an object list
ModulesModelModules::_getList() : Returns an object list
PluginsModelPlugins::_getList() : Returns an object list

_getListCount (line 315)

Returns a record count for the query.

return: Number of rows for query.
since: 12.2
access: protected

integer _getListCount (JDatabaseQuery|string $query)

JDatabaseQuery|string $query: The query.

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()

Documentation generated on Tue, 19 Nov 2013 15:06:49 +0100 by phpDocumentor 1.4.3