RouterInterface

Component routing interface

since

3.3

package

Application

Methods

build

Build method for URLs This method is meant to transform the query parameters into a more human readable form. It is only executed when SEF mode is switched on.

build(array &query) : array
since

3.3

Arguments

query

arrayAn array of URL arguments

Response

arrayThe URL arguments to use to assemble the subsequent URL.

parse

Parse method for URLs This method is meant to transform the human readable URL back into query parameters. It is only executed when SEF mode is switched on.

parse(array &segments) : array
since

3.3

Arguments

segments

arrayThe segments of the URL to parse.

Response

arrayThe URL attributes to be used by the application.

preprocess

Prepare-method for URLs This method is meant to validate and complete the URL parameters.

preprocess(array query) : array

For example it can add the Itemid or set a language parameter. This method is executed on each URL, regardless of SEF mode switched on or not.

since

3.3

Arguments

query

arrayAn associative array of URL arguments

Response

arrayThe URL arguments to use to assemble the subsequent URL.