Docs For Class ConfigModelCms

Description

Prototype admin model.

abstract:
since: 3.2

Located in /components/com_config/model/cms.php (line 19)

JModelBase
   |
   --JModelDatabase
      |
      --ConfigModelCms

Direct descendents

Class	Description
ConfigModelForm	Prototype form model.

Variable Summary

string $name

string $option

string $text_prefix

boolean $__state_set

Method Summary

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

boolean canDelete (object $record)

boolean canEditState (object $record)

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

string getName ()

object The getState ()

void populateState ()

object The registerTablePaths ([array $config = array()])

Variables

string $name (line 27)

The model (base) name

since: 3.2
access: protected

string $option = null (line 35)

The URL option for the component.

since: 3.2
access: protected

string $text_prefix = null (line 43)

The prefix to use with controller messages.

since: 3.2
access: protected

boolean $__state_set = null (line 51)

Indicates if the internal state has been set

since: 3.2
access: protected

Inherited Variables

Inherited from JModelDatabase

JModelDatabase::$db

Inherited from JModelBase

JModelBase::$state

Methods

Constructor __construct (line 61)

Constructor

since: 3.2
throws: Exception
access: public

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

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

Redefinition of:

JModelDatabase::__construct(): Instantiate the model.

canDelete (line 257)

Method to test whether a record can be deleted.

return: True if allowed to delete the record. Defaults to the permission set in the component.
since: 3.2
access: protected

boolean canDelete (object $record)

object $record: A record object.

canEditState (line 281)

Method to test whether a record can have its state changed.

return: True if allowed to change the state of the record. Defaults to the permission set in the component.
since: 3.2
access: protected

boolean canEditState (object $record)

object $record: A record object.

cleanCache (line 215)

Clean the cache

since: 3.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

getName (line 140)

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: 3.2
throws: Exception
access: public

string getName ()

getState (line 164)

Method to get model state variables

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

object The getState ()

Redefinition of:

JModelBase::getState(): Get the model state.

populateState (line 243)

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.2
access: protected

void populateState ()

Redefined in descendants as:

ConfigModelComponent::populateState() : Method to auto-populate the model state.
ConfigModelTemplates::populateState() : Method to auto-populate the model state.

registerTablePaths (line 187)

Method to register paths for tables

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

object The registerTablePaths ([array $config = array()])

array $config: Configuration array

Inherited Methods

Inherited From JModelDatabase

JModelDatabase::__construct()
JModelDatabase::getDb()
JModelDatabase::loadDb()
JModelDatabase::setDb()

Inherited From JModelBase

JModelBase::__construct()
JModelBase::getState()
JModelBase::loadState()
JModelBase::setState()