URL handler and management class

The elxisUri class parses and analyzes the requested URI string. It actually validates and splits the URL into URI segments. The query string (if any) is stored separately.

Most important public methods

detectSSL

Returns true if the page was requested using an SSL/TLS connection or false.

getElxisUri

Returns the Elxis formatted version of the requested URL. You can set if you wish to include also in the returned string the language indentifier and the query string (if any). If, for example, the current URL is: http://www.example.com/documentor/utilities/ then getElxisUri will return: documentor:utilities/

getUriString

Returns the whole URI string.

getUriLang

Returns the current language indentifier in URL. Empty for the site's default language.

getQueryString

Returns the current query string (if any).

getRoute

Returns the URI's first segment (can be empty, file, or directory). Note that it might be different from the current component if a custom route has been set.

getComponent

Returns the requested component.

getSegments

Returns an array of parsed URI segments (without the query string and the language indentifier).

secureURL

Returns the SSL version of a URL only if the $force parameter is true or the current page has been requested via SSL/TLS.

makeURL

Generates a URL from an Elxis formatted URI string.

• $file can be index.php, inner.php, empty (defaults to index.php) or other (very special cases).
• $forcessl can be true or false.
• $xhtml If true, Elxis will convert ampersands (&) to &
• $isadmin True for admin URLs (see shorthad method makeAURL)

Example 1

The above will generate:

https://www.example.com/fr/documentor/test/ if SSL is enabled
or 
http://www.example.com/fr/documentor/test/ if SSL is not enabled

Example 2

The above will generate:

http://www.example.com/documentor/test/ if the site's default language is currently active
or 
http://www.example.com/el/documentor/test/ if the user has switched language to Greek
or 
http://www.example.com/it/documentor/test/ if the user has switched language to Italian
etc...

Note that if the documentor components has been mapped to an other SEO base name the mapped name will return instead of the string documentor.

Example 3: Component documentor is mapped to help.

result:

http://www.example.com/help/test/

Example 4: inner.php or non-SEF

If $file is different than index.php, or SEF is disabled in Elxis configuration, the returned URL will also containg the $file value.

result:

http://www.example.com/inner.php/help/test/

makeAURL

A shortcut of makeURL with $isadmin true by default.

makeSecureURL

A shortcut of makeURL with $forcessl true by default.

makeSecureAURL

A shortcut of makeURL with $forcessl true AND $isadmin true by default.