Actions

API17

Difference between revisions of "JRoute"

From Joomla! Documentation

(Updated to r1448:247ba8d88526)
m (User contributed notes: bad link repair)
(One intermediate revision by one user not shown)
Line 39: Line 39:
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JRoute]]</noinclude>
+
<noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JRoute]]</noinclude>
 +
 
 +
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);

Revision as of 14:01, 29 August 2012

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JRoute

Description

Description:JRoute [Edit Descripton]

Methods

Visibility Method name Description
public static _ Translates an internal Joomla URL to a humanly readible URL.
  • Defined in libraries/joomla/methods.php

Importing

jimport( 'joomla.methods' );

See also

SeeAlso:JRoute [Edit See Also]

User contributed notes

<CodeExamplesForm />


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);