Référence de la classe Route

Graphe d'héritage de Route:

Fonctions membres publiques
	__construct (array $methods, string $pattern, $controller, array $rules=[], array $defaults=[])
	getController ()
	getDefaults ()
	getMethods ()
	getPattern ()
	getRegex ()
	getRouteVariables ()
	getRules ()
	setController ($controller)
	setDefaults (array $defaults)
	setMethods (array $methods)
	setPattern (string $pattern)
	setRegex (string $regex)
	setRouteVariables (array $routeVariables)
	setRules (array $rules)
	serialize ()
	__serialize ()
	unserialize ($serialized)
	__unserialize (array $data)

Fonctions membres protégées
	buildRegexAndVarList ()

Attributs privés
	$controller
	$defaults = []
	$methods
	$pattern
	$regex
	$routeVariables = []
	$rules = []

Description détaillée

An object representing a route definition.

Depuis

2.0.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	array	$methods,
		string	$pattern,
			$controller,
		array	$rules = [],
		array	$defaults = []
	)

Constructor.

Paramètres

array	$methods	The HTTP methods this route supports
string	$pattern	The route pattern to use for matching
mixed	$controller	The controller which handles this route
array	$rules	An array of regex rules keyed using the route variables
array	$defaults	The default variables defined by the route

Depuis

2.0.0

Références Route\$controller, Route\$defaults, Route\$rules, Route\setController(), Route\setDefaults(), Route\setMethods(), Route\setPattern(), et Route\setRules().

Documentation des fonctions membres

__serialize()

__serialize

(

)

Serialize the route.

Renvoie

array The data to be serialized

Depuis

2.0.0

Références Route\$controller, class, Route\getController(), Route\getDefaults(), Route\getMethods(), Route\getPattern(), Route\getRegex(), Route\getRouteVariables(), et Route\getRules().

Référencé par Route\serialize().

__unserialize()

__unserialize

(

array

$data

)

Unserialize the route.

Paramètres

array

$data

The serialized route.

Renvoie

void

Depuis

2.0.0

Références $data.

Référencé par Route\unserialize().

buildRegexAndVarList()

buildRegexAndVarList ( )

protected

Parse the route's pattern to extract the named variables and build a proper regular expression for use when parsing the routes.

Renvoie

void

Depuis

2.0.0

Références Route\$pattern, Route\$regex, elseif, Route\getPattern(), Route\getRules(), Route\setRegex(), et Route\setRouteVariables().

Référencé par Route\getRegex(), et Route\getRouteVariables().

getController()

getController

(

)

Retrieve the controller which handles this route

Renvoie

mixed

Depuis

2.0.0

Références Route\$controller.

Référencé par Route\__serialize().

getDefaults()

getDefaults

(

)

Retrieve the default variables defined by the route

Renvoie

array

Depuis

2.0.0

Références Route\$defaults.

Référencé par Route\__serialize().

getMethods()

getMethods

(

)

Retrieve the HTTP methods this route supports

Renvoie

string[]

Depuis

2.0.0

Références Route\$methods.

Référencé par Route\__serialize().

getPattern()

getPattern

(

)

Retrieve the route pattern to use for matching

Renvoie

string

Depuis

2.0.0

Références Route\$pattern.

Référencé par Route\__serialize(), et Route\buildRegexAndVarList().

getRegex()

getRegex

(

)

Retrieve the path regex this route processes

Renvoie

string

Depuis

2.0.0

Références Route\$regex, et Route\buildRegexAndVarList().

Référencé par Route\__serialize().

getRouteVariables()

getRouteVariables

(

)

Retrieve the variables defined by the route

Renvoie

array

Depuis

2.0.0

Références Route\$routeVariables, et Route\buildRegexAndVarList().

Référencé par Route\__serialize().

getRules()

getRules

(

)

Retrieve the regex rules keyed using the route variables

Renvoie

array

Depuis

2.0.0

Références Route\$rules.

Référencé par Route\__serialize(), et Route\buildRegexAndVarList().

serialize()

serialize

(

)

Serialize the route.

Renvoie

string The serialized route.

Depuis

2.0.0

Références Route\__serialize().

setController()

setController

(

$controller

)

Set the controller which handles this route

Paramètres

mixed

$controller

The controller which handles this route

Renvoie

$this

Depuis

2.0.0

Références Route\$controller, et $this.

Référencé par Route\__construct().

setDefaults()

setDefaults

(

array

$defaults

)

Set the default variables defined by the route

Paramètres

array

$defaults

The default variables defined by the route

Renvoie

$this

Depuis

2.0.0

Références Route\$defaults, et $this.

Référencé par Route\__construct().

setMethods()

setMethods

(

array

$methods

)

Set the HTTP methods this route supports

Paramètres

array

$methods

The HTTP methods this route supports

Renvoie

$this

Depuis

2.0.0

Références Route\$methods, et $this.

Référencé par Route\__construct().

setPattern()

setPattern

(

string

$pattern

)

Set the route pattern to use for matching

Paramètres

string

$pattern

The route pattern to use for matching

Renvoie

$this

Depuis

2.0.0

Références Route\$pattern, $this, Route\setRegex(), et Route\setRouteVariables().

Référencé par Route\__construct().

setRegex()

setRegex

(

string

$regex

)

Set the path regex this route processes

Paramètres

string

$regex

The path regex this route processes

Renvoie

$this

Depuis

2.0.0

Références Route\$regex, et $this.

Référencé par Route\buildRegexAndVarList(), et Route\setPattern().

setRouteVariables()

setRouteVariables

(

array

$routeVariables

)

Set the variables defined by the route

Paramètres

array

$routeVariables

The variables defined by the route

Renvoie

$this

Depuis

2.0.0

Références Route\$routeVariables, et $this.

Référencé par Route\buildRegexAndVarList(), et Route\setPattern().

setRules()

setRules

(

array

$rules

)

Set the regex rules keyed using the route variables

Paramètres

array

$rules

The rules defined by the route

Renvoie

$this

Depuis

2.0.0

Références Route\$rules, et $this.

Référencé par Route\__construct().

unserialize()

unserialize

(

$serialized

)

Unserialize the route.

Paramètres

string

$serialized

The serialized route.

Renvoie

void

Depuis

1.0

Références Route\__unserialize().

Documentation des champs

$controller

$controller

private

Référencé par Route\__construct(), Route\__serialize(), Route\getController(), et Route\setController().

$defaults

$defaults = []

private

Référencé par Route\__construct(), Route\getDefaults(), et Route\setDefaults().

$methods

$methods

private

Référencé par Route\getMethods(), et Route\setMethods().

$pattern

$pattern

private

Référencé par Route\buildRegexAndVarList(), Route\getPattern(), et Route\setPattern().

$regex

$regex

private

Référencé par Route\buildRegexAndVarList(), Route\getRegex(), et Route\setRegex().

$routeVariables

$routeVariables = []

private

Référencé par Route\getRouteVariables(), et Route\setRouteVariables().

$rules

$rules = []

private

Référencé par Route\__construct(), Route\getRules(), et Route\setRules().

---

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

• vendor/joomla/router/src/Route.php