[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_plugins/src/Model/ -> PluginModel.php (summary)

(no description)

Copyright: (C) 2009 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 375 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PluginModel:: (11 methods):
  __construct()
  getForm()
  loadFormData()
  getItem()
  getTable()
  populateState()
  preprocessForm()
  getReorderConditions()
  save()
  getHelp()
  cleanCache()


Class: PluginModel  - X-Ref

Plugin model.

__construct($config = array()   X-Ref
Constructor.

param: array                $config   An optional associative array of configuration settings.
param: MVCFactoryInterface  $factory  The factory.

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.

getTable($type = 'Extension', $prefix = 'JTable', $config = array()   X-Ref
Returns a reference to the 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

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

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

return: void

preprocessForm(Form $form, $data, $group = 'content')   X-Ref
Preprocess the form.

param: Form    $form   A form object.
param: mixed   $data   The data expected for the form.
param: string  $group  Cache group name.
return: mixed  True if successful.

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.

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

param: array  $data  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, $clientId = 0)   X-Ref
Custom clean cache method, plugins are cached in 2 places for different clients.

param: string   $group     Cache group name.
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