RulesInterface
RouterRules interface for Joomla
| since |
3.4 |
|---|---|
| package |
Joomla CMS |
Methods
build
Builds URI segments from a query to encode the necessary information for a route in a human-readable URL.
build(mixed||string|int &query, mixed||string|int &segments) :
This method should retrieve all its input from its method arguments.
| since |
3.4 |
|---|
Arguments
- query
array<string|int, mixed>The vars that should be converted- segments
array<string|int, mixed>The URL segments to create
Response
void
parse
Parses a URI to retrieve information for the right route through the component.
parse(mixed||string|int &segments, mixed||string|int &vars) :
This method should retrieve all its input from its method arguments.
| since |
3.4 |
|---|
Arguments
- segments
array<string|int, mixed>The URL segments to parse- vars
array<string|int, mixed>The vars that result from the segments
Response
void
preprocess
Prepares a query set to be handed over to the build() method.
preprocess(mixed||string|int &query) :
This should complete a partial query set to work as a complete non-SEFed URL and in general make sure that all information is present and properly formatted. For example, the Itemid should be retrieved and set here.
| since |
3.4 |
|---|
Arguments
- query
array<string|int, mixed>The query array to process
Response
void