Route

Route handling class

since

1.7.0

package

Application

Methods

_

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

_(string url, bool xhtml = true, int tls = self::TLS_IGNORE, bool absolute = false) : string
static
since

1.7.0

Arguments

url

stringAbsolute or Relative URI to Joomla resource.

xhtml

boolReplace & by & for XML compliance.

tls

intSecure state for the resolved URI. Use Route::TLS_* constants 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.

absolute

boolReturn an absolute URL

Response

stringThe translated humanly readable URL.

Constants

TLS_IGNORE

No change, use the protocol currently used.

Value 0
since

3.9.7

TLS_FORCE

Make URI secure using http over TLS (https).

Value 1
since

3.9.7

TLS_DISABLE

Make URI unsecure using plain http (http).

Value 2
since

3.9.7

Properties

_router

The route object so we don't have to keep fetching it.

static
since

3.0.1

Type(s)

Router[]