SiteRouter
Extends RouterClass to create and parse routes for the site application
since |
1.5 |
---|---|
package |
Joomla CMS |
Methods
__construct
Class constructor
__construct(\Joomla\CMS\Application\CMSApplication app = null, \Joomla\CMS\Menu\AbstractMenu menu = null) :
since |
3.4 |
---|
Arguments
- app
CMSApplication
Application Object- menu
AbstractMenu
Menu object
Response
mixed
attachBuildRule
Attach a build rule
attachBuildRule( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array callback, stage = self::PROCESS_DURING) :
since |
1.5 |
---|
Arguments
- callback
callable
The function to be called- stage
string
The stage of the build process that this should be added to. Possible values: 'preprocess', '' for the main build process, 'postprocess'
Response
void
attachParseRule
Attach a parse rule
attachParseRule( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array callback, stage = self::PROCESS_DURING) :
since |
1.5 |
---|
Arguments
- callback
callable
The function to be called.- stage
string
The stage of the parse process that this should be added to. Possible values: 'preprocess', '' for the main parse process, 'postprocess'
Response
void
build
Function to convert an internal URI to a route
build(string|array|\Joomla\CMS\Uri\Uri url) : \Joomla\CMS\Uri\Uri
buildBase
Add the basepath to the URI
buildBase(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
buildComponentPreprocess
Run the component preprocess method
buildComponentPreprocess(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
buildFormat
Build the format of the request
buildFormat(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
buildInit
Do some initial processing for building a URL
buildInit(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
buildPaginationData
Convert limits for pagination
buildPaginationData(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
buildRewrite
Create a uri based on a full or partial URL string
buildRewrite(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
buildSefRoute
Build the SEF route
buildSefRoute(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
createUri
Create a uri based on a full or partial URL string
createUri( url) : \Joomla\CMS\Uri\Uri
detachRule
Remove a rule
detachRule( type, Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array rule, stage = self::PROCESS_DURING) :
since |
4.0.0 |
---|---|
throws |
|
Arguments
- type
string
Type of rule to remove (parse or build)- rule
callable
The rule to be removed.- stage
string
The stage of the parse process that this should be added to. Possible values: 'preprocess', '' for the main parse process, 'postprocess'
Response
bool
Was a rule removed?
getComponentRouter
Get component router
getComponentRouter( component) : \Joomla\CMS\Component\Router\RouterInterface
since |
3.3 |
---|
Arguments
- component
string
Name of the component including com_ prefix
Response
RouterInterface
Component router
getInstance
Returns the global Router object, only creating it if it doesn't already exist.
getInstance( client, mixed||string|int options = []) : \Joomla\CMS\Router\Router
since |
1.5 |
---|---|
throws |
|
deprecated |
4.0 will be removed in 6.0 Inject the router or load it from the dependency injection container Example: Factory::getContainer()->get(SiteRouter::class); |
Arguments
- client
string
The name of the client- options
array<string|int, mixed>
An associative array of options
Response
Router
A Router object.
getRules
Get all currently attached rules
getRules() : mixed||string|int
since |
4.0.0 |
---|
Response
array<string|int, mixed>
All currently attached rules in an array
getVar
Get a router variable
getVar( key) :
since |
1.5 |
---|
Arguments
- key
string
The name of the variable
Response
mixed
Value of the variable
getVars
Get the router variable array
getVars() : mixed||string|int
since |
1.5 |
---|
Response
array<string|int, mixed>
An associative array of router variables
parse
Function to convert a route to an internal URI
parse(\Joomla\CMS\Uri\Uri &uri, setVars = false) : mixed||string|int
since |
1.5 |
---|---|
throws |
|
Arguments
- uri
Uri
The uri.- setVars
bool
Set the parsed data in the internal storage for current-request-URLs
Response
array<string|int, mixed>
parseCheckSSL
Force to SSL
parseCheckSSL(\Joomla\CMS\Router\Router &router, \Joomla\CMS\Uri\Uri &uri) :
parseFormat
Parse the format of the request
parseFormat(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
parseInit
Do some initial cleanup before parsing the URL
parseInit(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
parsePaginationData
Convert limits for pagination
parsePaginationData(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
parseRawRoute
Convert a raw route to an internal URI
parseRawRoute(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
parseSefRoute
Convert a sef route to an internal URI
parseSefRoute(\Joomla\CMS\Router\SiteRouter &router, \Joomla\CMS\Uri\Uri &uri) :
processBuildRules
Process the build uri query data based on custom defined rules
processBuildRules(\Joomla\CMS\Uri\Uri &uri, stage = self::PROCESS_DURING) :
since |
3.2 |
---|
Arguments
- uri
Uri
The URI- stage
string
The stage that should be processed. Possible values: 'preprocess', 'postprocess' and '' for the main build stage
Response
void
processParseRules
Process the parsed router variables based on custom defined rules
processParseRules(\Joomla\CMS\Uri\Uri &uri, stage = self::PROCESS_DURING) :
since |
3.2 |
---|
Arguments
- uri
Uri
The URI to parse- stage
string
The stage that should be processed. Possible values: 'preprocess', 'postprocess' and '' for the main parse stage
Response
void
setComponentRouter
Set a router for a component
setComponentRouter( component, router) :
since |
3.3 |
---|
Arguments
- component
string
Component name with com_ prefix- router
object
Component router
Response
bool
True if the router was accepted, false if not
setVar
Set a router variable, creating it if it doesn't exist
setVar( key, value, create = true) :
since |
1.5 |
---|
Arguments
- key
string
The name of the variable- value
mixed
The value of the variable- create
bool
If True, the variable will be created if it doesn't exist yet
Response
void
setVars
Set the router variable array
setVars(mixed||string|int vars = [], merge = true) :
since |
1.5 |
---|
Arguments
- vars
array<string|int, mixed>
An associative array with variables- merge
bool
If True, the array will be merged instead of overwritten
Response
void
Constants
PROCESS_BEFORE
Mask for the before process stage
Value | 'preprocess' |
---|---|
since |
3.4 |
Type(s)
string
PROCESS_DURING
Mask for the during process stage
Value | '' |
---|---|
since |
3.4 |
Type(s)
string
PROCESS_AFTER
Mask for the after process stage
Value | 'postprocess' |
---|---|
since |
3.4 |
Type(s)
string
Properties
vars
An array of variables
since |
1.5 |
---|
Type(s)
array<string|int, mixed>
rules
An array of rules
since |
1.5 |
---|
Type(s)
array<string|int, mixed>
cache
Caching of processed URIs
since |
3.3 |
---|
Type(s)
array<string|int, mixed>
componentRouters
Component-router objects
since |
3.3 |
---|
Type(s)
array<string|int, mixed>