PHPXRef 0.7.1 : Joomla 1.5.26 DE : Detail view of application.php

Class: JApplication - X-Ref

Base class for a Joomla! application.

Acts as a Factory class for application specific objects and provides many
supporting API functions. Derived clases should supply the route(), dispatch()
and render() functions.

__construct($config = array() X-Ref

Class constructor.

param: integer A client identifier.

getInstance($client, $config = array() X-Ref

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

This method must be invoked as:
<pre>  $menu = &JApplication::getInstance();</pre>

param: mixed    $id         A client identifier or name.
param: array    $config     An optional associative array of configuration settings.
return: JApplication    The appliction object.

initialise($options = array() X-Ref

Initialise the application.

param: array An optional associative array of configuration settings.

route() X-Ref

Route the application.

Routing is the process of examining the request environment to determine which
component should receive the request. The component optional parameters
are then set in the request object to be processed when the application is being
dispatched.

dispatch($component) X-Ref

Dispatch the applicaiton.

Dispatching is the process of pulling the option from the request object and
mapping them to a component. If the component does not exist, it handles
determining a default component to dispatch.

render() X-Ref

Render the application.

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

close( $code = 0 ) X-Ref

Exit the application.

param: int Exit code

redirect( $url, $msg='', $msgType='message', $moved = false ) X-Ref

Redirect to another URL.

Optionally enqueues a message in the system message queue (which will be displayed
the next time a page is loaded) using the enqueueMessage method. 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 depending upon the moved flag. If the headers
have already been sent this will be accomplished using a JavaScript statement.

param: string    $url    The URL to redirect to. Can only be http/https URL
param: string    $msg    An optional message to display on redirect.
param: string  $msgType An optional message type.
param: boolean    True if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.
return: none; calls exit().

enqueueMessage( $msg, $type = 'message' ) X-Ref

Enqueue a system message.

param: string $msg The message to enqueue.
param: string $type The message type.
return: void

getMessageQueue() X-Ref

Get the system message queue.

return: The system message queue.

getCfg( $varname ) X-Ref

Gets a configuration value.

param: string The name of the value to get.
return: mixed The user state.

getName() X-Ref

Method to get the application name

The dispatcher name by default parsed using the classname, or it can be set
by passing a $config['name'] in the class constructor

return: string The name of the dispatcher

getUserState( $key ) X-Ref

Gets a user state.

param: string The path of the state.
return: mixed The user state.

setUserState( $key, $value ) X-Ref

Sets the value of a user state variable.

param: string    The path of the state.
param: string    The value of the variable.
return: mixed    The previous state, if one existed.

getUserStateFromRequest( $key, $request, $default = null, $type = 'none' ) X-Ref

Gets the value of a user state variable.

param: string    The key of the user state variable.
param: string    The name of the variable passed in a request.
param: string    The default value for the variable if not found. Optional.
param: string    Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
return: The request user state.

registerEvent($event, $handler) X-Ref

Registers a handler to a particular event group.

param: string The event name.
param: mixed The handler, a function or an instance of a event object.
return: void

triggerEvent($event, $args=null) X-Ref

Calls all handlers associated with an event group.

param: string    The event name.
param: array    An array of arguments.
return: array    An array of results from each function call.

Login authentication function.

Username and encoded password are passed the the onLoginUser event which
is responsible for the user validation. A successful validation updates
the current session record with the users details.

Username and encoded password are sent as credentials (along with other
possibilities) to each observer (authentication plugin) for user
validation.  Successful validation will update the current session with
the user details.

param: array     Array( 'username' => string, 'password' => string )
param: array     Array( 'remember' => boolean )
return: boolean True on success.

logout($userid = null, $options = array() X-Ref

Logout authentication function.

Passed the current user information to the onLogoutUser event and reverts the current
session record back to 'anonymous' parameters.

param: int $userid The user to load - Can be an integer or string - If string, it is converted to ID automatically
param: array $options Array( 'clientid' => array of client id's )

getTemplate() X-Ref

Gets the name of the current template.

return: string

getRouter($name = null, $options = array() X-Ref

Return a reference to the application JRouter object.

param: array $options An optional associative array of configuration settings.
return: JRouter.

getPathway($name = null, $options = array() X-Ref

Return a reference to the application JPathway object.

param: array $options An optional associative array of configuration settings.
return: object JPathway.

getMenu($name = null, $options = array() X-Ref

Return a reference to the application JPathway object.

param: array $options An optional associative array of configuration settings.
return: object JMenu.

_createConfiguration($file) X-Ref

Create the configuration registry

param: string $file The path to the configuration file

_createSession( $name ) X-Ref

Create the user session.

Old sessions are flushed based on the configuration value for the cookie
lifetime. If an existing session, then the last access time is updated.
If a new session, a session id is generated and a record is created in
the #__sessions table.

param: string The sessions name.
return: object JSession on success. May call exit() on database error.

getClientId( ) X-Ref

Gets the client id of the current running application.

return: int A client identifier.

isAdmin() X-Ref

Is admin interface?

return: boolean True if this application is administrator.

isSite() X-Ref

Is site interface?

return: boolean True if this application is site.

appendPathWay( $name, $link = null ) X-Ref

Deprecated, use JPathWay->addItem() method instead.

getCustomPathWay() X-Ref

Deprecated, use JPathway->getPathWayNames() method instead.

getHead() X-Ref

Deprecated, use JDocument->get( 'head' ) instead.

addMetaTag( $name, $content, $prepend = '', $append = '' ) X-Ref

Deprecated, use JDocument->setMetaData instead.

param: string Name of the metadata tag
param: string Content of the metadata tag
param: string Deprecated, ignored
param: string Deprecated, ignored

appendMetaTag( $name, $content ) X-Ref

Deprecated, use JDocument->setMetaData instead.

param: string Name of the metadata tag
param: string Content of the metadata tag

prependMetaTag( $name, $content ) X-Ref

Deprecated, use JDocument->setMetaData instead

param: string Name of the metadata tag
param: string Content of the metadata tag

addCustomHeadTag( $html ) X-Ref

Deprecated, use JDocument->addCustomTag instead (only when document type is HTML).

param: string Valid HTML

getBlogSectionCount( ) X-Ref

Deprecated.

getBlogCategoryCount( ) X-Ref

Deprecated.

getGlobalBlogSectionCount( ) X-Ref

Deprecated.

getStaticContentCount( ) X-Ref

Deprecated.

getContentItemLinkCount( ) X-Ref

Deprecated.

getPath($varname, $user_option = null) X-Ref

Deprecated, use JApplicationHelper::getPath instead.

getBasePath($client=0, $addTrailingSlash = true) X-Ref

Deprecated, use JURI::base() instead.

getUser() X-Ref

Deprecated, use JFactory::getUser instead.

getItemid( $id ) X-Ref

Deprecated, use ContentHelper::getItemid instead.

setPageTitle( $title=null ) X-Ref

Deprecated, use JDocument::setTitle instead.

getPageTitle() X-Ref

Deprecated, use JDocument::getTitle instead.

Copyright:	Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License:	GNU/GPL, see LICENSE.php
Version:	$Id: application.php 22244 2011-10-16 15:50:00Z dextercowley $
File Size:	1129 lines (28 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	1 file components/com_content/helpers/route.php

PHP Cross Reference of Joomla 1.5.26 DE

/libraries/joomla/application/ -> application.php (summary)

Defines 1 class