Docs For Class UsersControllerUser

Description

User controller class.

since: 1.6

Located in /administrator/components/com_users/controllers/user.php (line 19)

JObject
   |
   --JControllerLegacy
      |
      --JControllerForm
         |
         --UsersControllerUser

Variable Summary

string $text_prefix

Method Summary

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

boolean batch ([object $model = null])

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

Variables

string $text_prefix = 'COM_USERS_USER' (line 25)

var: The prefix to use with controller messages.
since: 1.6
access: protected

Redefinition of:

JControllerForm::$text_prefix: The prefix to use with controller messages.

Inherited Variables

Inherited from JControllerForm

JControllerForm::$context
JControllerForm::$option
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

Methods

allowEdit (line 39)

Overrides JControllerForm::allowEdit

Checks that non-Super Admins are not editing Super Admins.

return: True if allowed, false otherwise.
since: 1.6
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.

batch (line 63)

Method to run batch operations.

return: True on success, false on failure
since: 2.5
access: public

boolean batch ([object $model = null])

object $model: The model.

Redefinition of:

JControllerForm::batch(): Method to run batch operations.

postSaveHook (line 86)

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

since: 3.1
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()