Template style model.

• since: 1.6

Located in /administrator/components/com_templates/models/style.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --JModelForm
         |
         --JModelAdmin
            |
            --TemplatesModelStyle

string $helpKey = 'JHELP_EXTENSIONS_TEMPLATE_MANAGER_STYLES_EDIT' (line 25)

• var: The help screen key for the module.
• since: 1.6
• access: protected

string $helpURL (line 31)

• var: The help screen base URL for the module.
• since: 1.6
• access: protected

Inherited Variables

Inherited from JModelAdmin

JModelAdmin::$event_after_delete
JModelAdmin::$event_after_save
JModelAdmin::$event_before_delete
JModelAdmin::$event_before_save
JModelAdmin::$event_change_state
JModelAdmin::$text_prefix

Inherited from JModelForm

JModelForm::$_forms

Inherited from JModelLegacy

JModelLegacy::$event_clean_cache
JModelLegacy::$name
JModelLegacy::$option
JModelLegacy::$state
JModelLegacy::$_db
JModelLegacy::$__state_set

Inherited from JObject

JObject::$_errors

cleanCache (line 671)

Custom clean cache method

• since: 1.6
• access: protected

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

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

---

Redefinition of:

JModelLegacy::cleanCache()

Clean the cache

delete (line 67)

Method to delete rows.

• return: Returns true on success, false on failure.
• access: public

boolean delete (array &$pks)

• array &$pks: An array of item ids.

duplicate (line 122)

Method to duplicate styles.

• return: True if successful.
• throws: Exception
• access: public

boolean duplicate (array &$pks)

• array &$pks: An array of primary key IDs.

generateNewTitle (line 176)

Method to change the title.

• return: New title.
• since: 1.7.1
• access: protected

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

• integer $category_id: The id of the category.
• string $alias: The alias.
• string $title: The title.

getForm (line 199)

Method to get the record form.

• return: A JForm object on success, false on failure
• since: 1.6
• access: public

JForm getForm ([array $data = array()], [boolean $loadData = true])

• array $data: An optional array of data for the form to interogate.
• boolean $loadData: True if the form is to load its own data (default case), false if not.

---

Redefinition of:

JModelForm::getForm()

Abstract method for getting the form from the model.

getHelp (line 656)

Get the necessary data to load an item help screen.

• return: object with key, url, and local properties for loading the item help screen.
• since: 1.6
• access: public

object An getHelp ()

getItem (line 269)

Method to get a single record.

• return: Object on success, false on failure.
• access: public

mixed getItem ([integer $pk = null])

• integer $pk: The id of the primary key.

getTable (line 326)

Returns a reference to the a Table object, always creating it.

• return: A database object
• access: public

JTable getTable ([type $type = 'Style'], [string $prefix = 'TemplatesTable'], [array $config = array()])

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

---

Redefinition of:

JModelLegacy::getTable()

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

loadFormData (line 247)

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

• return: The data for the form.
• since: 1.6
• access: protected

mixed loadFormData ()

---

Redefinition of:

JModelForm::loadFormData()

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

populateState (line 47)

Method to auto-populate the model state.

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

• since: 1.6
• access: protected

void populateState ()

---

Redefinition of:

JModelLegacy::populateState()

Method to auto-populate the model state.

preprocessForm (line 343)

TODO

• since: 1.6
• throws: Exception if there is an error in the form event.
• access: protected

void preprocessForm (JForm $form, mixed $data, [string $group = 'content'])

• object $form: A form object.
• mixed $data: The data expected for the form.
• string $group: TODO

---

Redefinition of:

JModelForm::preprocessForm()

Method to allow derived classes to preprocess the form.

save (line 409)

Method to save the form data.

• return: True on success.
• access: public

boolean save (array $data)

• array $data: The form data.

setHome (line 549)

Method to set a template style as home.

• return: True if successful.
• throws: Exception
• access: public

boolean setHome ([integer $id = 0])

• integer $id: The primary key ID for the style.

unsetHome (line 607)

Method to unset a template style as default for a language.

• return: True if successful.
• throws: Exception
• access: public

boolean unsetHome ([integer $id = 0])

• integer $id: The primary key ID for the style.

Inherited Methods

Inherited From JModelAdmin

JModelAdmin::__construct()
JModelAdmin::batch()
JModelAdmin::batchAccess()
JModelAdmin::batchCopy()

Inherited From JModelForm

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

Inherited From JModelLegacy

JModelLegacy::__construct()
JModelLegacy::addIncludePath()
JModelLegacy::addTablePath()
JModelLegacy::cleanCache()
JModelLegacy::getDbo()
JModelLegacy::getInstance()
JModelLegacy::getName()
JModelLegacy::getState()
JModelLegacy::getTable()
JModelLegacy::loadHistory()
JModelLegacy::populateState()
JModelLegacy::setDbo()
JModelLegacy::setState()
JModelLegacy::_createFileName()
JModelLegacy::_createTable()
JModelLegacy::_getList()
JModelLegacy::_getListCount()

Inherited From JObject

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