[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_mails/src/Model/ -> TemplateModel.php (summary)

(no description)

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

Defines 1 class

TemplateModel:: (10 methods):
  canDelete()
  getForm()
  getItem()
  getMaster()
  getTable()
  loadFormData()
  validate()
  save()
  prepareTable()
  populateState()


Class: TemplateModel  - X-Ref

Item Model for a Mail template.

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.

getForm($data = array()   X-Ref
Method to get the record form.

param: array    $data      An optional array of data for the form to interrogate.
param: boolean  $loadData  True if the form is to load its own data (default case), false if not.
return: \Joomla\CMS\Form\Form|bool  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: CMSObject|boolean  Object on success, false on failure.

getMaster($pk = null)   X-Ref
Get the master data for a mail template.

param: integer  $pk  The id of the primary key.
return: CMSObject|boolean  Object on success, false on failure.

getTable($name = 'Template', $prefix = 'Administrator', $options = array()   X-Ref
Method to get a table object, load it if necessary.

param: string  $name     The table name. Optional.
param: string  $prefix   The class prefix. Optional.
param: array   $options  Configuration array for model. Optional.
return: Table  A Table object

loadFormData()   X-Ref
Method to get the data that should be injected in the form.

return: mixed  The data for the form.

validate($form, $data, $group = null)   X-Ref
Method to validate the form data.

param: Form    $form   The form to validate against.
param: array   $data   The data to validate.
param: string  $group  The name of the field group to validate.
return: array|boolean  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, False on error.

prepareTable($table)   X-Ref
Prepare and sanitise the table data prior to saving.

param: Table  $table  A reference to a Table object.
return: void

populateState()   X-Ref
Stock method to auto-populate the model state.

return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer