Joomla! API

Class constructor.

__construct(\Joomla\Input\Input input = null, \Joomla\Registry\Registry config = null) : mixed

inherited

since	1.0

Arguments

input: \Joomla\Input\InputAn 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: \Joomla\Registry\RegistryAn 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.

Response

mixed

Set/get cachable state for the response. If $allow is set, sets the cachable state of the response. Always returns the current state.

allowCache(bool allow = null) : bool

since	1.0

Arguments

allow: boolTrue to allow browser caching.

Response

bool

Append content to the body content

appendBody(string content) : \Joomla\Application\AbstractWebApplication

since	1.0

Arguments

content: stringThe content to append to the response body.

Response

\Joomla\Application\AbstractWebApplicationInstance of $this to allow chaining.

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() : bool

see	connection_status()
since	1.0

Response

boolTrue if the connection is valid and normal.

Method to check to see if headers have already been sent. We are wrapping this to isolate the headers_sent() function from our code base for testing reasons.

checkHeadersSent() : bool

see	headers_sent()
since	1.0

Response

boolTrue if the headers have already been sent.

Checks for a form token in the request.

checkToken(string method = 'post') : bool

Use in conjunction with getFormToken.

since	1.0

Arguments

method: stringThe request method in which to look for the token key.

Response

boolTrue if found and valid, false otherwise.

Method to clear any set response headers.

clearHeaders() : \Joomla\Application\AbstractWebApplication

since	1.0

Response

\Joomla\Application\AbstractWebApplicationInstance of $this to allow chaining.

Method to close the application.

close(int code) : void

inherited

since	1.0

Arguments

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

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

compress() : void

since	1.0

Method to detect the requested URI from server environment variables.

detectRequestUri() : string

since	1.0

Response

stringThe requested URI

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

doExecute() : mixed

inherited abstract

since	1.0

Response

mixed

Execute the application.

execute() : void

inherited

since	1.0

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

get(string key, mixed default = null) : mixed

inherited

since	1.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(bool asArray = false) : string|string[]

since	1.0

Arguments

asArray: boolTrue to return the body as an array of strings.

Response

string|string[]The response body either as an array or concatenated string.

Method to determine a hash for anti-spoofing variable names

getFormToken(bool forceNew = false) : string

since	1.0

Arguments

forceNew: boolIf true, force a new token to be created

Response

stringHashed var name

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

getHeaders() : array

since	1.0

Response

array

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

getHttpStatusValue(string|int value) : string

since	1.8.0

Arguments

value: string|intThe given status as int or string

Response

string

Get the logger.

getLogger() : \Psr\Log\LoggerInterface

inherited

since	1.0

Response

\Psr\Log\LoggerInterface

Method to get the application session object.

getSession() : \Joomla\Session\Session

since	1.0

Response

\Joomla\Session\SessionThe session object

Method to send a header to the client. We are wrapping this to isolate the header() function from our code base for testing reasons.

header(string string, bool replace = true, int code = null) : void

see	header()
since	1.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.

Custom initialisation method.

initialise() : void

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

Tests whether a string contains only 7bit ASCII bytes.

isAscii(string str) : bool

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(int state) : bool

since	1.8.0

Arguments

state: intThe HTTP status code.

Response

bool

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

isSslConnection() : bool

since	1.0

Response

boolTrue if using SSL, false if not.

Check if the value is a valid HTTP status code

isValidHttpStatus(int code) : bool

since	1.8.1

Arguments

code: intThe potential status code

Response

bool

Method to load the system URI strings for the application.

loadSystemUris(string requestUri = null) : void

since	1.0

Arguments

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

Prepend content to the body content

prependBody(string content) : \Joomla\Application\AbstractWebApplication

since	1.0

Arguments

content: stringThe content to prepend to the response body.

Response

\Joomla\Application\AbstractWebApplicationInstance of $this to allow chaining.

Redirect to another URL.

redirect(string url, int status = 303) : void

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.

since	1.0
throws	`\InvalidArgumentException`

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.

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

respond() : void

since	1.0

Send the response headers.

sendHeaders() : \Joomla\Application\AbstractWebApplication

since	1.0

Response

\Joomla\Application\AbstractWebApplicationInstance of $this to allow chaining.

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

set(string key, mixed value = null) : mixed

inherited

since	1.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(string content) : \Joomla\Application\AbstractWebApplication

since	1.0

Arguments

content: stringThe content to set as the response body.

Response

\Joomla\Application\AbstractWebApplicationInstance of $this to allow chaining.

Sets the configuration for the application.

setConfiguration(\Joomla\Registry\Registry config) : \Joomla\Application\AbstractApplication

inherited

since	1.0

Arguments

config: \Joomla\Registry\RegistryA registry object holding the configuration.

Response

\Joomla\Application\AbstractApplicationReturns itself to support chaining.

Method to set a response header. 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.

setHeader(string name, string value, bool replace = false) : \Joomla\Application\AbstractWebApplication

since	1.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

\Joomla\Application\AbstractWebApplicationInstance of $this to allow chaining.

Set the logger.

setLogger(\Psr\Log\LoggerInterface logger) : \Joomla\Application\AbstractApplication

inherited

since	1.0

Arguments

logger: \Psr\Log\LoggerInterfaceThe logger.

Response

\Joomla\Application\AbstractApplicationReturns itself to support chaining.

Sets the session for the application to use, if required.

setSession(\Joomla\Session\Session session) : \Joomla\Application\AbstractWebApplication

since	1.0

Arguments

session: \Joomla\Session\SessionA session object.

Response

\Joomla\Application\AbstractWebApplicationReturns itself to support chaining.

Character encoding string.

since	1.0

Type(s)

string

Response mime type.

since	1.0

Type(s)

string

HTTP protocol version.

since	1.9.0

Type(s)

string

The body modified date for response headers.

since	1.0

Type(s)

\DateTime

The application client object.

since	1.0

Type(s)

\Joomla\Application\Web\WebClient

The application response object.

since	1.0

Type(s)

object

The application session object.

since	1.0

Type(s)

\Joomla\Session\Session

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

since	1.6.0
link

Type(s)

array

The application configuration object.

inherited

since	1.0

Type(s)

\Joomla\Registry\Registry

The application input object.

inherited

since	1.0

Type(s)

\Joomla\Input\Input

A logger.

inherited

since	1.0

Type(s)

\Psr\Log\LoggerInterface

since	1.0
package	Joomla Framework

AbstractWebApplication

Methods

__construct

Arguments

Response

allowCache

Arguments

Response

appendBody

Arguments

Response

checkConnectionAlive

Response

checkHeadersSent

Response

checkToken

Arguments

Response

clearHeaders

Response

close

Arguments

compress

detectRequestUri

Response

doExecute

Response

execute

get

Arguments

Response

getBody

Arguments

Response

getFormToken

Arguments

Response

getHeaders

Response

getHttpStatusValue

Arguments

Response

getLogger

Response

getSession

Response

header

Arguments

initialise

isAscii

Arguments

Response

isRedirectState

Arguments

Response

isSslConnection

Response

isValidHttpStatus

Arguments

Response

loadSystemUris

Arguments

prependBody

Arguments

Response

redirect

Arguments

respond

sendHeaders

Response

set

Arguments

Response

setBody

Arguments

Response

setConfiguration

Arguments

Response

setHeader