1. class
  2. Joomla
  3. CMS
  4. Router
  5. Route

Route

class Route

Route handling class

Methods

static  string
_( string $url, boolean $xhtml = true, integer $ssl = null)

Translates an internal Joomla URL to a humanly readable URL. This method builds links for the current active client.

static  string
link( string $client, string $url, boolean $xhtml = true, integer $ssl = null)

Translates an internal Joomla URL to a humanly readable URL.

Details

static string _( string $url, boolean $xhtml = true, integer $ssl = null)

Translates an internal Joomla URL to a humanly readable URL. This method builds links for the current active client.

Parameters

string $url Absolute or Relative URI to Joomla resource.
boolean $xhtml Replace & by & for XML compliance.
integer $ssl Secure state for the resolved URI. 0: (default) No change, use the protocol currently used in the request 1: Make URI secure using global secure site URI. 2: Make URI unsecure using the global unsecure site URI.

Return Value

string The translated humanly readable URL.

Translates an internal Joomla URL to a humanly readable URL.

NOTE: To build link for active client instead of a specific client, you can use JRoute::_()

Parameters

string $client The client name for which to build the link.
string $url Absolute or Relative URI to Joomla resource.
boolean $xhtml Replace & by & for XML compliance.
integer $ssl Secure state for the resolved URI. 0: (default) No change, use the protocol currently used in the request 1: Make URI secure using global secure site URI. 2: Make URI unsecure using the global unsecure site URI.

Return Value

string The translated humanly readable URL.

Exceptions

RuntimeException