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

(no description)

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

Defines 1 class

GroupModel:: (12 methods):
  save()
  getTable()
  getForm()
  canDelete()
  canEditState()
  populateState()
  getReorderConditions()
  preprocessForm()
  validate()
  loadFormData()
  getItem()
  cleanCache()

Class: GroupModel - X-Ref

Group Model

save($data) X-Ref

Method to save the form data.

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

getTable($name = 'Group', $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

getForm($data = array() X-Ref

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

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 for the component.

canEditState($record) X-Ref

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

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

populateState() X-Ref

Auto-populate the model state.

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

return: void

getReorderConditions($table) X-Ref

A protected method to get a set of ordering conditions.

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

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

Method to preprocess the form.

param: Form    $form   A Form object.
param: mixed   $data   The data expected for the form.
param: string  $group  The name of the plugin group to import (defaults to "content").
return: void

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.

loadFormData() X-Ref

Method to get the data that should be injected in the form.

return: array The default data is an empty array.

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.

cleanCache($group = null, $clientId = 0) X-Ref

Clean the cache

param: string $group The cache group
param: integer $clientId @deprecated 5.0 No longer used.
return: void

PHP Cross Reference of Joomla 4.2.2 documentation

/administrator/components/com_fields/src/Model/ -> GroupModel.php (summary)

Defines 1 class