Référence de la classe SiteRouter

Graphe d'héritage de SiteRouter:

Fonctions membres publiques
	__construct (CMSApplication $app=null, AbstractMenu $menu=null)
	parseCheckSSL (&$router, &$uri)
	parseInit (&$router, &$uri)
	parseFormat (&$router, &$uri)
	parseSefRoute (&$router, &$uri)
	parseRawRoute (&$router, &$uri)
	parsePaginationData (&$router, &$uri)
	buildInit (&$router, &$uri)
	buildComponentPreprocess (&$router, &$uri)
	buildSefRoute (&$router, &$uri)
	buildPaginationData (&$router, &$uri)
	buildFormat (&$router, &$uri)
	buildRewrite (&$router, &$uri)
	buildBase (&$router, &$uri)
	getComponentRouter ($component)
	setComponentRouter ($component, $router)
Fonctions membres publiques hérités de Router
	parse (&$uri, $setVars=false)
	build ($url)
	setVar ($key, $value, $create=true)
	setVars ($vars=array(), $merge=true)
	getVar ($key)
	getVars ()
	attachBuildRule (callable $callback, $stage=self::PROCESS_DURING)
	attachParseRule (callable $callback, $stage=self::PROCESS_DURING)
	detachRule ($type, $rule, $stage=self::PROCESS_DURING)
	getRules ()

Attributs protégés
	$componentRouters = []
	$app
	$menu
Attributs protégés hérités de Router
	$vars = array()
	$rules
	$cache = array()

Membres hérités additionnels
Fonctions membres publiques statiques hérités de Router
static	getInstance ($client, $options=array())
Champs de données hérités de Router
const	PROCESS_BEFORE = 'preprocess'
const	PROCESS_DURING = ''
const	PROCESS_AFTER = 'postprocess'
Fonctions membres protégées hérités de Router
	processParseRules (&$uri, $stage=self::PROCESS_DURING)
	processBuildRules (&$uri, $stage=self::PROCESS_DURING)
	createUri ($url)
Attributs protégés statiques hérités de Router
static	$instances = array()

Description détaillée

Class to create and parse routes for the site application

Depuis

1.5

Documentation des constructeurs et destructeur

__construct()

__construct	(	CMSApplication	$app = null,
		AbstractMenu	$menu = null
	)

Class constructor

Paramètres

CMSApplication	$app	Application Object
AbstractMenu	$menu	Menu object

Depuis

3.4

Références $app, $menu, $this, class, et Factory\getContainer().

Documentation des fonctions membres

buildBase()

buildBase	(	&	$router,
		&	$uri
	)

Add the basepath to the URI

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $uri, et Uri\root().

buildComponentPreprocess()

buildComponentPreprocess	(	&	$router,
		&	$uri
	)

Run the component preprocess method

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $component, $item, $query, et $uri.

buildFormat()

buildFormat	(	&	$router,
		&	$uri
	)

Build the format of the request

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $format, $route, et $uri.

buildInit()

buildInit	(	&	$router,
		&	$uri
	)

Do some initial processing for building a URL

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $item, $itemid, et $uri.

buildPaginationData()

buildPaginationData	(	&	$router,
		&	$uri
	)

Convert limits for pagination

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $uri, et null.

buildRewrite()

buildRewrite	(	&	$router,
		&	$uri
	)

Create a uri based on a full or partial URL string

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $route, et $uri.

buildSefRoute()

buildSefRoute	(	&	$router,
		&	$uri
	)

Build the SEF route

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $component, $item, $parts, $query, $tmp, $uri, et null.

getComponentRouter()

getComponentRouter

(

$component

)

Get component router

Paramètres

string

$component

Name of the component including com_ prefix

Renvoie

RouterInterface Component router

Depuis

3.3

Références $component.

parseCheckSSL()

parseCheckSSL	(	&	$router,
		&	$uri
	)

Force to SSL

Paramètres

Router	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $uri.

parseFormat()

parseFormat	(	&	$router,
		&	$uri
	)

Parse the format of the request

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $route, $suffix, et $uri.

parseInit()

parseInit	(	&	$router,
		&	$uri
	)

Do some initial cleanup before parsing the URL

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

In some environments (e.g. CLI we can't form a valid base URL). In this case we catch the exception thrown by URI and set an empty base URI for further work.

Références $path, $uri, Uri\base(), et JPATH_SITE.

parsePaginationData()

parsePaginationData	(	&	$router,
		&	$uri
	)

Convert limits for pagination

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $start, $uri, et null.

parseRawRoute()

parseRawRoute	(	&	$router,
		&	$uri
	)

Convert a raw route to an internal URI

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $item, et $uri.

parseSefRoute()

parseSefRoute	(	&	$router,
		&	$uri
	)

Convert a sef route to an internal URI

Paramètres

SiteRouter	&$router	Router object
Uri	&$uri	URI object to process

Renvoie

void

Depuis

4.0.0

Références $component, $item, $items, $route, $this, $uri, et null.

setComponentRouter()

setComponentRouter	(		$component,
			$router
	)

Set a router for a component

Paramètres

string	$component	Component name with com_ prefix
object	$router	Component router

Renvoie

boolean True if the router was accepted, false if not

Depuis

3.3

Références $component.

Documentation des champs

$app

$app

protected

$componentRouters

$componentRouters = []

protected

$menu

$menu

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• SiteRouter.php