API15

API15:JApplication/getRouter

From Joomla! Documentation

Revision as of 21:51, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Returns the application JRouter object. <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<no...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Returns the application JRouter object.

[Edit Descripton]

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