API15

JApplication/getRouter

From Joomla! Documentation

< API15:JApplication
Revision as of 16: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)

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Returns the application JRouter object.

[Edit Descripton]

Template:Description:JApplication/getRouter

Syntax[edit]

static getRouter($name=null, array $options=array())
Parameter Name Default Value Description
$name null $options An optional associative array of configuration settings.
array()

Returns[edit]

.

Defined in[edit]

libraries/joomla/application/application.php

Importing[edit]

jimport( 'joomla.application.application' );

Source Body[edit]

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[edit]

<CodeExamplesForm />