JURI/root - Revision history

Munto: Edit api.joomla.org link

2012-12-21T17:35:31Z

Edit api.joomla.org link

JoomlaWikiBot: /* See also */re-categorisation

2012-08-09T16:35:28Z

‎See also: re-categorisation

Tgryffyn at 16:52, 14 October 2009

2009-10-14T16:52:35Z

Chris Davenport: New page: A static method that returns the root URI of the Joomla site. If Joomla has been installed in the web server's document root then this method will return "/" for the path. ===Syntax=== st...

2008-09-17T10:35:27Z

New page: A static method that returns the root URI of the Joomla site. If Joomla has been installed in the web server's document root then this method will return "/" for the path. ===Syntax=== st...

New page

A static method that returns the root URI of the Joomla site. If Joomla has been installed in the web server's document root then this method will return "/" for the path.
===Syntax===
string base( $pathonly, $path )

where:
{| class="wikitable"
!Argument
!Data type
!Description
!Default
|-
|$pathonly
|boolean
|If '''true''' then only the path to the Joomla site is returned; otherwise the scheme, host and port are prepended to the path. Note that when '''true''' the URI returned has a trailing "/", but when '''false''' the trailing "/" is omitted.
|'''false'''
|-
|$path
|string
|Path to override the actual path. Since this is held statically it will affect all subsequent calls to this method.
|
|}

===Example===
In this example, the Joomla root URI is shown with both values of the $pathonly argument. A new path is also applied and it should be noted that it affects subsequent calls to this method.
<source lang="php">
echo 'Joomla root URI is ' . JURI::root() . "\n";
echo 'Joomla root URI (path only) is ' . JURI::root( true ) . "\n";
echo 'Joomla root URI (path specified) is ' . JURI::root( false, '/a-different-path' ) . "\n";
echo 'Joomla root URI (path only) (path specified) is ' . JURI::root( true, '/a-different-path' ) . "\n";
echo "\n";
echo 'Joomla root URI is ' . JURI::root() . "\n";
echo 'Joomla root URI (path only) is ' . JURI::root( true ) . "\n";
</source>
might output
Joomla root URI is http://localhost/joomla15svn10812/
Joomla root URI (path only) is /joomla15svn10812
Joomla root URI (path specified) is http://localhost/a-different-path/
Joomla root URI (path only) (path specified) is /a-different-path

Joomla root URI is http://localhost/a-different-path/
Joomla root URI (path only) is /a-different-path
===See also===
* [http://api.joomla.org/Joomla-Framework/Environment/JURI.html#root JURI::root on api.joomla.org]
* [[JURI/base|JURI::base]]
* [[JURI/current|JURI::current]]
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JURI]]</noinclude>

@@ Line 41: / Line 41: @@
   Joomla root URI (path only) is /a-different-path
 ===See also===
-* [http://api.joomla.org/Joomla-Framework/Environment/JURI.html#root JURI::root on api.joomla.org]
+* [http://api.joomla.org/1.5/Joomla-Framework/Environment/JURI.html#root JURI::root on api.joomla.org]
 * [[JURI/base|JURI::base]]
 * [[JURI/current|JURI::current]]
 <noinclude>[[Category:JURI]]</noinclude>

@@ Line 1: / Line 1: @@
 A static method that returns the root URI of the Joomla site.  If Joomla has been installed in the web server's document root then this method will return "/" for the path.
 ===Syntax===
-string base( $pathonly, $path )
+string root( $pathonly, $path )
 where: