Actions

API17

Difference between revisions of "JRoute"

From Joomla! Documentation

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

Latest revision as of 21:25, 11 May 2013

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

  • Joomla 11.1 JRoute source code on BitBucket
  • Other versions of JRoute

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