JURI/toString

Latest revision as of 12:43, 9 August 2012

Returns a string representation of the URI object. By default the full URI is string is returned, but which parts of the URI are to be returned can be customised with an argument. Note that if the URI is to be output to the user then it should be passed through the JRoute::_ static method first as this will ensure that it is SEF encoded. Note also that the query part separator is "&" rather than "&" and so you will need to pass the output through htmlspecialchars to produce an XHTML-compliant URI.

[edit] Syntax

string toString( $parts )

where:

The parts are as follows:

[edit] Example 1

In this example, a URI object is output as a full URI string.

$uri = 'http://fredbloggs:itsasecret@www.example.com:8080/path/to/Joomla/index.php?task=view&id=32#anchorthis';
$u =& JURI::getInstance( $uri );
echo 'URI is ' . $u->toString();

would output

URI is http://fredbloggs:itsasecret@www.example.com:8080/path/to/Joomla/index.php?task=view&id=32#anchorthis

[edit] Example 2

In this example, only the scheme, host and path are included.

$uri = 'http://fredbloggs:itsasecret@www.example.com:8080/path/to/Joomla/index.php?task=view&id=32#anchorthis';
$u =& JURI::getInstance( $uri );
echo 'URI is ' . $u->toString( array( 'scheme', 'host', 'path' ) );

would output

URI is http://www.example.com/path/to/Joomla/index.php

[edit] Example 3

To produce an XHTML-compliant URI you need to pass the output through htmlspecialchars, like this:

$u =& JURI::getInstance( $uri );
echo 'XHTML-compliant URI is ' . htmlspecialchars( $u->toString() );

[edit] See also

• JURI->toString on api.joomla.org
• JRoute::_