Joomla! API

Class constructor.

__construct(\Joomla\Input\Input|null input = null, \Joomla\Registry\Registry|null config = null, \Joomla\Application\Web\WebClient|null client = null, \Psr\Http\Message\ResponseInterface|null response = null) :

since	1.0.0

Arguments

input: Input|nullAn optional argument to provide dependency injection for the application's input object. If the argument is an Input object that object will become the application's input object, otherwise a default input object is created.
config: Registry|nullAn optional argument to provide dependency injection for the application's config object. If the argument is a Registry object that object will become the application's config object, otherwise a default config object is created.
client: WebClient|nullAn optional argument to provide dependency injection for the application's client object. If the argument is a Web\WebClient object that object will become the application's client object, otherwise a default client object is created.
response: ResponseInterface|nullAn optional argument to provide dependency injection for the application's response object. If the argument is a ResponseInterface object that object will become the application's response object, otherwise a default response object is created.

Response

mixed

Set/get cacheable state for the response.

allowCache( allow = null) :

If $allow is set, sets the cacheable state of the response. Always returns the current state.

since	1.0.0

Arguments

allow: boolTrue to allow browser caching.

Response

bool

Append content to the body content

appendBody( content) :

since	1.0.0

Arguments

content: stringThe content to append to the response body.

Response

$this

Method to check the current client connection status to ensure that it is alive. We are wrapping this to isolate the \connection_status() function from our code base for testing reasons.

checkConnectionAlive() :

see	connection_status()
since	1.0.0

Response

boolTrue if the connection is valid and normal.

Method to check to see if headers have already been sent.

checkHeadersSent() :

see	headers_sent()
since	1.0.0

Response

boolTrue if the headers have already been sent.

Method to clear any set response headers.

clearHeaders() :

since	1.0.0

Response

$this

Method to close the application.

close( code) :

inherited

since	1.0.0

Arguments

code: intThe exit code (optional; default is 0).

Response

void

Checks the accept encoding of the browser and compresses the data before sending it to the client if possible.

compress() :

since	1.0.0

Response

void

Method to detect the requested URI from server environment variables.

detectRequestUri() :

since	1.0.0

Response

stringThe requested URI

Dispatches an application event if the dispatcher has been set.

dispatchEvent( eventName, \Joomla\Event\EventInterface|null event = null) : \Joomla\Event\EventInterface|null

inherited

since	2.0.0

Arguments

eventName: stringThe event to dispatch.
event: EventInterface|nullThe event object.

Response

EventInterface|nullThe dispatched event or null if no dispatcher is set

Method to run the application routines.

doExecute() :

inherited abstract

Most likely you will want to instantiate a controller and execute it, or perform some sort of task directly.

since	1.0.0

Response

mixed

Execute the application.

execute() :

since	1.0.0

Response

void

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

get( key,  default = null) :

inherited

since	1.0.0

Arguments

key: stringThe name of the property.
default: mixedThe default value (optional) if none is set.

Response

mixedThe value of the configuration.

Return the body content

getBody() :

since	1.0.0

Response

stringThe response body as a string.

Get the event dispatcher.

getDispatcher() : \Joomla\Event\DispatcherInterface

inherited

since	1.2.0
throws	`UnexpectedValueException`May be thrown if the dispatcher has not been set.

Response

DispatcherInterface

Method to get the array of response headers to be sent when the response is sent to the client.

getHeaders() : mixed||string|int

since	1.0.0

Response

array<string|int, mixed>

Check if a given value can be successfully mapped to a valid http status value

getHttpStatusValue(string|int value) :

since	1.8.0

Arguments

value: string|intThe given status as int or string

Response

string

Method to get the application input object.

getInput() : \Joomla\Input\Input

since	2.0.0

Response

Input

Get the logger.

getLogger() : \Psr\Log\LoggerInterface

inherited

since	1.0.0

Response

LoggerInterface

Get the PSR-7 Response Object.

getResponse() : \Psr\Http\Message\ResponseInterface

since	2.0.0

Response

ResponseInterface

Method to send a header to the client.

header( string,  replace = true,  code = null) :

see	header()
since	1.0.0

Arguments

string: stringThe header string.
replace: boolThe optional replace parameter indicates whether the header should replace a previous similar header, or add a second header of the same type.
code: intForces the HTTP response code to the specified value. Note that this parameter only has an effect if the string is not empty.

Response

void

Custom initialisation method.

initialise() :

inherited

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

since	1.0.0

Response

void

Tests whether a string contains only 7bit ASCII bytes.

isAscii( str) :

static

You might use this to conditionally check whether a string needs handling as UTF-8 or not, potentially offering performance benefits by using the native PHP equivalent if it's just ASCII e.g.;

