Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class SiteRouter - list of methods

Class to create and parse routes for the site application

Extends

Router
Package: Joomla\CMS\Router
Copyright: (C) 2007 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Router/SiteRouter.php
Project: Joomla

Method Summary

public
__construct
(\Joomla\CMS\Application\CMSApplication $app = null, \Joomla\CMS\Menu\AbstractMenu $menu = null)

Class constructor
Parameters
  • \Joomla\CMS\Application\CMSApplication $app Application Object
  • \Joomla\CMS\Menu\AbstractMenu $menu Menu object
Since
  • 3.4
Show source code of this method: __construct Source Code

public void
(mixed &$router, mixed &$uri)

Force to SSL
Parameters
  • \Joomla\CMS\Router\Router & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: parseCheckSSL Source Code

public void
(mixed &$router, mixed &$uri)

Do some initial cleanup before parsing the URL
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: parseInit Source Code

public void
(mixed &$router, mixed &$uri)

Parse the format of the request
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: parseFormat Source Code

public void
(mixed &$router, mixed &$uri)

Convert a sef route to an internal URI
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: parseSefRoute Source Code

public void
(mixed &$router, mixed &$uri)

Convert a raw route to an internal URI
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: parseRawRoute Source Code

public void
(mixed &$router, mixed &$uri)

Convert limits for pagination
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: parsePaginationData Source Code

public void
(mixed &$router, mixed &$uri)

Do some initial processing for building a URL
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: buildInit Source Code

public void
(mixed &$router, mixed &$uri)

Run the component preprocess method
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: buildComponentPreprocess Source Code

public void
(mixed &$router, mixed &$uri)

Build the SEF route
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: buildSefRoute Source Code

public void
(mixed &$router, mixed &$uri)

Convert limits for pagination
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: buildPaginationData Source Code

public void
(mixed &$router, mixed &$uri)

Build the format of the request
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: buildFormat Source Code

public void
(mixed &$router, mixed &$uri)

Create a uri based on a full or partial URL string
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: buildRewrite Source Code

public void
(mixed &$router, mixed &$uri)

Add the basepath to the URI
Parameters
  • \Joomla\CMS\Router\SiteRouter & $router Router object
  • \Joomla\CMS\Uri\Uri & $uri URI object to process
Returns
  • void
Since
  • 4.0.0
Show source code of this method: buildBase Source Code

public \Joomla\CMS\Component\Router\RouterInterface
(mixed $component)

Get component router
Parameters
  • string $component Name of the component including com_ prefix
Returns
  • \Joomla\CMS\Component\Router\RouterInterface Component router
Since
  • 3.3
Show source code of this method: getComponentRouter Source Code

public bool
(mixed $component, mixed $router)

Set a router for a component
Parameters
  • string $component Component name with com_ prefix
  • object $router Component router
Returns
  • bool True if the router was accepted, false if not
Since
  • 3.3
Show source code of this method: setComponentRouter Source Code

Properties Summary

protected array
$componentRouters
Component-router objects
Since
  • 3.3
protected \Joomla\CMS\Application\CMSApplication
$app
Since
  • 3.4
protected \Joomla\CMS\Menu\AbstractMenu
$menu
Current Menu-Object
Since
  • 3.4

Tags Summary

Since
1.5