| [ 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: | 523 lines (12 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ContactModelContact:: (12 methods):
batch()
batchCopy()
batchUser()
canDelete()
canEditState()
getTable()
getForm()
getItem()
loadFormData()
prepareTable()
getReorderConditions()
featured()
Class: ContactModelContact - X-Ref
Item Model for a Contact.| batch($commands, $pks, $contexts) X-Ref |
| Method to perform batch operations on an item or a set of items. 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 items to a new category or current. param: integer $value The new category. param: array $pks An array of row IDs. param: array $contexts An array of item contexts. return: mixed An array of new IDs on success, boolean false on failure. |
| batchUser($value, $pks, $contexts) X-Ref |
| Batch change a linked user. param: integer $value The new value matching a User ID. 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. |
| canDelete($record) X-Ref |
| Method to test whether a record can be deleted. param: object $record A record object. return: boolean True if allowed to delete the record. Defaults to the permission set in the component. |
| 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. |
| getTable($type = 'Contact', $prefix = 'ContactTable', $config = array() X-Ref |
| Returns a Table object, always creating it param: type $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 |
| getForm($data = array() X-Ref |
| Method to get the row 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: mixed A JForm object on success, false on failure |
| 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. |
| loadFormData() X-Ref |
| Method to get the data that should be injected in the form. return: mixed The data for the form. |
| prepareTable(&$table) X-Ref |
| Prepare and sanitise the table prior to saving. param: JTable $table return: void |
| getReorderConditions($table) X-Ref |
| A protected method to get a set of ordering conditions. param: JTable $table A record object. return: array An array of conditions to add to add to ordering queries. |
| featured($pks, $value = 0) X-Ref |
| Method to toggle the featured setting of contacts. param: array $pks The ids of the items to toggle. param: int $value The value to toggle to. return: boolean True on success. |
| Generated: Tue Apr 3 11:40:28 2012 | Cross-referenced by PHPXref 0.7.1 |