[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_menus/src/Model/ -> MenuModel.php (summary)

(no description)

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

Defines 1 class

MenuModel:: (13 methods):
  canDelete()
  canEditState()
  getTable()
  populateState()
  getItem()
  getForm()
  loadFormData()
  validate()
  save()
  delete()
  getModules()
  getExtensionElementsForMenuItems()
  cleanCache()


Class: MenuModel  - X-Ref

Menu Item Model for Menus.

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 the state of a record can be 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.

getTable($type = 'MenuType', $prefix = '\JTable', $config = array()   X-Ref
Returns a Table object, always creating it

param: string  $type    The table type to instantiate
param: string  $prefix  A prefix for the table class name. Optional.
param: array   $config  Configuration array for model. Optional.
return: Table   A database object

populateState()   X-Ref
Auto-populate the model state.

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

return: void

getItem($itemId = null)   X-Ref
Method to get a menu item.

param: integer  $itemId  The id of the menu item to get.
return: mixed  Menu item data object on success, false on failure.

getForm($data = array()   X-Ref
Method to get the menu item 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

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.

delete($itemIds)   X-Ref
Method to delete groups.

param: array  $itemIds  An array of item ids.
return: boolean  Returns true on success, false on failure.

getModules()   X-Ref
Gets a list of all mod_mainmenu modules and collates them by menutype

return: array

getExtensionElementsForMenuItems(array $itemIds)   X-Ref
Returns the extension elements for the given items

param: array  $itemIds  The item ids
return: array

cleanCache($group = null, $clientId = 0)   X-Ref
Custom clean the cache

param: string   $group     Cache group name.
param: integer  $clientId  @deprecated  5.0  No Longer used.
return: void



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