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

(no description)

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

Defines 1 class

ContactModel:: (12 methods):
  batchUser()
  canDelete()
  canEditState()
  getForm()
  getItem()
  loadFormData()
  save()
  prepareTable()
  getReorderConditions()
  preprocessForm()
  featured()
  canCreateCategory()

Class: ContactModel - X-Ref

Item Model for a Contact.

batchUser($value, $pks, $contexts) X-Ref

Batch change a linked user.

param: integer  $value     The new value matching a User ID.
param: array    $pks       An array of row IDs.
param: array    $contexts  An array of item contexts.
return: boolean  True if successful, false otherwise and internal error is set.

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.

canEditState($record) X-Ref

Method to test whether a record can have its state edited.

param: object $record A record object.
return: boolean True if allowed to change the state of the record. Defaults to the permission set in the component.

getForm($data = array() X-Ref

Method to get the row 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|boolean  A Form 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: mixed 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.

save($data) X-Ref

Method to save the form data.

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

prepareTable($table) X-Ref

Prepare and sanitise the table prior to saving.

param: \Joomla\CMS\Table\Table $table The Table object
return: void

getReorderConditions($table) X-Ref

A protected method to get a set of ordering conditions.

param: \Joomla\CMS\Table\Table $table A record object.
return: array An array of conditions to add to ordering queries.

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

Preprocess the form.

param: Form    $form   Form object.
param: object  $data   Data object.
param: string  $group  Group name.
return: void

featured($pks, $value = 0) X-Ref

Method to toggle the featured setting of contacts.

param: array    $pks    The ids of the items to toggle.
param: integer  $value  The value to toggle to.
return: boolean  True on success.

canCreateCategory() X-Ref

Is the user allowed to create an on the fly category?

return: boolean

PHP Cross Reference of Joomla 4.2.2 documentation

/administrator/components/com_contact/src/Model/ -> ContactModel.php (summary)

Defines 1 class