Class ConfigModelComponent

Description

Model for component configuration

  • since: 3.2

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

JModelBase
   |
   --JModelDatabase
      |
      --ConfigModelCms
         |
         --ConfigModelForm
            |
            --ConfigModelComponent
Method Summary
 object getComponent ()
 mixed getForm ([array $data = array()], [boolean $loadData = true])
 void populateState ()
 boolean save (array $data)
Variables
Methods
getComponent (line 100)

Get the component information.

  • since: 3.2
  • access: public
object getComponent ()
getForm (line 60)

Method to get a form object.

  • return: A JForm object on success, false on failure
  • since: 3.2
  • access: public
mixed getForm ([array $data = array()], [boolean $loadData = true])
  • array $data: Data for the form.
  • boolean $loadData: True if the form is to load its own data (default case), false if not.

Redefinition of:
ConfigModelForm::getForm()
Abstract method for getting the form from the model.
populateState (line 30)

Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.

  • since: 3.2
  • access: protected
void populateState ()

Redefinition of:
ConfigModelCms::populateState()
Method to auto-populate the model state.
save (line 125)

Method to save the configuration data.

  • return: True on success, false on failure.
  • since: 3.2
  • throws: RuntimeException
  • access: public
boolean save (array $data)
  • array $data: An array containing all global config data.

Inherited Methods

Inherited From ConfigModelForm

 ConfigModelForm::checkin()
 ConfigModelForm::checkout()
 ConfigModelForm::getForm()
 ConfigModelForm::loadForm()
 ConfigModelForm::loadFormData()
 ConfigModelForm::preprocessData()
 ConfigModelForm::preprocessForm()
 ConfigModelForm::validate()

Inherited From ConfigModelCms

 ConfigModelCms::__construct()
 ConfigModelCms::canDelete()
 ConfigModelCms::canEditState()
 ConfigModelCms::cleanCache()
 ConfigModelCms::getName()
 ConfigModelCms::getState()
 ConfigModelCms::populateState()
 ConfigModelCms::registerTablePaths()

Inherited From JModelDatabase

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

Inherited From JModelBase

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

Documentation generated on Tue, 19 Nov 2013 14:56:15 +0100 by phpDocumentor 1.4.3