PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of RequestModel.php

(no description)

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

Defines 1 class

RequestModel:: (11 methods):
  cleanCache()
  getForm()
  getTable()
  loadFormData()
  logRequestCompleted()
  logRequestCreated()
  logRequestInvalidated()
  notifyUserAdminCreatedRequest()
  save()
  validate()
  getActionlogModel()

Class: RequestModel - X-Ref

Request item model class.

cleanCache($group = 'com_privacy') X-Ref

Clean the cache

param: string $group The cache group
return: void

getForm($data = [], $loadData = true) X-Ref

Method for getting the form from the model.

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|boolean  A Form object on success, false on failure

getTable($name = 'Request', $prefix = 'Administrator', $options = []) 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: array The default data is an empty array.

logRequestCompleted($id) X-Ref

Log the completion of a request to the action log system.

param: integer $id The ID of the request to process.
return: boolean

logRequestCreated($id) X-Ref

Log the creation of a request to the action log system.

param: integer $id The ID of the request to process.
return: boolean

logRequestInvalidated($id) X-Ref

Log the invalidation of a request to the action log system.

param: integer $id The ID of the request to process.
return: boolean

notifyUserAdminCreatedRequest($id) X-Ref

Notifies the user that an information request has been created by a site administrator.

Because confirmation tokens are stored in the database as a hashed value, this method will generate a new confirmation token
for the request.

param: integer $id The ID of the request to process.
return: boolean

save($data) X-Ref

Method to save the form data.

param: array $data The form data.
return: boolean True on success, False on error.

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.

getActionlogModel() X-Ref

Method to fetch an instance of the action log model.

return: ActionlogModel

PHP Cross Reference of Joomla 4.2.2 documentation

/administrator/components/com_privacy/src/Model/ -> RequestModel.php (summary)

Defines 1 class