[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_modules/src/Controller/ -> ModuleController.php (summary)

(no description)

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

Defines 1 class

ModuleController:: (10 methods):
  add()
  cancel()
  allowSave()
  allowEdit()
  batch()
  postSaveHook()
  save()
  orderPosition()
  getRedirectToItemAppend()
  getRedirectToListAppend()


Class: ModuleController  - X-Ref

Module controller class.

add()   X-Ref
Override parent add method.

return: \Exception|void  True if the record can be added, a \Exception object if not.

cancel($key = null)   X-Ref
Override parent cancel method to reset the add module state.

param: string  $key  The name of the primary key of the URL variable.
return: boolean  True if access level checks pass, false otherwise.

allowSave($data, $key = 'id')   X-Ref
Override parent allowSave method.

param: array   $data  An array of input data.
param: string  $key   The name of the key for the primary key.
return: boolean

allowEdit($data = array()   X-Ref
Method override to check if you can edit an existing record.

param: array   $data  An array of input data.
param: string  $key   The name of the key for the primary key.
return: boolean

batch($model = null)   X-Ref
Method to run batch operations.

param: string  $model  The model
return: boolean  True on success.

postSaveHook(BaseDatabaseModel $model, $validData = array()   X-Ref
Function that allows child controller access to model data after the data has been saved.

param: BaseDatabaseModel  $model      The data model object.
param: array              $validData  The validated data.
return: void

save($key = null, $urlVar = null)   X-Ref
Method to save a record.

param: string  $key     The name of the primary key of the URL variable.
param: string  $urlVar  The name of the URL variable if different from the primary key
return: boolean  True if successful, false otherwise.

orderPosition()   X-Ref
Method to get the other modules in the same position

return: string  The data for the Ajax request.

getRedirectToItemAppend($recordId = null, $urlVar = 'id')   X-Ref
Gets the URL arguments to append to an item redirect.

param: integer  $recordId  The primary key id for the item.
param: string   $urlVar    The name of the URL variable for the id.
return: string  The arguments to append to the redirect URL.

getRedirectToListAppend()   X-Ref
Gets the URL arguments to append to a list redirect.

return: string  The arguments to append to the redirect URL.



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