Difference between revisions of "JRoute"
From Joomla! Documentation
m (→User contributed notes: bad link repair) |
m (preparing for archive only) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JRoute== | =={{JVer|11.1}} JRoute== | ||
===Description=== | ===Description=== | ||
| − | + | ||
| − | + | ||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 14: | Line 12: | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JRoute::_ | + | |[[API17:JRoute::_|_]] |
|Translates an internal Joomla URL to a humanly readible URL. | |Translates an internal Joomla URL to a humanly readible URL. | ||
|- | |- | ||
| Line 23: | Line 21: | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JRoute source code''' on [[jplatform:methods.php|BitBucket]] | * {{JVer|11.1}} '''JRoute source code''' on [[jplatform:methods.php|BitBucket]] | ||
| − | * [[JRoute|Other versions of JRoute]] | + | * [[API17:JRoute|Other versions of JRoute]] |
| − | + | ||
| − | + | ||
| − | |||
| − | |||
===User contributed notes=== | ===User contributed notes=== | ||
| − | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JRoute | category=JRoute | ||
| − | + | namespace=CodeExample | |
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| Line 39: | Line 35: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude> | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Suggest the following as a more useful entry: | Suggest the following as a more useful entry: | ||
Latest revision as of 22:36, 24 March 2017
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JRoute[edit]
Description[edit]
Methods[edit]
| Visibility | Method name | Description |
|---|---|---|
| public static | _ | Translates an internal Joomla URL to a humanly readible URL. |
- Defined in libraries/joomla/methods.php
Importing[edit]
jimport( 'joomla.methods' );See also[edit]
- JRoute source code on BitBucket
- Other versions of JRoute
User contributed notes[edit]
Code Examples[edit]
Suggest the following as a more useful entry: This is largely taken from the API pages.
Translates an internal Joomla URL to a humanly readible URL.
return: translated humanly readible URL. since: 11.1 access: public
The _ (string $url, [boolean $xhtml = true], [integer $ssl = null])
string $url: Absolute or Relative URI to Joomla resource. boolean $xhtml: Replace & with & for XML compilance. integer $ssl: Secure state for the resolved URI. 1: Make URI secure using global secure site URI. 0: Leave URI in the same secure state as it was passed to the function. -1: Make URI unsecure using the global unsecure site URI.
Example - create a human-readable link to the login page without replacing ampersands (&):
JRoute::_('index.php?option=com_users&view=login', false);