[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

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

(no description)

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

Defines 1 class

ConsentsModel:: (6 methods):
  __construct()
  getListQuery()
  getStoreId()
  populateState()
  invalidate()
  invalidateAll()


Class: ConsentsModel  - X-Ref

Consents management model class.

__construct($config = [])   X-Ref
Constructor.

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

getListQuery()   X-Ref
Method to get a DatabaseQuery object for retrieving the data set from a database.

return: DatabaseQuery

getStoreId($id = '')   X-Ref
Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and
different modules that might need different sets of data or different
ordering requirements.

param: string  $id  A prefix for the store id.
return: string

populateState($ordering = 'a.id', $direction = 'desc')   X-Ref
Method to auto-populate the model state.

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

param: string  $ordering   An optional ordering field.
param: string  $direction  An optional direction (asc|desc).
return: void

invalidate($pks)   X-Ref
Method to invalidate specific consents.

param: array  $pks  The ids of the consents to invalidate.
return: boolean  True on success.

invalidateAll($subject)   X-Ref
Method to invalidate a group of specific consents.

param: array  $subject  The subject of the consents to invalidate.
return: boolean  True on success.



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