Docs For Class JControllerBase

Description

Implements interfaces:

JController

Joomla Platform Base Controller Class

abstract:
since: 12.1

Located in /libraries/joomla/controller/base.php (line 19)

Direct descendents

Class	Description
ConfigControllerApplicationRefreshhelp	Refresh Help Controller for global configuration
ConfigControllerApplicationRemoveroot	Remove Root Controller for global configuration
ConfigControllerApplicationSave	Save Controller for global configuration
ConfigControllerComponentSave	Save Controller for global configuration
ConfigControllerCancel	Cancel Controller
ConfigControllerCmsbase	Base Display Controller
ConfigControllerConfigSave	Save Controller for global configuration
ConfigControllerDisplay	Base Display Controller
ConfigControllerTemplatesSave	Save Controller for global configuration
InstallationControllerDatabase	Controller class to initialise the database for the Joomla Installer.
InstallationControllerDefault	Default controller class for the Joomla Installer.
InstallationControllerDetectftproot	Controller class to detect the site's FTP root for the Joomla Installer.
InstallationControllerFtp	Controller class to set the FTP data for the Joomla Installer.
InstallationControllerInstallConfig	Controller class to write the config file for the Joomla Installer.
InstallationControllerInstallDatabase	Controller class to initialise the database for the Joomla Installer.
InstallationControllerInstallDatabase_backup	Controller class to backup the old database for the Joomla Installer.
InstallationControllerInstallEmail	Controller class to e-mail the configuration info for the Joomla Installer.
InstallationControllerInstallLanguages	Controller class to install additional languages for the Joomla Installer.
InstallationControllerInstallSample	Controller class to install the sample data for the Joomla Installer.
InstallationControllerPreinstall	Controller class to refresh the preinstall view for the Joomla Installer.
InstallationControllerRemovefolder	Controller class to set the FTP data for the Joomla Installer.
InstallationControllerSetdefaultlanguage	Controller class to set the default application languages for the Joomla Installer.
InstallationControllerSetlanguage	Controller class to set the language for the Joomla Installer.
InstallationControllerSite	Controller class to set the site data for the Joomla Installer.
InstallationControllerSummary	Controller class to prepare installation for the Joomla Installer.
InstallationControllerVerifyftpsettings	Controller class to verify the FTP settings for the Joomla Installer.

Variable Summary

JApplicationBase $app

JInput $input

Method Summary

JControllerBase __construct ([JInput $input = null], [JApplicationBase $app = null])

JApplicationBase getApplication ()

JInput getInput ()

JApplicationBase loadApplication ()

JInput loadInput ()

string serialize ()

JController unserialize (string $input)

Variables

JApplicationBase $app (line 27)

The application object.

since: 12.1
access: protected

Redefined in descendants as:

ConfigControllerApplicationRefreshhelp::$app : Application object - Redeclared for proper typehinting
ConfigControllerApplicationRemoveroot::$app : Application object - Redeclared for proper typehinting
ConfigControllerApplicationSave::$app : Application object - Redeclared for proper typehinting
ConfigControllerComponentSave::$app : Application object - Redeclared for proper typehinting
ConfigControllerCancel::$app : Application object - Redeclared for proper typehinting
ConfigControllerConfigSave::$app : Application object - Redeclared for proper typehinting
ConfigControllerDisplay::$app : Application object - Redeclared for proper typehinting

JInput $input (line 35)

The input object.

since: 12.1
access: protected

Methods

Constructor __construct (line 45)

Instantiate the controller.

since: 12.1
access: public

JControllerBase __construct ([JInput $input = null], [JApplicationBase $app = null])

JInput $input: The input object.
JApplicationBase $app: The application object.

Redefined in descendants as:

InstallationControllerInstallEmail::__construct() : Constructor.
InstallationControllerInstallLanguages::__construct() : Constructor.
InstallationControllerSetdefaultlanguage::__construct() : Constructor.

getApplication (line 59)

Get the application object.

return: The application object.
since: 12.1
access: public

JApplicationBase getApplication ()

Implementation of:

JController::getApplication(): Get the application object.

getInput (line 71)

Get the input object.

return: The input object.
since: 12.1
access: public

JInput getInput ()

Implementation of:

JController::getInput(): Get the input object.

loadApplication (line 121)

Load the application object.

return: The application object.
since: 12.1
access: protected

JApplicationBase loadApplication ()

loadInput (line 133)

Load the input object.

return: The input object.
since: 12.1
access: protected

JInput loadInput ()

serialize (line 83)

Serialize the controller.

return: The serialized controller.
since: 12.1
access: public

string serialize ()

unserialize (line 98)

Unserialize the controller.

return: Supports chaining.
since: 12.1
throws: UnexpectedValueException if input is not the right class.
access: public

JController unserialize (string $input)

string $input: The serialized controller.