API15:JApplication/getRouter
From Joomla! Documentation
Description
Returns the application JRouter object.
Template:Description:JApplication/getRouter
Syntax
static getRouter($name=null, array $options=array())
Parameter Name | Default Value | Description |
---|---|---|
$name | null | $options An optional associative array of configuration settings. |
array() |
Returns
.
Defined in
libraries/joomla/application/application.php
Importing
jimport( 'joomla.application.application' );
Source Body
static public function getRouter($name = null, array $options = array())
{
if (!isset($name)) {
$name = $this->_name;
}
jimport('joomla.application.router');
$router = &JRouter::getInstance($name, $options);
if (JError::isError($router)) {
return null;
}
return $router;
}
[Edit See Also] Template:SeeAlso:JApplication/getRouter
Examples
<CodeExamplesForm />