JApplicationWeb

Extends \JApplicationBase

Base class for a Joomla! Web application.

since

11.4

note

As of 4.0 this class will be abstract

package

Joomla.Platform

Methods

__construct

Class constructor.

__construct(\Joomla\Input\Input $input = null, \Joomla\Registry\Registry $config = null) 
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.

afterSessionStart

After the session has been started we need to populate it with some default values.

afterSessionStart() : void
since

12.2

allowCache

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

allowCache(boolean $allow = null) : boolean
since

11.3

Arguments

$allow

booleanTrue to allow browser caching.

Response

boolean

appendBody

Append content to the body content

appendBody(string $content) : \JApplicationWeb
since

11.3

Arguments

$content

stringThe content to append to the response body.

Response

\JApplicationWebInstance of $this to allow chaining.

checkConnectionAlive

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() : boolean
see \connection_status()
since

11.3

Response

booleanTrue if the connection is valid and normal.

checkHeadersSent

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() : boolean
see \headers_sent()
since

11.3

Response

booleanTrue if the headers have already been sent.

clearHeaders

Method to clear any set response headers.

clearHeaders() : \JApplicationWeb
since

11.3

Response

\JApplicationWebInstance of $this to allow chaining.

close

Method to close the application.

close(integer $code) : void
inherited
since

1.0

Arguments

$code

integerThe exit code (optional; default is 0).

compress

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

compress() : void
since

11.3

detectRequestUri

Method to detect the requested URI from server environment variables.

detectRequestUri() : string
since

11.3

Response

stringThe requested URI

doExecute

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() : void
inherited abstract
since

1.0

execute

Execute the application.

execute() : void
inherited
since

1.0

fetchConfigurationData

Method to load a PHP configuration class file based on convention and return the instantiated data object. You will extend this method in child classes to provide configuration data from whatever data source is relevant for your specific application.

fetchConfigurationData(string $file = '', string $class = 'JConfig') : mixed
since

11.3

throws

\RuntimeException

Arguments

$file

stringThe path and filename of the configuration file. If not provided, configuration.php in JPATH_CONFIGURATION will be used.

$class

stringThe class name to instantiate.

Response

mixedEither an array or object to be loaded into the configuration object.

flushAssets

Flush the media version to refresh versionable assets

flushAssets() : void
since

3.2

get

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.

getBody

Return the body content

getBody(boolean $asArray = false) : mixed
since

11.3

Arguments

$asArray

booleanTrue to return the body as an array of strings.

Response

mixedThe response body either as an array or concatenated string.

getDocument

Method to get the application document object.

getDocument() : \JDocument
since

11.3

Response

\JDocumentThe document object

getHeaders

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

getHeaders() : array
since

11.3

Response

array*

getIdentity

Get the application identity.

getIdentity() : mixed
inherited
since

12.1

Response

mixedA JUser object or null.

getInstance

Returns a reference to the global JApplicationWeb object, only creating it if it doesn't already exist.

getInstance(string $name = null) : \JApplicationWeb
static

This method must be invoked as: $web = JApplicationWeb::getInstance();

since

11.3

Arguments

$name

stringThe name (optional) of the JApplicationWeb class to instantiate.

Response

\JApplicationWeb

getLanguage

Method to get the application language object.

getLanguage() : \JLanguage
since

11.3

Response

\JLanguageThe language object

getLogger

Get the logger.

getLogger() : \Psr\Log\LoggerInterface
inherited
since

1.0

Response

\Psr\Log\LoggerInterface

getSession

Method to get the application session object.

getSession() : \JSession
since

11.3

Response

\JSessionThe session object

header

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, boolean $replace = true, integer $code = null) : void
see \JApplicationWeb::header()
since

11.3

Arguments

$string

stringThe header string.

$replace

booleanThe optional replace parameter indicates whether the header should replace a previous similar header, or add a second header of the same type.

$code

integerForces the HTTP response code to the specified value. Note that this parameter only has an effect if the string is not empty.

initialise

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

isSSLConnection

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

isSSLConnection() : boolean
since

12.2

Response

booleanTrue if using SSL, false if not.

loadConfiguration

Load an object or array into the application configuration object.

loadConfiguration(mixed $data) : \JApplicationWeb
since

11.3

Arguments

$data

mixedEither an array or object to be loaded into the configuration object.

Response

\JApplicationWebInstance of $this to allow chaining.

loadDispatcher

Allows the application to load a custom or default dispatcher.

