Class JUri

JUri Class

This class serves two purposes. First it parses a URI and provides a common interface for the Joomla Platform to access and manipulate a URI. Second it obtains the URI of the current executing script from the server regardless of server.

Joomla\Uri\AbstractUri implements Joomla\Uri\UriInterface

Joomla\Uri\Uri

JUri

Package: Joomla\Platform\Uri
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/uri/uri.php

Methods summary

`public static JUri`	# `getInstance( string $uri = 'SERVER' )` Returns the global JUri object, only creating it if it doesn't already exist. Returns the global JUri object, only creating it if it doesn't already exist. Parameters `$uri` `string` - $uri The URI to parse. [optional: if null uses script URI] Returns `JUri` - The URI object. Since 11.1
`public static string`	# `base( boolean $pathonly = false )` Returns the base URI for the request. Returns the base URI for the request. Parameters `$pathonly` `boolean` - $pathonly If false, prepend the scheme, host and port information. Default is false. Returns `string` - The base URI string Since 11.1
`public static string`	# `root( boolean $pathonly = false, string $path = null )` Returns the root URI for the request. Returns the root URI for the request. Parameters `$pathonly` `boolean` - $pathonly If false, prepend the scheme, host and port information. Default is false. `$path` `string` - $path The path Returns `string` - The root URI string. Since 11.1
`public static string`	# `current( )` Returns the URL for the request, minus the query. Returns the URL for the request, minus the query. Returns `string` Since 11.1
`public static`	# `reset( )` Method to reset class static members for testing and other various issues. Method to reset class static members for testing and other various issues. Since 11.1
`public`	# `setPath( string $path )` Set the URI path string. Note we keep this method here so it uses the old _cleanPath function Set the URI path string. Note we keep this method here so it uses the old _cleanPath function Deprecated 4.0 Use `Joomla\Uri\Uri::setPath()` Parameters `$path` `string` - $path The URI path string. Since 11.1 Note Present to proxy calls to the deprecated `JUri::_cleanPath()` method. Overrides `Joomla\Uri\Uri::setPath`
`public static boolean`	# `isInternal( string $url )` Checks if the supplied URL is internal Checks if the supplied URL is internal Parameters `$url` `string` - $url The URL to check. Returns `boolean` - True if Internal. Since 11.1
`public static string`	# `buildQuery( array $params )` Build a query from an array (reverse of the PHP parse_str()). Build a query from an array (reverse of the PHP parse_str()). Parameters `$params` `array` - $params The array of key => value pairs to return as a query string. Returns `string` - The resulting query string. Since 11.1 See parse_str() Note The parent method is protected, this exposes it as public for B/C Overrides `Joomla\Uri\AbstractUri::buildQuery`
`public boolean`	# `parse( string $uri )` Parse a given URI and populate the class fields. Parse a given URI and populate the class fields. Parameters `$uri` `string` - $uri The URI string to parse. Returns `boolean` - True on success. Since 11.1 Note The parent method is protected, this exposes it as public for B/C Overrides `Joomla\Uri\AbstractUri::parse`
`protected string`	# `_cleanPath( string $path )` Resolves //, ../ and ./ from a path and returns the result. Eg: Resolves //, ../ and ./ from a path and returns the result. Eg: /foo/bar/../boo.php => /foo/boo.php /foo/bar/../../boo.php => /boo.php /foo/bar/.././/boo.php => /foo/boo.php Deprecated 4.0 Use `Joomla\Uri\AbstractUri::cleanPath()` instead Parameters `$path` `string` - $path The URI path to clean. Returns `string` - Cleaned and resolved URI path. Since 11.1

Methods inherited from Joomla\Uri\Uri

delVar(), setFragment(), setHost(), setPass(), setPort(), setQuery(), setScheme(), setUser(), setVar()

Methods inherited from Joomla\Uri\AbstractUri

__construct(), __toString(), cleanPath(), getFragment(), getHost(), getPass(), getPath(), getPort(), getQuery(), getScheme(), getUser(), getVar(), hasVar(), isSSL(), toString()

Magic methods summary

Properties summary

`protected static JUri[]`	`$instances`	# An array of JUri instances. An array of JUri instances. Since 11.1
`protected static array`	`$base`	# The current calculated base url segments. The current calculated base url segments. Since 11.1
`protected static array`	`$root`	# The current calculated root url segments. The current calculated root url segments. Since 11.1
`protected static string`	`$current`	# The current url. The current url. Since 11.1

Properties inherited from Joomla\Uri\AbstractUri

$fragment, $host, $pass, $path, $port, $query, $scheme, $uri, $user, $vars

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JUri

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Since

Deprecated

Parameters

Since

Note

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

See

Note

Overrides

Parameters

Returns

Since

Note

Overrides

Deprecated

Parameters

Returns

Since

Methods inherited from Joomla\Uri\Uri

Methods inherited from Joomla\Uri\AbstractUri

Magic methods summary

Properties summary

Since

Since

Since

Since

Properties inherited from Joomla\Uri\AbstractUri