Référence de l'interface CMSApplicationInterface

Graphe d'héritage de CMSApplicationInterface:

Fonctions membres publiques
	enqueueMessage ($msg, $type=self::MSG_INFO)
	getMessageQueue ()
	isClient ($identifier)
	isCli ()
	getIdentity ()
	getInput ()
	getLanguage ()
	getName ()
	loadIdentity (User $identity=null)
Fonctions membres publiques hérités de ExtensionManagerInterface
	bootComponent ($component)
	bootModule ($module, $applicationName)
	bootPlugin ($plugin, $type)
Fonctions membres publiques hérités de ConfigurationAwareApplicationInterface
	get ($key, $default=null)
	set ($key, $value=null)
	setConfiguration (Registry $config)
Fonctions membres publiques hérités de ApplicationInterface
	close ($code=0)
	execute ()
Fonctions membres publiques hérités de EventAwareInterface
	getDispatcher ()
	triggerEvent ($eventName, $args=[])
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Champs de données
const	MSG_EMERGENCY = 'emergency'
const	MSG_ALERT = 'alert'
const	MSG_CRITICAL = 'critical'
const	MSG_ERROR = 'error'
const	MSG_WARNING = 'warning'
const	MSG_NOTICE = 'notice'
const	MSG_INFO = 'info'
const	MSG_DEBUG = 'debug'

Documentation des fonctions membres

enqueueMessage()

enqueueMessage	(		$msg,
			$type = self::MSG_INFO
	)

Enqueue a system message.

Paramètres

string	$msg	The message to enqueue.
string	$type	The message type.

Renvoie

void

Depuis

4.0.0

Implémenté dans CliApplication, ConsoleApplication, et CMSApplication.

getIdentity()

getIdentity

(

)

Get the application identity.

Renvoie

User|null A User object or null if not set.

Depuis

4.0.0

getInput()

getInput

(

)

Method to get the application input object.

Renvoie

Input

Depuis

4.0.0

Implémenté dans ConsoleApplication, et CliApplication.

getLanguage()

getLanguage

(

)

Method to get the application language object.

Renvoie

Language The language object

Depuis

4.0.0

Implémenté dans ConsoleApplication, et CliApplication.

getMessageQueue()

getMessageQueue

(

)

Get the system message queue.

Renvoie

array The system message queue.

Depuis

4.0.0

Implémenté dans ConsoleApplication, et CliApplication.

getName()

getName

(

)

Gets the name of the current running application.

Renvoie

string The name of the application.

Depuis

4.0.0

Implémenté dans CMSApplication, et ConsoleApplication.

Référencé par ComponentDispatcherFactory\createDispatcher(), et RouterFactory\createRouter().

isCli()

isCli

(

)

Flag if the application instance is a CLI or web based application.

Helper function, you should use the native PHP functions to detect if it is a CLI application.

Renvoie

boolean

Depuis

4.0.0

Obsolète:

5.0 Will be removed without replacements

Implémenté dans CMSApplication, CliApplication, et ConsoleApplication.

isClient()

isClient

(

$identifier

)

Check the client interface by name.

Paramètres

string

$identifier

String identifier for the application interface

Renvoie

boolean True if this application is of the given type client interface.

Depuis

4.0.0

Implémenté dans CMSApplication, ConsoleApplication, et CliApplication.

Référencé par ModuleDispatcherFactory\createDispatcher(), et ComponentDispatcherFactory\createDispatcher().

loadIdentity()

loadIdentity

(

User

$identity = null

)

Allows the application to load a custom or default identity.

Paramètres

User

$identity

An optional identity object. If omitted, the factory user is created.

Renvoie

$this

Depuis

4.0.0

Documentation des champs

MSG_ALERT

const MSG_ALERT = 'alert'

MSG_CRITICAL

const MSG_CRITICAL = 'critical'

MSG_DEBUG

const MSG_DEBUG = 'debug'

MSG_EMERGENCY

const MSG_EMERGENCY = 'emergency'

MSG_ERROR

const MSG_ERROR = 'error'

MSG_INFO

const MSG_INFO = 'info'

MSG_NOTICE

const MSG_NOTICE = 'notice'

MSG_WARNING

const MSG_WARNING = 'warning'

Référencé par HtmlView\display().

---

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

• CMSApplicationInterface.php