public
|
#
__construct( JInput $input = null, Joomla\Registry\Registry $config = null, JApplicationWebClient $client = null )
Class constructor.
Parameters
- $input
JInput- $config
Joomla\Registry\Registry- $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
3.2
Overrides
|
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
3.2
Overrides
|
public
|
#
checkSession( )
Checks the user session.
If the session record doesn't exist, initialise it. If session is new, create
session variables
Throws
Since
3.2
|
public
|
#
enqueueMessage( string $msg, string $type = 'message' )
Enqueue a system message.
Enqueue a system message.
Parameters
- $msg
string - $msg The message to enqueue.- $type
string - $type The message type. Default is message. Since
3.2
|
public
|
#
execute( )
Execute the application.
Since
3.2
Overrides
|
protected
|
#
checkUserRequireReset( string $option, string $view, string $layout, string $tasks )
Check if the user is required to reset their password.
Check if the user is required to reset their password.
If the user is required to reset their password will be redirected to the
page that manage the password reset.
Parameters
- $option
string - $option The option that manage the password reset- $view
string - $view The view that manage the password reset- $layout
string - $layout The layout of the view that manage the password reset- $tasks
string - $tasks Permitted tasks
|
public
mixed
|
#
getCfg( string $varname, string $default = null )
Gets a configuration value.
Gets a configuration value.
Deprecated
4.0 Use get() instead
Parameters
- $varname
string - $varname The name of the value to get.- $default
string - $default Default value to return Returns
mixed - The user state.
Since
3.2
|
public
integer
|
#
getClientId( )
Gets the client id of the current running application.
Gets the client id of the current running application.
Returns
integer - A client identifier.
Since
3.2
|
public static
JApplicationCms
|
#
getInstance( string $name = null )
Returns a reference to the global JApplicationCms object, only creating it if
it doesn't already exist.
Returns a reference to the global JApplicationCms object, only creating it if
it doesn't already exist.
This method must be invoked as: $web = JApplicationCms::getInstance();
Parameters
- $name
string - $name The name (optional) of the JApplicationCms class to instantiate. Returns
Throws
Since
3.2
Overrides
|
public
array
|
#
getMessageQueue( boolean $clear = false )
Get the system message queue.
Get the system message queue.
Parameters
- $clear
boolean - $clear Clear the messages currently attached to the application object Returns
array - The system message queue.
Since
3.2
|
public
string
|
#
getName( )
Gets the name of the current running application.
Gets the name of the current running application.
Returns
string - The name of the application.
Since
3.2
|
public
JPathway|null
|
#
getPathway( string $name = null, array $options = array() )
Returns the application JPathway object.
Returns the application JPathway object.
Parameters
- $name
string - $name The name of the application.- $options
array - $options An optional associative array of configuration settings. Returns
Since
3.2
|
public static
JRouter|null
|
#
getRouter( string $name = null, array $options = array() )
Returns the application JRouter object.
Returns the application JRouter object.
Parameters
- $name
string - $name The name of the application.- $options
array - $options An optional associative array of configuration settings. Returns
Since
3.2
|
public
mixed
|
#
getTemplate( boolean $params = false )
Gets the name of the current template.
Gets the name of the current template.
Parameters
- $params
boolean - $params An optional associative array of configuration settings Returns
mixed - System is the fallback.
Since
3.2
|
public
mixed
|
#
getUserState( string $key, mixed $default = null )
Gets a user state.
Parameters
- $key
string - $key The path of the state.- $default
mixed - $default Optional default value, returned if the internal value is null. Returns
mixed - The user state or null.
Since
3.2
|
public
mixed
|
#
getUserStateFromRequest( string $key, string $request, string $default = null, string $type = 'none' )
Gets the value of a user state variable.
Gets the value of a user state variable.
Parameters
- $key
string - $key The key of the user state variable.- $request
string - $request The name of the variable passed in a request.- $default
string - $default The default value for the variable if not found. Optional.- $type
string - $type Filter for the variable, for valid values see JFilterInput::clean(). Optional. Returns
mixed - The request user state.
Since
3.2
|
protected
|
#
initialiseApp( array $options = array() )
Initialise the application.
Initialise the application.
Parameters
- $options
array - $options An optional associative array of configuration settings. Since
3.2
|
public
boolean
|
#
isAdmin( )
Is admin interface?
Deprecated
Use isClient('administrator') instead.
Returns
boolean - True if this application is administrator.
Since
3.2
|
public
boolean
|
#
isSite( )
Is site interface?
Deprecated
Use isClient('site') instead.
Returns
boolean - True if this application is site.
Since
3.2
|
public
boolean
|
#
isHttpsForced( integer $clientId = null )
Checks if HTTPS is forced in the client configuration.
Checks if HTTPS is forced in the client configuration.
Parameters
- $clientId
integer - $clientId An optional client id (defaults to current application client). Returns
boolean - True if is forced for the client, false otherwise.
Since
3.7.3
|
public
boolean
|
#
isClient( string $identifier )
Check the client interface by name.
Check the client interface by name.
Parameters
- $identifier
string - $identifier String identifier for the application interface Returns
boolean - True if this application is of the given type client interface.
Since
3.7.0
|
protected
|
#
loadLibraryLanguage( )
Load the library language files for the application
Load the library language files for the application
Since
3.6.3
|
public
JApplicationCms
|
#
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 Returns
Since
3.2
Overrides
|
public
boolean|JException
|
#
login( array $credentials, array $options = array() )
Login authentication function.
Login authentication function.
Username and encoded password are passed the onUserLogin event which is
responsible for the user validation. A successful validation updates the current
session record with the user's 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.
Parameters
- $credentials
array - $credentials Array('username' => string, 'password' => string)- $options
array - $options Array('remember' => boolean) Returns
boolean|JException - True on success, false if failed or silent handling is configured, or a
JException object on authentication error.
Since
3.2
|
public
boolean
|
#
logout( integer $userid = null, array $options = array() )
Logout authentication function.
Logout authentication function.
Passed the current user information to the onUserLogout event and reverts the
current session record back to 'anonymous' parameters. If any of the
authentication plugins did not successfully complete the logout routine then the
whole method fails. Any errors raised should be done in the plugin as this
provides the ability to give much more information about why the routine may
have failed.
Parameters
- $userid
integer - $userid The user to load - Can be an integer or string - If string, it is
converted to ID automatically- $options
array - $options Array('clientid' => array of client id's) Returns
boolean - True on success
Since
3.2
|
public
|
#
redirect( string $url, integer $status = 303 )
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
3.2
Overrides
|
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
3.2
Overrides
|
protected
|
#
route( )
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.
Since
3.2
|
public
mixed
|
#
setUserState( string $key, mixed $value )
Sets the value of a user state variable.
Sets the value of a user state variable.
Parameters
- $key
string - $key The path of the state.- $value
mixed - $value The value of the variable. Returns
mixed - The previous state, if one existed.
Since
3.2
|
public
string
|
#
toString( boolean $compress = false )
Sends all headers prior to returning the string
Sends all headers prior to returning the string
Parameters
- $compress
boolean - $compress If true, compress the data Returns
string
Since
3.2
|
JApplicationBase