PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of AbstractApplication.php

Part of the Joomla Framework Application Package

Copyright:	Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
License:	GNU General Public License version 2 or later; see LICENSE
File Size:	213 lines (5 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 9 functions

  __construct()
  close()
  dispatchEvent()
  execute()
  get()
  getLogger()
  initialise()
  set()
  setConfiguration()

Functions

Functions that are not part of a class:

__construct(Registry $config = null) X-Ref

Class constructor.

param: Registry $config An optional argument to provide dependency injection for the application's config object. If the argument

close($code = 0) X-Ref

Method to close the application.

param: integer $code The exit code (optional; default is 0).
return: void

dispatchEvent(string $eventName, ?EventInterface $event = null) X-Ref

Dispatches an application event if the dispatcher has been set.

param: string               $eventName  The event to dispatch.
param: EventInterface|null  $event      The event object.
return: EventInterface|null  The dispatched event or null if no dispatcher is set

execute() X-Ref

Execute the application.

return: void

get($key, $default = null) X-Ref

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

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

getLogger() X-Ref

Get the logger.

return: LoggerInterface

initialise() X-Ref

Custom initialisation method.

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

return: void

set($key, $value = null) X-Ref

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

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

setConfiguration(Registry $config) X-Ref

Sets the configuration for the application.

param: Registry $config A registry object holding the configuration.
return: $this

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/vendor/joomla/application/src/ -> AbstractApplication.php (summary)

Defines 9 functions