JController

From Joomla! Documentation
Revision as of 20:04, 3 November 2008 by Stephencollier (Talk | contribs)

Jump to: navigation, search

Overview

The base class used to control Joomla! components.


Properties

_acoSection - protected string
ACO Section for the controller.

_acoSectionValue - protected string
Default ACO Section value for the controller.

_basePath - protected string
The base path of the controller.

_doTask - protected string
The mapped task that was performed.

_message - protected string
Redirect message.

_messageType - protected string
Redirect message type.

_methods - protected array
Array of class methods.

_name - protected array
The name of the controller.

_path - protected array
The set of search directories for resources (views).

_redirect - protected string
URL for redirection.

_task - protected string
Current or most recent task to be performed.

_taskMap - protected array
Array of class methods to call for a given task.

Methods

__construct( $config = array() ) - protected
Description: Constructor for the JController class.
Parameters:

  • $config - array An optional associative array of configuration settings. Recognized key values include 'name', 'default_task', 'model_path', and 'view_path' (this list is not meant to be comprehensive).

Return value: none.

execute( $task ) - public
Description: Execute a task by triggering a method in the derived class.
Parameters:

* $task - string The task to perform. If no matching task is found, the '__default' task is executed, if defined.

Return value: mixed|false The value returned by the called method, false in error case.

Personal tools
Namespaces

Variants
Actions
Navigation
Joomla! Sites
Toolbox