Difference between revisions of "JRoute"

Latest revision as of 22:36, 24 March 2017

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JRoute[edit]

Description[edit]

Methods[edit]

Visibility	Method name	Description
public static	_	Translates an internal Joomla URL to a humanly readible URL.

Defined in libraries/joomla/methods.php

Importing[edit]

jimport( 'joomla.methods' );

User contributed notes[edit]

Code Examples[edit]

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

@@ Line 1: / Line 1: @@
 __NOTOC__
-<span class="editsection" style="font-size:76%;">
+=={{JVer|11.1}} JRoute==
-<nowiki>[</nowiki>[[Description:JRoute|Edit Descripton]]<nowiki>]</nowiki>
+===Description===
-</span>
-{{Description:JRoute}}
-===Defined in===
-libraries/joomla/methods.php
-===Subpackage===
-===Extends===
-===Extended by===
 ===Methods===
 {| class="wikitable sortable"
 |-
+!Visibility
 !Method name
 !Description
 |-
-|[[JRoute::_/11.1|_]]
+|public static
+|[[API17:JRoute::_|_]]
 |Translates an internal Joomla URL to a humanly readible URL.
 |-
 |}
+* '''Defined in''' libraries/joomla/methods.php
 ===Importing===
 <source lang="php">jimport( 'joomla.methods' );</source>
 ===See also===
-* [[JRoute|Other versions of this class]]
+* {{JVer|11.1}} '''JRoute source code''' on [[jplatform:methods.php|BitBucket]]
-{{SeeAlso:JRoute}}
+* [[API17:JRoute|Other versions of JRoute]]
-<span class="editsection" style="font-size:76%;">
-<nowiki>[</nowiki>[[SeeAlso:JRoute|Edit See Also]]<nowiki>]</nowiki>
-</span>
+===User contributed notes===
-===Examples===
+=== Code Examples ===
-<CodeExamplesForm />
 <dpl>
 noresultsheader=\n
 category=JRoute
-category=CodeExample
+namespace=CodeExample
 category=ClassExample
 include=*
+namespace=CodeExample
 format= ,,,
 </dpl>
-<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JRoute]]</noinclude>
+<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</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);

API17