\UsersController

Synopsis

class UsersController extends JControllerLegacy {

}

$_errors — array
An array of error messages or Exception objects.
$basePath — string
The base path of the controller
$default_view — string
The default view for the display method.
$doTask — string
The mapped task that was performed.
$input — JInput
Hold a JInput object for easier access to the input variables.
$instance — JControllerLegacy
Instance container.
$message — string
Redirect message.
$messageType — string
Redirect message type.
$methods — array
Array of class methods
$model_prefix — string
The prefix of the models
$name — array
The name of the controller
$paths — array
The set of search directories for resources (views).
$redirect — string
URL for redirection.
$task — string
Current or most recently performed task.
$taskMap — array
Array of class methods to call for a given task.

addPath() — Adds to the search path for templates and resources.
checkEditId() — Method to check whether an ID is in the edit list.
createFileName() — Create the filename for a resource.
createModel() — Method to load and return a model object.
createView() — Method to load and return a view object. This method first looks in the current template directory for a match and, failing that, uses a default set path to load the view class file.
holdEditId() — Method to add a record ID to the edit list.
releaseEditId() — Method to check whether an ID is in the edit list.
setPath() — Sets an entire array of search paths for resources.

addModelPath() — Adds to the stack of model paths in LIFO order.
addViewPath() — Add one or more view paths to the controller's stack, in LIFO order.
authorise() — Authorisation check
display() — Typical view method for MVC based architecture
execute() — Execute a task by triggering a method in the derived class.
getInstance() — Method to get a singleton controller instance.
getModel() — Method to get a model object, loading it if required.
getName() — Method to get the controller name
getTask() — Get the last task that is being performed or was most recently performed.
getTasks() — Gets the available tasks in the controller.
getView() — Method to get a reference to the current view and load it if necessary.
redirect() — Redirects the browser or returns false if no redirect is set.
registerDefaultTask() — Register the default task to perform if a mapping is not found.
registerTask() — Register (map) a task to a method in the class.
setMessage() — Sets the internal message that is passed with a redirect
setRedirect() — Set a URL for browser redirection.
unregisterTask() — Unregister (unmap) a task in the class.

__toString() — Magic method to convert the object to a string gracefully.
def() — Sets a default value if not alreay assigned
get() — Returns a property of the object or the default value if the property is not set.
getError() — Get the most recent error message.
getErrors() — Return all errors, if any.
getProperties() — Returns an associative array of object properties.
set() — Modifies a property of the object, creating it if it does not already exist.
setError() — Add an error message.
setProperties() — Set the object properties based on a named array/hash.