| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | (C) 2007 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 1097 lines (37 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ModuleModel:: (20 methods):
__construct()
populateState()
batchCopy()
batchMove()
canEditState()
delete()
duplicate()
generateNewTitle()
getClient()
getForm()
loadFormData()
getItem()
getHelp()
getTable()
prepareTable()
preprocessForm()
validate()
save()
getReorderConditions()
cleanCache()
Class: ModuleModel - X-Ref
Module model.| __construct($config = array() X-Ref |
| Constructor. param: array $config An optional associative array of configuration settings. |
| populateState() X-Ref |
| Method to auto-populate the model state. Note. Calling getState in this method will result in recursion. return: void |
| batchCopy($value, $pks, $contexts) X-Ref |
| Batch copy modules to a new position or current. param: integer $value The new value matching a module position. param: array $pks An array of row IDs. param: array $contexts An array of item contexts. return: boolean True if successful, false otherwise and internal error is set. |
| batchMove($value, $pks, $contexts) X-Ref |
| Batch move modules to a new position or current. param: integer $value The new value matching a module position. param: array $pks An array of row IDs. param: array $contexts An array of item contexts. return: boolean True if successful, false otherwise and internal error is set. |
| canEditState($record) X-Ref |
| Method to test whether a record can have its state edited. param: object $record A record object. return: boolean True if allowed to change the state of the record. Defaults to the permission set in the component. |
| 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 modules. param: array &$pks An array of primary key IDs. return: boolean Boolean true on success |
| generateNewTitle($categoryId, $title, $position) X-Ref |
| Method to change the title. param: integer $categoryId The id of the category. Not used here. param: string $title The title. param: string $position The position. return: array Contains the modified title. |
| getClient() X-Ref |
| Method to get the client object return: void |
| getForm($data = array() X-Ref |
| Method to get the record form. param: array $data Data for the form. param: boolean $loadData True if the form is to load its own data (default case), false if not. return: Form|bool 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. |
| 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. |
| getTable($type = 'Module', $prefix = 'JTable', $config = array() X-Ref |
| Returns a reference to the a Table object, always creating it. param: string $type The table type to instantiate param: string $prefix A prefix for the table class name. Optional. param: array $config Configuration array for model. Optional. return: Table A database object |
| prepareTable($table) X-Ref |
| Prepare and sanitise the table prior to saving. param: Table $table The database object return: void |
| preprocessForm(Form $form, $data, $group = 'content') X-Ref |
| Method 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 |
| validate($form, $data, $group = null) X-Ref |
| Loads ContentHelper for filters before validating data. param: object $form The form to validate against. param: array $data The data to validate. param: string $group The name of the group(defaults to null). return: mixed Array of filtered data if valid, false otherwise. |
| save($data) X-Ref |
| Method to save the form data. param: array $data The form data. return: boolean True on success. |
| getReorderConditions($table) X-Ref |
| A protected method to get a set of ordering conditions. param: object $table A record object. return: array An array of conditions to add to ordering queries. |
| cleanCache($group = null, $clientId = 0) X-Ref |
| Custom clean cache method for different clients param: string $group The name of the plugin group to import (defaults to null). 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 |