since	1.4.0

Arguments

str: stringThe string to test.

Response

boolTrue if the string is all ASCII

Checks if a state is a redirect state

isRedirectState( state) :

since	1.8.0

Arguments

state: intThe HTTP status code.

Response

bool

Determine if we are using a secure (SSL) connection.

isSslConnection() :

since	1.0.0

Response

boolTrue if using SSL, false if not.

Check if the value is a valid HTTP status code

isValidHttpStatus( code) :

since	1.8.1

Arguments

code: intThe potential status code

Response

bool

Method to load the system URI strings for the application.

loadSystemUris( requestUri = null) :

since	1.0.0

Arguments

requestUri: stringAn optional request URI to use instead of detecting one from the server environment variables.

Response

void

Prepend content to the body content

prependBody( content) :

since	1.0.0

Arguments

content: stringThe content to prepend to the response body.

Response

$this

Redirect to another URL.

redirect( url,  status = 303) :

If the headers have not been sent the redirect will be accomplished using a "301 Moved Permanently" or "303 See Other" code in the header pointing to the new location. If the headers have already been sent this will be accomplished using a JavaScript statement.

throws	`InvalidArgumentException`
since	1.0.0

Arguments

url: stringThe URL to redirect to. Can only be http/https URL
status: intThe HTTP status code to be provided. 303 is assumed by default.

Response

void

Method to send the application response to the client. All headers will be sent prior to the main application output data.

respond() :

since	1.0.0

Response

void

Send the response headers.

sendHeaders() :

since	1.0.0

Response

$this

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

set( key,  value = null) :

inherited

since	1.0.0

Arguments

key: stringThe name of the property.
value: mixedThe value of the property to set (optional).

Response

mixedPrevious value of the property

Set body content. If body content already defined, this will replace it.

setBody( content) :

since	1.0.0

Arguments

content: stringThe content to set as the response body.

Response

$this

Sets the configuration for the application.

setConfiguration(\Joomla\Registry\Registry config) :

inherited

since	1.0.0

Arguments

config: RegistryA registry object holding the configuration.

Response

$this

Set the dispatcher to use.

setDispatcher(\Joomla\Event\DispatcherInterface dispatcher) :

inherited

since	1.2.0

Arguments

dispatcher: DispatcherInterfaceThe dispatcher to use.

Response

$this

Method to set a response header.

setHeader( name,  value,  replace = false) :

If the replace flag is set then all headers with the given name will be replaced by the new one. The headers are stored in an internal array to be sent when the site is sent to the browser.

since	1.0.0

Arguments

name: stringThe name of the header to set.
value: stringThe value of the header to set.
replace: boolTrue to replace any headers with the same name.

Response

$this

Set the PSR-7 Response Object.

setResponse(\Psr\Http\Message\ResponseInterface response) :

since	2.0.0

Arguments

response: ResponseInterfaceThe response object

Response

void

The application input object.

since	1.0.0

Type(s)

Input

Event Dispatcher

inherited

since	1.2.0

Type(s)

DispatcherInterface|null

The application configuration object.

inherited

since	1.0.0

Type(s)

Registry

Character encoding string.

since	1.0.0

Type(s)

string

Response mime type.

since	1.0.0

Type(s)

string

HTTP protocol version.

since	1.9.0

Type(s)

string

The body modified date for response headers.

since	1.0.0

Type(s)

DateTime

The application client object.

since	1.0.0

Type(s)

WebClient

The application response object.

since	1.0.0

Type(s)

ResponseInterface

Is caching enabled?

since	2.0.0

Type(s)

bool

A map of integer HTTP response codes to the full HTTP Status for the headers.

since	1.6.0
link

Type(s)

array<string|int, mixed>

since	1.0.0
property-read Input	The application input object
package	Joomla Framework

AbstractWebApplication

Methods

__construct

Arguments

Response

allowCache

Arguments

Response

appendBody

Arguments

Response

checkConnectionAlive

Response

checkHeadersSent

Response

clearHeaders

Response

close

Arguments

Response

compress

Response

detectRequestUri

Response

dispatchEvent

Arguments

Response

doExecute

Response

execute

Response

get

Arguments

Response

getBody

Response

getDispatcher

Response

getHeaders

Response

getHttpStatusValue

Arguments

Response

getInput

Response

getLogger

Response

getResponse

Response

header

Arguments

Response

initialise

Response

isAscii

Arguments

Response

isRedirectState

Arguments

Response

isSslConnection

Response

isValidHttpStatus

Arguments

Response

loadSystemUris

Arguments

Response

prependBody

Arguments

Response

redirect

Arguments

Response

respond

Response

sendHeaders

Response

set

Arguments