Référence de la classe AbstractApplication

Graphe d'héritage de AbstractApplication:

Fonctions membres publiques
	__construct (Input $input=null, Registry $config=null)
	close ($code=0)
	execute ()
	get ($key, $default=null)
	getLogger ()
	set ($key, $value=null)
	setConfiguration (Registry $config)
	setLogger (LoggerInterface $logger)

Champs de données
	$input

Fonctions membres protégées
	doExecute ()
	initialise ()

Attributs protégés
	$config

Attributs privés
	$logger

Description détaillée

Joomla Framework Base Application Class

Depuis

1.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	Input	$input = null,
		Registry	$config = null
	)

Class constructor.

Paramètres

Input	$input	An optional argument to provide dependency injection for the application's input object. If the argument is an Input object that object will become the application's input object, otherwise a default input object is created.
Registry	$config	An optional argument to provide dependency injection for the application's config object. If the argument is a Registry object that object will become the application's config object, otherwise a default config object is created.

Depuis

1.0

Références AbstractApplication\$config, AbstractApplication\$input, et AbstractApplication\initialise().

Documentation des fonctions membres

close()

close

(

$code = 0

)

Method to close the application.

Paramètres

integer

$code

The exit code (optional; default is 0).

Renvoie

void

Depuis

1.0

Référencé par AbstractCliApplication\__construct(), AbstractWebApplication\checkToken(), AbstractDaemonApplication\detach(), AbstractWebApplication\redirect(), AbstractDaemonApplication\shutdown(), et AbstractDaemonApplication\signal().

doExecute()

doExecute ( )

abstractprotected

Method to run the application routines. Most likely you will want to instantiate a controller and execute it, or perform some sort of task directly.

Renvoie

mixed

Depuis

1.0

Référencé par AbstractApplication\execute(), AbstractWebApplication\execute(), et AbstractDaemonApplication\execute().

execute()

execute

(

)

Execute the application.

Renvoie

void

Depuis

1.0

Références AbstractApplication\doExecute().

get()

get	(		$key,
			$default = null
	)

Returns a property of the object or the default value if the property is not set.

Paramètres

string	$key	The name of the property.
mixed	$default	The default value (optional) if none is set.

Renvoie

mixed The value of the configuration.

Depuis

1.0

Références $default, et $key.

Référencé par MetadataManager\createRecordIfNonExisting().

getLogger()

getLogger

(

)

Get the logger.

Renvoie

LoggerInterface

Depuis

1.0

Références AbstractApplication\$logger.

Référencé par AbstractDaemonApplication\__construct(), AbstractDaemonApplication\changeIdentity(), AbstractDaemonApplication\daemonize(), AbstractDaemonApplication\detach(), AbstractDaemonApplication\execute(), AbstractDaemonApplication\fork(), AbstractDaemonApplication\isActive(), AbstractDaemonApplication\restart(), AbstractDaemonApplication\setupSignalHandlers(), AbstractDaemonApplication\shutdown(), AbstractDaemonApplication\signal(), AbstractDaemonApplication\stop(), et AbstractDaemonApplication\writeProcessIdFile().

initialise()

initialise ( )

protected

Custom initialisation method.

Called at the end of the AbstractApplication::__construct method. This is for developers to inject initialisation code for their application classes.

Renvoie

void

Depuis

1.0

Référencé par AbstractApplication\__construct().

set()

set	(		$key,
			$value = null
	)

Modifies a property of the object, creating it if it does not already exist.

Paramètres

string	$key	The name of the property.
mixed	$value	The value of the property to set (optional).

Renvoie

mixed Previous value of the property

Depuis

1.0

Références $key, et $value.

setConfiguration()

setConfiguration

(

Registry

$config

)

Sets the configuration for the application.

Paramètres

Registry

$config

A registry object holding the configuration.

Renvoie

AbstractApplication Returns itself to support chaining.

Depuis

1.0

Références AbstractApplication\$config.

setLogger()

setLogger

(

LoggerInterface

$logger

)

Set the logger.

Paramètres

LoggerInterface

$logger

The logger.

Renvoie

AbstractApplication Returns itself to support chaining.

Depuis

1.0

Implémente LoggerAwareInterface.

Références AbstractApplication\$logger.

Documentation des champs

$config

$config

protected

Référencé par AbstractCliApplication\__construct(), AbstractApplication\__construct(), AbstractDaemonApplication\__construct(), AbstractWebApplication\__construct(), et AbstractApplication\setConfiguration().

$input

$input

Référencé par AbstractCliApplication\__construct(), AbstractApplication\__construct(), AbstractDaemonApplication\__construct(), et AbstractWebApplication\__construct().

$logger

$logger

private

Référencé par AbstractApplication\getLogger(), et AbstractApplication\setLogger().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• AbstractApplication.php