[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Application/ -> CMSApplicationInterface.php (summary)

Joomla! Content Management System

Copyright: (C) 2017 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 185 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CMSApplicationInterface:: (9 methods):
  enqueueMessage()
  getMessageQueue()
  isClient()
  isCli()
  getIdentity()
  getInput()
  getLanguage()
  getName()
  loadIdentity()


Interface: CMSApplicationInterface  - X-Ref

Interface defining a Joomla! CMS Application class

enqueueMessage($msg, $type = self::MSG_INFO)   X-Ref
Enqueue a system message.

param: string  $msg   The message to enqueue.
param: string  $type  The message type.
return: void

getMessageQueue()   X-Ref
Get the system message queue.

return: array  The system message queue.

isClient($identifier)   X-Ref
Check the client interface by name.

param: string  $identifier  String identifier for the application interface
return: boolean  True if this application is of the given type client interface.

isCli()   X-Ref
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.

return: boolean

getIdentity()   X-Ref
Get the application identity.

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

getInput()   X-Ref
Method to get the application input object.

return: Input

getLanguage()   X-Ref
Method to get the application language object.

return: Language  The language object

getName()   X-Ref
Gets the name of the current running application.

return: string  The name of the application.

loadIdentity(User $identity = null)   X-Ref
Allows the application to load a custom or default identity.

param: User  $identity  An optional identity object. If omitted, the factory user is created.
return: $this



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer