Download the PHP package joomla/application without Composer

The Application Package

Initialising Applications

AbstractApplication implements an initialise method that is called at the end of the constructor. This method is intended to be overridden in derived classes as needed by the developer.

If you are overriding the __construct method in your application class, remember to call the parent constructor last.

Logging within Applications

AbstractApplication implements the Psr\Log\LoggerAwareInterface so is ready for intergrating with an logging package that supports that standard.

The following example shows how you could set up logging in your application using initialise method from AbstractApplication.

The logger variable is private so you must use the getLogger method to access it. If a logger has not been initialised, the getLogger method will throw an exception.

To check if the logger has been set, use the hasLogger method. This will return true if the logger has been set.

Consider the following example:

Mocking the Application Package

For more complicated mocking where you need to similate real behaviour, you can use the Application\Tests\Mocker class to create robust mock objects.

There are three mocking methods available:

1. createMockBase will create a mock for AbstractApplication.
2. createMockCli will create a mock for AbstractCliApplication.
3. createMockWeb will create a mock for AbstractWebApplication.

The createMockWeb method will return a mock with the following methods mocked to roughly simulate real behaviour albeit with reduced functionality:

• appendBody($content)
• get($name [, $default])
• getBody([$asArray])
• getHeaders()
• prependBody($content)
• set($name, $value)
• setBody($content)
• setHeader($name, $value [, $replace])

You can provide customised implementations these methods by creating the following methods in your test class respectively:

• mockWebAppendBody
• mockWebGet
• mockWebGetBody
• mockWebGetHeaders
• mockWebSet
• mockWebSetBody
• mockWebSetHeader

Web Application

Configuration options

The AbstractWebApplication sets following application configuration:

• Execution datetime and timestamp

  • execution.datetime - Execution datetime
  • execution.timestamp - Execution timestamp
• URIs
  • uri.request - The request URI
  • uri.base.full - full URI
  • uri.base.host - URI host
  • uri.base.path - URI path
  • uri.route - Extended (non-base) part of the request URI
  • uri.media.full - full media URI
  • uri.media.path - relative media URI

and uses following ones during object construction:

• gzip to compress the output
• site_uri to see if an explicit base URI has been set (helpful when chaining request uri using mod_rewrite)
• media_uri to get an explicitly set media URI (relative values are appended to uri.base ). If it's not set explicitly, it defaults to a media/ path of uri.base.

The setHeader method

Accepted parameters

• $name - The name of the header to set.
• $value - The value of the header to set.
• $replace - True to replace any headers with the same name.

Example: Using WebApplication::setHeader to set a status header.

Will result in response containing header

Command Line Applications

The Joomla Framework provides an application class for making command line applications.

An example command line application skeleton:

Colors for CLI Applications

It is possible to use colors on an ANSI enabled terminal.

You can also create your own styles.

Available foreground and background colors are: black, red, green, yellow, blue, magenta, cyan and white.

And available options are: bold, underscore, blink and reverse.

You can also set these colors and options inside the tagname:

Installation via Composer

Add "joomla/application": "~3.0" to the require block in your composer.json and then run composer install.

Alternatively, you can simply run the following from the command line:

If you want to include the test sources, use