| [ Index ] |
PHP Cross Reference of Joomla 2.5.4 DE |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 1080 lines (26 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ModulesModelModule:: (19 methods):
populateState()
batch()
batchCopy()
batchMove()
delete()
duplicate()
generateNewTitle()
getClient()
getForm()
loadFormData()
getItem()
getHelp()
getTable()
prepareTable()
preprocessForm()
validate()
save()
getReorderConditions()
cleanCache()
Class: ModulesModelModule - X-Ref
Module model.| populateState() X-Ref |
| Method to auto-populate the model state. Note. Calling getState in this method will result in recursion. return: void |
| batch($commands, $pks, $contexts) X-Ref |
| Method to perform batch operations on a set of modules. param: array $commands An array of commands to perform. param: array $pks An array of item ids. param: array $contexts An array of item contexts. return: boolean Returns true on success, false on failure. |
| 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. |
| 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 True if successful. |
| generateNewTitle($category_id, $title, $position) X-Ref |
| Method to change the title. param: integer $category_id 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: JForm A JForm 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: JTable A database object |
| prepareTable(&$table) X-Ref |
| Prepare and sanitise the table prior to saving. param: JTable &$table The database object return: void |
| preprocessForm(JForm $form, $data, $group = 'content') X-Ref |
| Method to preprocess the form param: JForm $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. 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 add to ordering queries. |
| cleanCache($group = null, $client_id = 0) X-Ref |
| Custom clean cache method for different clients return: void |
| Generated: Tue Apr 3 11:40:28 2012 | Cross-referenced by PHPXref 0.7.1 |