Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class CMSApplicationInterface - list of methods

Interface defining a Joomla! CMS Application class
Package: Joomla\CMS\Application
Copyright: (C) 2017 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE
Located at: Joomla/Application/CMSApplicationInterface.php
Project: Joomla

Method Summary

public void
(mixed $msg, mixed $type = self::MSG_INFO)

Enqueue a system message.
Parameters
  • string $msg The message to enqueue.
  • string $type The message type.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: enqueueMessage Source Code

public array
()

Get the system message queue.
Returns
  • array The system message queue.
Since
  • 4.0.0
Show source code of this method: getMessageQueue Source Code

public bool
(mixed $identifier)

Check the client interface by name.
Parameters
  • string $identifier String identifier for the application interface
Returns
  • bool True if this application is of the given type client interface.
Since
  • 4.0.0
Show source code of this method: isClient Source Code

public bool
()

Flag if the application instance is a CLI or web based application.
Returns
  • bool
Since
  • 4.0.0
Deprecated
  • 5.0
Show source code of this method: isCli Source Code

public \Joomla\CMS\User\User|null
()

Get the application identity.
Returns
  • \Joomla\CMS\User\User|null A User object or null if not set.
Since
  • 4.0.0
Show source code of this method: getIdentity Source Code

public \Joomla\Input\Input
()

Method to get the application input object.
Returns
  • \Joomla\Input\Input
Since
  • 4.0.0
Show source code of this method: getInput Source Code

public \Joomla\CMS\Language\Language
()

Method to get the application language object.
Returns
  • \Joomla\CMS\Language\Language The language object
Since
  • 4.0.0
Show source code of this method: getLanguage Source Code

public string
()

Gets the name of the current running application.
Returns
  • string The name of the application.
Since
  • 4.0.0
Show source code of this method: getName Source Code

public $this
(\Joomla\CMS\User\User $identity = null)

Allows the application to load a custom or default identity.
Parameters
  • \Joomla\CMS\User\User $identity An optional identity object. If omitted, the factory user is created.
Returns
  • $this
Since
  • 4.0.0
Show source code of this method: loadIdentity Source Code

Constants Summary

public string
$MSG_EMERGENCY
Constant defining an enqueued emergency message
Since
  • 4.0.0
public string
$MSG_ALERT
Constant defining an enqueued alert message
Since
  • 4.0.0
public string
$MSG_CRITICAL
Constant defining an enqueued critical message
Since
  • 4.0.0
public string
$MSG_ERROR
Constant defining an enqueued error message
Since
  • 4.0.0
public string
$MSG_WARNING
Constant defining an enqueued warning message
Since
  • 4.0.0
public string
$MSG_NOTICE
Constant defining an enqueued notice message
Since
  • 4.0.0
public string
$MSG_INFO
Constant defining an enqueued info message
Since
  • 4.0.0
public string
$MSG_DEBUG
Constant defining an enqueued debug message
Since
  • 4.0.0

Tags Summary

Since
4.0.0
ready-only \Joomla\Input\Input
$input
{@deprecated 5.0} The Joomla Input property. Deprecated in favour of getInput()