[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Router/ -> SiteRouter.php (summary)

Joomla! Content Management System

Copyright: (C) 2007 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 598 lines (18 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SiteRouter:: (16 methods):
  __construct()
  parseCheckSSL()
  parseInit()
  parseFormat()
  parseSefRoute()
  parseRawRoute()
  parsePaginationData()
  buildInit()
  buildComponentPreprocess()
  buildSefRoute()
  buildPaginationData()
  buildFormat()
  buildRewrite()
  buildBase()
  getComponentRouter()
  setComponentRouter()


Class: SiteRouter  - X-Ref

Class to create and parse routes for the site application

__construct(CMSApplication $app = null, AbstractMenu $menu = null)   X-Ref
Class constructor

param: CMSApplication  $app   Application Object
param: AbstractMenu    $menu  Menu object

parseCheckSSL(&$router, &$uri)   X-Ref
Force to SSL

param: Router  &$router  Router object
param: Uri     &$uri     URI object to process
return: void

parseInit(&$router, &$uri)   X-Ref
Do some initial cleanup before parsing the URL

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

parseFormat(&$router, &$uri)   X-Ref
Parse the format of the request

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

parseSefRoute(&$router, &$uri)   X-Ref
Convert a sef route to an internal URI

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

parseRawRoute(&$router, &$uri)   X-Ref
Convert a raw route to an internal URI

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

parsePaginationData(&$router, &$uri)   X-Ref
Convert limits for pagination

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

buildInit(&$router, &$uri)   X-Ref
Do some initial processing for building a URL

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

buildComponentPreprocess(&$router, &$uri)   X-Ref
Run the component preprocess method

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

buildSefRoute(&$router, &$uri)   X-Ref
Build the SEF route

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

buildPaginationData(&$router, &$uri)   X-Ref
Convert limits for pagination

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

buildFormat(&$router, &$uri)   X-Ref
Build the format of the request

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

buildRewrite(&$router, &$uri)   X-Ref
Create a uri based on a full or partial URL string

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

buildBase(&$router, &$uri)   X-Ref
Add the basepath to the URI

param: SiteRouter  &$router  Router object
param: Uri         &$uri     URI object to process
return: void

getComponentRouter($component)   X-Ref
Get component router

param: string  $component  Name of the component including com_ prefix
return: RouterInterface  Component router

setComponentRouter($component, $router)   X-Ref
Set a router for a component

param: string  $component  Component name with com_ prefix
param: object  $router     Component router
return: boolean  True if the router was accepted, false if not



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer