Class JApplicationWeb

Base class for a Joomla! Web application.

Joomla\Application\AbstractApplication implements Psr\Log\LoggerAwareInterface

JApplicationBase

JApplicationWeb

Direct known subclasses

JApplicationCms, JWeb

Indirect known subclasses

JApplicationAdministrator, JApplicationSite

Package: Joomla\Platform\Application
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.4
Note: As of 4.0 this class will be abstract
Located at joomla/application/web.php

Methods summary

`public`	# `__construct( JInput $input = null, Joomla\Registry\Registry $config = null, JApplicationWebClient $client = null )` Class constructor. Class constructor. Parameters `$input` `JInput` - $input An optional argument to provide dependency injection for the application's input object. If the argument is a JInput object that object will become the application's input object, otherwise a default input object is created. `$config` `Joomla\Registry\Registry` - $config An 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` `JApplicationWebClient` - $client An optional argument to provide dependency injection for the application's client object. If the argument is a JApplicationWebClient object that object will become the application's client object, otherwise a default client object is created. Since 11.3 Overrides `JApplicationBase::__construct`
`public static JApplicationWeb`	# `getInstance( string $name = null )` Returns a reference to the global JApplicationWeb object, only creating it if it doesn't already exist. Returns a reference to the global JApplicationWeb object, only creating it if it doesn't already exist. This method must be invoked as: $web = JApplicationWeb::getInstance(); Parameters `$name` `string` - $name The name (optional) of the JApplicationWeb class to instantiate. Returns `JApplicationWeb` Since 11.3
`public JApplicationWeb`	# `initialise( mixed $session = null, mixed $document = null, mixed $language = null, mixed $dispatcher = null )` Initialise the application. Initialise the application. Deprecated 13.1 (Platform) & 4.0 (CMS) Parameters `$session` `mixed` - $session An optional argument to provide dependency injection for the application's session object. If the argument is a JSession object that object will become the application's session object, if it is false then there will be no session object, and if it is null then the default session object will be created based on the application's loadSession() method. `$document` `mixed` - $document An optional argument to provide dependency injection for the application's document object. If the argument is a JDocument object that object will become the application's document object, if it is false then there will be no document object, and if it is null then the default document object will be created based on the application's loadDocument() method. `$language` `mixed` - $language An optional argument to provide dependency injection for the application's language object. If the argument is a JLanguage object that object will become the application's language object, if it is false then there will be no language object, and if it is null then the default language object will be created based on the application's loadLanguage() method. `$dispatcher` `mixed` - $dispatcher An optional argument to provide dependency injection for the application's event dispatcher. If the argument is a JEventDispatcher object that object will become the application's event dispatcher, if it is null then the default event dispatcher will be created based on the application's loadDispatcher() method. Returns `JApplicationWeb` - Instance of $this to allow chaining. Since 11.3 See `JApplicationWeb::loadSession()` `JApplicationWeb::loadDocument()` `JApplicationWeb::loadLanguage()` `JApplicationBase::loadDispatcher()` Overrides `Joomla\Application\AbstractApplication::initialise`
`public`	# `execute( )` Execute the application. Execute the application. Since 11.3 Overrides `Joomla\Application\AbstractApplication::execute`
`protected`	# `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. 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. Since 11.3
`protected`	# `compress( )` Checks the accept encoding of the browser and compresses the data before sending it to the client if possible. Checks the accept encoding of the browser and compresses the data before sending it to the client if possible. Since 11.3
`protected`	# `respond( )` Method to send the application response to the client. All headers will be sent prior to the main application output data. Method to send the application response to the client. All headers will be sent prior to the main application output data. Since 11.3
`public`	# `redirect( string $url, integer $status = 303 )` Redirect to another URL. Redirect to another URL. 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. Parameters `$url` `string` - $url The URL to redirect to. Can only be http/https URL. `$status` `integer` - $status The HTTP 1.1 status code to be provided. 303 is assumed by default. Since 11.3
`public JApplicationWeb`	# `loadConfiguration( mixed $data )` Load an object or array into the application configuration object. Load an object or array into the application configuration object. Parameters `$data` `mixed` - $data Either an array or object to be loaded into the configuration object. Returns `JApplicationWeb` - Instance of $this to allow chaining. Since 11.3
`public boolean`	# `allowCache( boolean $allow = null )` Set/get cachable state for the response. If $allow is set, sets the cachable state of the response. Always returns the current state. Set/get cachable state for the response. If $allow is set, sets the cachable state of the response. Always returns the current state. Parameters `$allow` `boolean` - $allow True to allow browser caching. Returns `boolean` Since 11.3
`public JApplicationWeb`	# `setHeader( string $name, string $value, boolean $replace = false )` 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. 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. Parameters `$name` `string` - $name The name of the header to set. `$value` `string` - $value The value of the header to set. `$replace` `boolean` - $replace True to replace any headers with the same name. Returns `JApplicationWeb` - Instance of $this to allow chaining. Since 11.3
`public array`	# `getHeaders( )` Method to get the array of response headers to be sent when the response is sent to the client. Method to get the array of response headers to be sent when the response is sent to the client. Returns `array` - * Since 11.3
`public JApplicationWeb`	# `clearHeaders( )` Method to clear any set response headers. Method to clear any set response headers. Returns `JApplicationWeb` - Instance of $this to allow chaining. Since 11.3
`public JApplicationWeb`	# `sendHeaders( )` Send the response headers. Send the response headers. Returns `JApplicationWeb` - Instance of $this to allow chaining. Since 11.3
`public JApplicationWeb`	# `setBody( string $content )` Set body content. If body content already defined, this will replace it. Set body content. If body content already defined, this will replace it. Parameters `$content` `string` - $content The content to set as the response body. Returns `JApplicationWeb` - Instance of $this to allow chaining. Since 11.3
`public JApplicationWeb`	# `prependBody( string $content )` Prepend content to the body content Prepend content to the body content Parameters `$content` `string` - $content The content to prepend to the response body. Returns `JApplicationWeb` - Instance of $this to allow chaining. Since 11.3
`public JApplicationWeb`	# `appendBody( string $content )` Append content to the body content Append content to the body content Parameters `$content` `string` - $content The content to append to the response body. Returns `JApplicationWeb` - Instance of $this to allow chaining. Since 11.3
`public mixed`	# `getBody( boolean $asArray = false )` Return the body content Return the body content Parameters `$asArray` `boolean` - $asArray True to return the body as an array of strings. Returns `mixed` - The response body either as an array or concatenated string. Since 11.3
`public JDocument`	# `getDocument( )` Method to get the application document object. Method to get the application document object. Returns `JDocument` - The document object Since 11.3
`public JLanguage`	# `getLanguage( )` Method to get the application language object. Method to get the application language object. Returns `JLanguage` - The language object Since 11.3
`public JSession`	# `getSession( )` Method to get the application session object. Method to get the application session object. Returns `JSession` - The session object Since 11.3
`protected boolean`	# `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. 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. Returns `boolean` - True if the connection is valid and normal. Since 11.3 See connection_status() CodeCoverageIgnore
`protected boolean`	# `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. 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. Returns `boolean` - True if the headers have already been sent. Since 11.3 See headers_sent() CodeCoverageIgnore
`protected string`	# `detectRequestUri( )` Method to detect the requested URI from server environment variables. Method to detect the requested URI from server environment variables. Returns `string` - The requested URI Since 11.3
`protected mixed`	# `fetchConfigurationData( string $file = '', string $class = 'JConfig' )` 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. 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. Parameters `$file` `string` - $file The path and filename of the configuration file. If not provided, configuration.php in JPATH_CONFIGURATION will be used. `$class` `string` - $class The class name to instantiate. Returns `mixed` - Either an array or object to be loaded into the configuration object. Throws `RuntimeException` Since 11.3
`public`	# `flushAssets( )` Flush the media version to refresh versionable assets Flush the media version to refresh versionable assets Since 3.2
`protected`	# `header( string $string, boolean $replace = true, integer $code = null )` Method to send a header to the client. We are wrapping this to isolate the header() function from our code base for testing reasons. Method to send a header to the client. We are wrapping this to isolate the header() function from our code base for testing reasons. Parameters `$string` `string` - $string The header string. `$replace` `boolean` - $replace The optional replace parameter indicates whether the header should replace a previous similar header, or add a second header of the same type. `$code` `integer` - $code Forces the HTTP response code to the specified value. Note that this parameter only has an effect if the string is not empty. Since 11.3 See `JApplicationWeb::header()` CodeCoverageIgnore
`public boolean`	# `isSSLConnection( )` Determine if we are using a secure (SSL) connection. Determine if we are using a secure (SSL) connection. Returns `boolean` - True if using SSL, false if not. Since 12.2
`public JApplicationWeb`	# `loadDocument( JDocument $document = null )` Allows the application to load a custom or default document. Allows the application to load a custom or default document. 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. Parameters `$document` `JDocument` - $document An optional document object. If omitted, the factory document is created. Returns `JApplicationWeb` - This method is chainable. Since 11.3
`public JApplicationWeb`	# `loadLanguage( JLanguage $language = null )` Allows the application to load a custom or default language. Allows the application to load a custom or default language. 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. Parameters `$language` `JLanguage` - $language An optional language object. If omitted, the factory language is created. Returns `JApplicationWeb` - This method is chainable. Since 11.3
`public JApplicationWeb`	# `loadSession( JSession $session = null )` Allows the application to load a custom or default session. Allows the application to load a custom or default session. 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. Parameters `$session` `JSession` - $session An optional session object. If omitted, the session is created. Returns `JApplicationWeb` - This method is chainable. Since 11.3
`public`	# `afterSessionStart( )` After the session has been started we need to populate it with some default values. After the session has been started we need to populate it with some default values. Since 12.2
`protected`	# `loadSystemUris( string $requestUri = null )` Method to load the system URI strings for the application. Method to load the system URI strings for the application. Parameters `$requestUri` `string` - $requestUri An optional request URI to use instead of detecting one from the server environment variables. Since 11.3

Methods inherited from JApplicationBase

doExecute(), getIdentity(), loadDispatcher(), loadIdentity(), registerEvent(), triggerEvent()

Methods inherited from Joomla\Application\AbstractApplication

close(), get(), getLogger(), set(), setConfiguration(), setLogger()

Magic methods summary

Properties summary

`public string`	`$charSet`	# Character encoding string. Character encoding string. Since 11.3
`public string`	`$mimeType`	# Response mime type. Response mime type. Since 11.3
`public JDate`	`$modifiedDate`	# The body modified date for response headers. The body modified date for response headers. Since 11.3
`public JApplicationWebClient`	`$client`	# The application client object. The application client object. Since 11.3
`protected JDocument`	`$document`	# The application document object. The application document object. Since 11.3
`protected JLanguage`	`$language`	# The application language object. The application language object. Since 11.3
`protected JSession`	`$session`	# The application session object. The application session object. Since 11.3
`protected object`	`$response`	# The application response object. The application response object. Since 11.3
`protected static JApplicationWeb`	`$instance`	# The application instance. The application instance. Since 11.3

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JApplicationWeb

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Since

Deprecated

Parameters

Returns

Since

See

Overrides

Since

Overrides

Since

Since

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

See

CodeCoverageIgnore

Returns

Since

See

CodeCoverageIgnore

Returns

Since

Parameters

Returns

Throws

Since

Since

Parameters

Since

See