PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of Route.php

Joomla! Content Management System

Copyright:	(C) 2012 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	187 lines (7 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Route:: (2 methods):
_()
link()

Class: Route - X-Ref

Route handling class

_($url, $xhtml = true, $tls = self::TLS_IGNORE, $absolute = false) X-Ref

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

param: string   $url       Absolute or Relative URI to Joomla resource.
param: boolean  $xhtml     Replace & by & for XML compliance.
param: integer  $tls       Secure state for the resolved URI. Use Route::TLS_* constants
param: boolean  $absolute  Return an absolute URL
return: string  The translated humanly readable URL.

link($client, $url, $xhtml = true, $tls = self::TLS_IGNORE, $absolute = false) X-Ref

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 <var>Route::_()</var>

param: string   $client    The client name for which to build the link.
param: string   $url       Absolute or Relative URI to Joomla resource.
param: boolean  $xhtml     Replace & by & for XML compliance.
param: integer  $tls       Secure state for the resolved URI. Use Route::TLS_* constants
param: boolean  $absolute  Return an absolute URL
return: string  The translated humanly readable URL.

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Router/ -> Route.php (summary)

Defines 1 class