Module controller class.

• since: 1.6

Located in /administrator/components/com_modules/controllers/module.php (line 19)

JObject
   |
   --JControllerLegacy
      |
      --JControllerForm
         |
         --ModulesControllerModule

Inherited Variables

Inherited from JControllerForm

JControllerForm::$context
JControllerForm::$option
JControllerForm::$text_prefix
JControllerForm::$view_item
JControllerForm::$view_list

Inherited from JControllerLegacy

JControllerLegacy::$basePath
JControllerLegacy::$default_view
JControllerLegacy::$doTask
JControllerLegacy::$input
JControllerLegacy::$instance
JControllerLegacy::$message
JControllerLegacy::$messageType
JControllerLegacy::$methods
JControllerLegacy::$model_prefix
JControllerLegacy::$name
JControllerLegacy::$paths
JControllerLegacy::$redirect
JControllerLegacy::$task
JControllerLegacy::$taskMap

Inherited from JObject

JObject::$_errors

add (line 28)

Override parent add method.

• return: True if the record can be added, a JError object if not.
• since: 1.6
• access: public

mixed add ()

---

Redefinition of:

JControllerForm::add()

Method to add a new record.

allowEdit (line 112)

Method override to check if you can edit an existing record.

• since: 3.2
• access: protected

boolean allowEdit ([array $data = array()], [string $key = 'id'])

• array $data: An array of input data.
• string $key: The name of the key for the primary key.

---

Redefinition of:

JControllerForm::allowEdit()

Method to check if you can add a new record.

allowSave (line 86)

Override parent allowSave method.

• since: 1.6
• access: protected

boolean allowSave (array $data, [string $key = 'id'])

• array $data: An array of input data.
• string $key: The name of the key for the primary key.

---

Redefinition of:

JControllerForm::allowSave()

Method to check if you can save a new or existing record.

batch (line 138)

Method to run batch operations.

• return: True on success.
• since: 1.7
• access: public

boolean batch ([string $model = null])

• string $model: The model

---

Redefinition of:

JControllerForm::batch()

Method to run batch operations.

cancel (line 64)

Override parent cancel method to reset the add module state.

• return: True if access level checks pass, false otherwise.
• since: 1.6
• access: public

boolean cancel ([string $key = null])

• string $key: The name of the primary key of the URL variable.

---

Redefinition of:

JControllerForm::cancel()

Method to cancel an edit.

postSaveHook (line 161)

Function that allows child controller access to model data after the data has been saved.

• since: 1.6
• access: protected

void postSaveHook (JModelLegacy $model, [array $validData = array()])

• JModelLegacy $model: The data model object.
• array $validData: The validated data.

---

Redefinition of:

JControllerForm::postSaveHook()

Function that allows child controller access to model data after the data has been saved.

Inherited Methods

Inherited From JControllerForm

JControllerForm::__construct()
JControllerForm::add()
JControllerForm::allowAdd()
JControllerForm::allowEdit()
JControllerForm::allowSave()
JControllerForm::batch()
JControllerForm::cancel()
JControllerForm::edit()
JControllerForm::getModel()
JControllerForm::getRedirectToItemAppend()
JControllerForm::getRedirectToListAppend()
JControllerForm::loadhistory()
JControllerForm::postSaveHook()
JControllerForm::save()

Inherited From JControllerLegacy

JControllerLegacy::__construct()
JControllerLegacy::addModelPath()
JControllerLegacy::addPath()
JControllerLegacy::addViewPath()
JControllerLegacy::authorise()
JControllerLegacy::checkEditId()
JControllerLegacy::createFileName()
JControllerLegacy::createModel()
JControllerLegacy::createView()
JControllerLegacy::display()
JControllerLegacy::execute()
JControllerLegacy::getInstance()
JControllerLegacy::getModel()
JControllerLegacy::getName()
JControllerLegacy::getTask()
JControllerLegacy::getTasks()
JControllerLegacy::getView()
JControllerLegacy::holdEditId()
JControllerLegacy::redirect()
JControllerLegacy::registerDefaultTask()
JControllerLegacy::registerTask()
JControllerLegacy::releaseEditId()
JControllerLegacy::setMessage()
JControllerLegacy::setPath()
JControllerLegacy::setRedirect()
JControllerLegacy::unregisterTask()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()