[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/administrator/components/com_plugins/models/ -> plugin.php (summary)

(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: 327 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PluginsModelPlugin:: (10 methods):
  getForm()
  loadFormData()
  getItem()
  getTable()
  populateState()
  preprocessForm()
  getReorderConditions()
  save()
  getHelp()
  cleanCache()


Class: PluginsModelPlugin  - X-Ref

Plugin model.

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    The id of the primary key.
return: mixed    Object on success, false on failure.

getTable($type = 'Extension', $prefix = 'JTable', $config = array()   X-Ref
Returns a reference to the a Table object, always creating it.

param: type    The table type to instantiate
param: string    A prefix for the table class name. Optional.
param: array    Configuration array for model. Optional.
return: JTable    A database object

populateState()   X-Ref
Auto-populate the model state.

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

return: void

preprocessForm(JForm $form, $data, $group = 'content')   X-Ref

param: object    A form object.
param: mixed    The data expected for the form.
return: mixed    True if successful.

getReorderConditions($table)   X-Ref
A protected method to get a set of ordering conditions.

param: object    A record object.
return: array    An array of conditions to add to add to ordering queries.

save($data)   X-Ref
Override method to save the form data.

param: array    The form data.
return: boolean    True on success.

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.

cleanCache($group = null, $client_id = 0)   X-Ref
Custom clean cache method, plugins are cached in 2 places for different clients




Generated: Tue Apr 3 11:40:28 2012 Cross-referenced by PHPXref 0.7.1