| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | (C) 2009 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 789 lines (26 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
StyleModel:: (16 methods):
__construct()
populateState()
delete()
duplicate()
generateNewTitle()
getForm()
loadFormData()
getItem()
preprocessForm()
save()
setHome()
unsetHome()
getHelp()
getAdminTemplate()
getSiteTemplates()
cleanCache()
Class: StyleModel - X-Ref
Template style model.| __construct($config = array() X-Ref |
| Constructor. param: array $config An optional associative array of configuration settings. param: MVCFactoryInterface $factory The factory. |
| populateState() X-Ref |
| Method to auto-populate the model state. return: void |
| delete(&$pks) X-Ref |
| Method to delete rows. param: array &$pks An array of item ids. return: boolean Returns true on success, false on failure. |
| duplicate(&$pks) X-Ref |
| Method to duplicate styles. param: array &$pks An array of primary key IDs. return: boolean True if successful. |
| generateNewTitle($categoryId, $alias, $title) X-Ref |
| Method to change the title. param: integer $categoryId The id of the category. param: string $alias The alias. param: string $title The title. return: string New title. |
| getForm($data = array() X-Ref |
| Method to get the record form. param: array $data An optional array of data for the form to interrogate. param: boolean $loadData True if the form is to load its own data (default case), false if not. return: Form A Form object on success, false on failure |
| loadFormData() X-Ref |
| Method to get the data that should be injected in the form. return: mixed The data for the form. |
| getItem($pk = null) X-Ref |
| Method to get a single record. param: integer $pk The id of the primary key. return: mixed Object on success, false on failure. |
| preprocessForm(Form $form, $data, $group = 'content') X-Ref |
| Method to allow derived classes to preprocess the form. param: Form $form A Form object. param: mixed $data The data expected for the form. param: string $group The name of the plugin group to import (defaults to "content"). return: void |
| save($data) X-Ref |
| Method to save the form data. param: array $data The form data. return: boolean True on success. |
| setHome($id = 0) X-Ref |
| Method to set a template style as home. param: integer $id The primary key ID for the style. return: boolean True if successful. |
| unsetHome($id = 0) X-Ref |
| Method to unset a template style as default for a language. param: integer $id The primary key ID for the style. return: boolean True if successful. |
| getHelp() X-Ref |
| Get the necessary data to load an item help screen. return: object An object with key, url, and local properties for loading the item help screen. |
| getAdminTemplate(int $styleId) X-Ref |
| Returns the back end template for the given style. param: int $styleId The style id return: stdClass |
| getSiteTemplates() X-Ref |
| Returns the front end templates. return: array |
| cleanCache($group = null, $clientId = 0) X-Ref |
| Custom clean cache method param: string $group The cache group param: integer $clientId @deprecated 5.0 No longer used. return: void |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |