Docs For Class JApplicationWeb

JApplicationWeb

Description

Base class for a Joomla! Web application.

since: 11.4

Located in /libraries/joomla/application/web.php (line 19)

JApplicationBase
   |
   --JApplicationWeb

Direct descendents

Class	Description
JApplicationCms	Joomla! CMS Application class
JWeb	Deprecated class placeholder. You should use JApplicationWeb instead.

Variable Summary

static JApplicationWeb $instance

string $charSet

JApplicationWebClient $client

JRegistry $config

JDocument $document

JLanguage $language

string $mimeType

JDate $modifiedDate

object The $response

JSession $session

Method Summary

static JApplicationWeb getInstance ([string $name = null])

JApplicationWeb __construct ([JInput $input = null], [JRegistry $config = null], [JApplicationWebClient $client = null])

void afterSessionStart ()

boolean allowCache ([boolean $allow = null])

JApplicationWeb appendBody (string $content)

boolean checkConnectionAlive ()

boolean checkHeadersSent ()

JApplicationWeb clearHeaders ()

void compress ()

string detectRequestUri ()

void doExecute ()

void execute ()

mixed fetchConfigurationData ([string $file = ''], [string $class = 'JConfig'])

void flushAssets ()

mixed get (string $key, [mixed $default = null])

mixed getBody ([boolean $asArray = false])

JDocument getDocument ()

array getHeaders ()

JLanguage getLanguage ()

JSession getSession ()

void header (string $string, [boolean $replace = true], [integer $code = null])

JApplicationWeb initialise ([mixed $session = null], [mixed $document = null], [mixed $language = null], [mixed $dispatcher = null])

boolean isSSLConnection ()

JApplicationWeb loadConfiguration (mixed $data)

JApplicationWeb loadDocument ([JDocument $document = null])

JApplicationWeb loadLanguage ([JLanguage $language = null])

JApplicationWeb loadSession ([JSession $session = null])

void loadSystemUris ([string $requestUri = null])

JApplicationWeb prependBody (string $content)

void redirect (string $url, [boolean $moved = false])

void render ()

void respond ()

JApplicationWeb sendHeaders ()

mixed set (string $key, [mixed $value = null])

JApplicationWeb setBody (string $content)

JApplicationWeb setHeader (string $name, string $value, [boolean $replace = false])

Variables

static JApplicationWeb $instance (line 79)

var: The application instance.
since: 11.3
access: protected

string $charSet = 'utf-8' (line 25)

var: Character encoding string.
since: 11.3
access: public

JApplicationWebClient $client (line 43)

var: The application client object.
since: 11.3
access: public

JRegistry $config (line 49)

var: The application configuration object.
since: 11.3
access: protected

JDocument $document (line 55)

var: The application document object.
since: 11.3
access: protected

JLanguage $language (line 61)

var: The application language object.
since: 11.3
access: protected

string $mimeType = 'text/html' (line 31)

var: Response mime type.
since: 11.3
access: public

JDate $modifiedDate (line 37)

var: The body modified date for response headers.
since: 11.3
access: public

object The $response (line 73)

var: application response object.
since: 11.3
access: protected

JSession $session (line 67)

var: The application session object.
since: 11.3
access: protected

Inherited Variables

Inherited from JApplicationBase

JApplicationBase::$dispatcher
JApplicationBase::$identity
JApplicationBase::$input

Methods

static getInstance (line 159)

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();

since: 11.3
access: public

static JApplicationWeb getInstance ([string $name = null])

string $name: The name (optional) of the JApplicationWeb class to instantiate.

Redefined in descendants as:

JApplicationCms::getInstance() : Returns a reference to the global JApplicationCms object, only creating it if it doesn't already exist.

Constructor __construct (line 96)

Class constructor.

since: 11.3
access: public

JApplicationWeb __construct ([JInput $input = null], [JRegistry $config = null], [JApplicationWebClient $client = null])

mixed $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.
mixed $config: An optional argument to provide dependency injection for the application's config object. If the argument is a JRegistry object that object will become the application's config object, otherwise a default config object is created.
mixed $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.

Redefined in descendants as:

JApplicationCms::__construct() : Class constructor.
InstallationApplicationWeb::__construct() : Class constructor.
JApplicationAdministrator::__construct() : Class constructor.
JApplicationSite::__construct() : Class constructor.
JWeb::__construct() : Class constructor.

afterSessionStart (line 1087)

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

since: 12.2
access: public

void afterSessionStart ()

Redefined in descendants as:

JApplicationCms::afterSessionStart() : After the session has been started we need to populate it with some default values.

allowCache (line 607)

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

since: 11.3
access: public

boolean allowCache ([boolean $allow = null])

boolean $allow: True to allow browser caching.

appendBody (line 753)

Append content to the body content

return: Instance of $this to allow chaining.
since: 11.3
access: public

JApplicationWeb appendBody (string $content)

string $content: The content to append to the response body.

checkConnectionAlive (line 820)

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

return: True if the connection is valid and normal.
see: connection_status()
since: 11.3
access: protected

boolean checkConnectionAlive ()

checkHeadersSent (line 835)

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.

return: True if the headers have already been sent.
see: headers_sent()
since: 11.3
access: protected

boolean checkHeadersSent ()

clearHeaders (line 677)

Method to clear any set response headers.

return: Instance of $this to allow chaining.
since: 11.3
access: public

JApplicationWeb clearHeaders ()

compress (line 342)

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

since: 11.3
access: protected

void compress ()

detectRequestUri (line 847)

Method to detect the requested URI from server environment variables.

return: The requested URI
since: 11.3
access: protected

string detectRequestUri ()

doExecute (line 291)

Method to run the Web application routines. Most likely you will want to instantiate a controller and execute it, or perform some sort of action that populates a JDocument object so that output can be rendered to the client.

since: 11.3
access: protected

void doExecute ()

Redefined in descendants as:

InstallationApplicationWeb::doExecute() : Method to run the Web application routines.
JApplicationAdministrator::doExecute() : Method to run the Web application routines.
JApplicationSite::doExecute() : Method to run the Web application routines.

execute (line 241)

Execute the application.

since: 11.3
access: public

void execute ()

Redefined in descendants as:

JApplicationCms::execute() : Execute the application.

fetchConfigurationData (line 901)

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.

return: Either an array or object to be loaded into the configuration object.
since: 11.3
throws: RuntimeException
access: protected

mixed fetchConfigurationData ([string $file = ''], [string $class = 'JConfig'])

string $file: The path and filename of the configuration file. If not provided, configuration.php in JPATH_BASE will be used.
string $class: The class name to instantiate.

Redefined in descendants as:

InstallationApplicationWeb::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.

flushAssets (line 942)

Flush the media version to refresh versionable assets

since: 3.2
access: public

void flushAssets ()

get (line 574)

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

return: The value of the configuration.
since: 11.3
access: public

mixed get (string $key, [mixed $default = null])

string $key: The name of the property.
mixed $default: The default value (optional) if none is set.

getBody (line 769)

Return the body content

return: The response body either as an array or concatenated string.
since: 11.3
access: public

mixed getBody ([boolean $asArray = false])

boolean $asArray: True to return the body as an array of strings.

getDocument (line 781)

Method to get the application document object.

return: The document object
since: 11.3
access: public

JDocument getDocument ()

getHeaders (line 665)

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

since: 11.3
access: public

array getHeaders ()

getLanguage (line 793)

Method to get the application language object.

return: The language object
since: 11.3
access: public

JLanguage getLanguage ()

getSession (line 805)

Method to get the application session object.

return: The session object
since: 11.3
access: public

JSession getSession ()

header (line 964)

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

see: JApplicationWeb::header()
since: 11.3
access: protected

void header (string $string, [boolean $replace = true], [integer $code = null])

string $string: The header string.
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.
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.

initialise (line 209)

Initialise the application.

return: Instance of $this to allow chaining.
see: JApplicationBase::loadDispatcher()
see: JApplicationWeb::loadDocument()
see: JApplicationWeb::loadLanguage()
see: JApplicationWeb::loadSession()
deprecated: 13.1 (Platform) & 4.0 (CMS)
since: 11.3
access: public

JApplicationWeb initialise ([mixed $session = null], [mixed $document = null], [mixed $language = null], [mixed $dispatcher = null])

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

isSSLConnection (line 976)

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

return: True if using SSL, false if not.
since: 12.2
access: public

boolean isSSLConnection ()

loadConfiguration (line 549)

Load an object or array into the application configuration object.

return: Instance of $this to allow chaining.
since: 11.3
access: public

JApplicationWeb loadConfiguration (mixed $data)

mixed $data: Either an array or object to be loaded into the configuration object.

loadDocument (line 994)

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.

return: This method is chainable.
since: 11.3
access: public

JApplicationWeb loadDocument ([JDocument $document = null])

JDocument $document: An optional document object. If omitted, the factory document is created.

Redefined in descendants as:

InstallationApplicationWeb::loadDocument() : Allows the application to load a custom or default document.

loadLanguage (line 1014)

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.

return: This method is chainable.
since: 11.3
access: public

JApplicationWeb loadLanguage ([JLanguage $language = null])

JLanguage $language: An optional language object. If omitted, the factory language is created.

loadSession (line 1034)

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.

return: This method is chainable.
since: 11.3
access: public

JApplicationWeb loadSession ([JSession $session = null])

JSession $session: An optional session object. If omitted, the session is created.

Redefined in descendants as:

InstallationApplicationWeb::loadSession() : Allows the application to load a custom or default session.

loadSystemUris (line 1108)

Method to load the system URI strings for the application.

since: 11.3
access: protected

void loadSystemUris ([string $requestUri = null])

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

prependBody (line 737)

Prepend content to the body content

return: Instance of $this to allow chaining.
since: 11.3
access: public

JApplicationWeb prependBody (string $content)

string $content: The content to prepend to the response body.

redirect (line 466)

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.

since: 11.3
access: public

void redirect (string $url, [boolean $moved = false])

string $url: The URL to redirect to. Can only be http/https URL
boolean $moved: True if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.

render (line 305)

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
access: protected

void render ()

Redefined in descendants as:

InstallationApplicationWeb::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.
JApplicationAdministrator::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.
JApplicationSite::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.

respond (line 417)

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

since: 11.3
access: protected

void respond ()

sendHeaders (line 691)

Send the response headers.

return: Instance of $this to allow chaining.
since: 11.3
access: public

JApplicationWeb sendHeaders ()

set (line 589)

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

return: Previous value of the property
since: 11.3
access: public

mixed set (string $key, [mixed $value = null])

string $key: The name of the property.
mixed $value: The value of the property to set (optional).

setBody (line 721)

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

return: Instance of $this to allow chaining.
since: 11.3
access: public

JApplicationWeb setBody (string $content)

string $content: The content to set as the response body.

setHeader (line 630)

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.

return: Instance of $this to allow chaining.
since: 11.3
access: public

JApplicationWeb setHeader (string $name, string $value, [boolean $replace = false])

string $name: The name of the header to set.
string $value: The value of the header to set.
boolean $replace: True to replace any headers with the same name.

Inherited Methods

Inherited From JApplicationBase

JApplicationBase::close()
JApplicationBase::getIdentity()
JApplicationBase::loadDispatcher()
JApplicationBase::loadIdentity()
JApplicationBase::registerEvent()
JApplicationBase::triggerEvent()

Documentation generated on Tue, 19 Nov 2013 15:18:21 +0100 by phpDocumentor 1.4.3