loadDispatcher(\JEventDispatcher $dispatcher = null) : \JApplicationBase
inherited

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create event dispatchers, if required, based on more specific needs.

since

12.1

Arguments

$dispatcher

\JEventDispatcherAn optional dispatcher object. If omitted, the factory dispatcher is created.

Response

\JApplicationBaseThis method is chainable.

loadDocument

Allows the application to load a custom or default document.

loadDocument(\JDocument $document = null) : \JApplicationWeb

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create a document, if required, based on more specific needs.

since

11.3

Arguments

$document

\JDocumentAn optional document object. If omitted, the factory document is created.

Response

\JApplicationWebThis method is chainable.

loadIdentity

Allows the application to load a custom or default identity.

loadIdentity(\JUser $identity = null) : \JApplicationBase
inherited

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create an identity, if required, based on more specific needs.

since

12.1

Arguments

$identity

\JUserAn optional identity object. If omitted, the factory user is created.

Response

\JApplicationBaseThis method is chainable.

loadLanguage

Allows the application to load a custom or default language.

loadLanguage(\JLanguage $language = null) : \JApplicationWeb

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create a language, if required, based on more specific needs.

since

11.3

Arguments

$language

\JLanguageAn optional language object. If omitted, the factory language is created.

Response

\JApplicationWebThis method is chainable.

loadSession

Allows the application to load a custom or default session.

loadSession(\JSession $session = null) : \JApplicationWeb

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create a session, if required, based on more specific needs.

since

11.3

Arguments

$session

\JSessionAn optional session object. If omitted, the session is created.

Response

\JApplicationWebThis method is chainable.

loadSystemUris

Method to load the system URI strings for the application.

loadSystemUris(string $requestUri = null) : void
since

11.3

Arguments

$requestUri

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

prependBody

Prepend content to the body content

prependBody(string $content) : \JApplicationWeb
since

11.3

Arguments

$content

stringThe content to prepend to the response body.

Response

\JApplicationWebInstance of $this to allow chaining.

redirect

Redirect to another URL.

redirect(string $url, integer $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

11.3

Arguments

$url

stringThe URL to redirect to. Can only be http/https URL.

$status

integerThe HTTP 1.1 status code to be provided. 303 is assumed by default.

registerEvent

Registers a handler to a particular event group.

registerEvent(string $event, callable $handler) : \JApplicationBase
inherited
since

12.1

Arguments

$event

stringThe event name.

$handler

callableThe handler, a function or an instance of an event object.

Response

\JApplicationBaseThe application to allow chaining.

render

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the application response buffer.

render() : void
since

11.3

respond

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

respond() : void
since

11.3

sendHeaders

Send the response headers.

sendHeaders() : \JApplicationWeb
since

11.3

Response

\JApplicationWebInstance of $this to allow chaining.

set

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

setBody

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

setBody(string $content) : \JApplicationWeb
since

11.3

Arguments

$content

stringThe content to set as the response body.

Response

\JApplicationWebInstance of $this to allow chaining.

setConfiguration

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.

setHeader

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, boolean $replace = false) : \JApplicationWeb
since

11.3

Arguments

$name

stringThe name of the header to set.

$value

stringThe value of the header to set.

$replace

booleanTrue to replace any headers with the same name.

Response

\JApplicationWebInstance of $this to allow chaining.

setLogger

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.

triggerEvent

Calls all handlers associated with an event group.

triggerEvent(string $event, array $args = null) : array
inherited
since

12.1

Arguments

$event

stringThe event name.

$args

arrayAn array of arguments (optional).

Response

arrayAn array of results from each function call, or null if no dispatcher is defined.

Properties

charSet

Character encoding string.

Type(s)

string

mimeType

Response mime type.

Type(s)

string

modifiedDate

The body modified date for response headers.

Type(s)

\JDate

client

The application client object.

Type(s)

\JApplicationWebClient

document

The application document object.

Type(s)

\JDocument

language

The application language object.

Type(s)

\JLanguage

session

The application session object.

Type(s)

\JSession

response

The application response object.

Type(s)

object

instance

The application instance.

static

responseMap

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

Type(s)

object

singleValueResponseHeaders

A map of HTTP Response headers which may only send a single value, all others are considered to allow multiple

Type(s)

object

dispatcher

The application dispatcher object.

inherited

identity

The application identity object.

inherited

Type(s)

\JUser

config

The application configuration object.

inherited

input

The application input object.

inherited

logger

A logger.

inherited

Type(s)

\Psr\Log\LoggerInterface

input

The application input object.

inherited

The application input object

Type(s)

\JInput