AbstractUri
Implements UriInterfaceUri Class
Abstract base for out uri classes.
This class should be considered an implementation detail. Typehint against UriInterface.
| since |
1.0 |
|---|---|
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(string uri = null) : mixed
You can pass a URI string to the constructor to initialise a specific URI.
| since |
1.0 |
|---|
Arguments
- uri
stringThe optional URI string
Response
mixed
__toString
Magic method to get the string representation of the URI object.
__toString() : string
| since |
1.0 |
|---|
Response
string
buildQuery
Build a query from an array (reverse of the PHP parse_str()).
buildQuery(array params) : string
| see | parse_str() |
|---|---|
| since |
1.0 |
Arguments
- params
arrayThe array of key => value pairs to return as a query string.
Response
stringThe resulting query string.
cleanPath
Resolves //, ../ and ./ from a path and returns the result. Eg:
cleanPath(string path) : string
/foo/bar/../boo.php => /foo/boo.php /foo/bar/../../boo.php => /boo.php /foo/bar/.././/boo.php => /foo/boo.php
| since |
1.0 |
|---|
Arguments
- path
stringThe URI path to clean.
Response
stringCleaned and resolved URI path.
getFragment
Get the URI anchor string Everything after the "#".
getFragment() : string
| since |
1.0 |
|---|
Response
stringThe URI anchor string.
getHost
Get URI host Returns the hostname/ip or null if no hostname/ip was specified.
getHost() : string
| since |
1.0 |
|---|
Response
stringThe URI host.
getPass
Get URI password Returns the password, or null if no password was specified.
getPass() : string
| since |
1.0 |
|---|
Response
stringThe URI password.
getPath
Gets the URI path string.
getPath() : string
| since |
1.0 |
|---|
Response
stringThe URI path string.
getPort
Get URI port Returns the port number, or null if no port was specified.
getPort() : int
| since |
1.0 |
|---|
Response
intThe URI port number.
getQuery
Returns flat query string.
getQuery(bool toArray = false) : string|array
| since |
1.0 |
|---|
Arguments
- toArray
boolTrue to return the query as a key => value pair array.
Response
string|arrayQuery string or Array of parts in query string depending on the function param
getScheme
Get URI scheme (protocol) ie. http, https, ftp, etc.
getScheme() : string
..
| since |
1.0 |
|---|
Response
stringThe URI scheme.
getUser
Get URI username Returns the username, or null if no username was specified.
getUser() : string
| since |
1.0 |
|---|
Response
stringThe URI username.
getVar
Returns a query variable by name.
getVar(string name, string default = null) : mixed
| since |
1.0 |
|---|
Arguments
- name
stringName of the query variable to get.- default
stringDefault value to return if the variable is not set.
Response
mixedValue of the specified query variable.
hasVar
Checks if variable exists.
hasVar(string name) : bool
| since |
1.0 |
|---|
Arguments
- name
stringName of the query variable to check.
Response
boolTrue if the variable exists.
isSsl
Checks whether the current URI is using HTTPS.
isSsl() : bool
| since |
1.0 |
|---|
Response
boolTrue if using SSL via HTTPS.
parse
Parse a given URI and populate the class fields.
parse(string uri) : bool
| since |
1.0 |
|---|
Arguments
- uri
stringThe URI string to parse.
Response
boolTrue on success.
render
Returns full uri string.
render(int parts = self::ALL) : string
| since |
1.2.0 |
|---|
Arguments
- parts
intA bitmask specifying the parts to render.
Response
stringThe rendered URI string.
toString
Returns full uri string.
toString(array parts = array('scheme', 'user', 'pass', 'host', 'port', 'path', 'query', 'fragment')) : string
| since |
1.0 |
|---|
Arguments
- parts
arrayAn array of strings specifying the parts to render.
Response
stringThe rendered URI string.
Properties
uri
Original URI
| since |
1.0 |
|---|
Type(s)
string
scheme
Protocol
| since |
1.0 |
|---|
Type(s)
string
host
Host
| since |
1.0 |
|---|
Type(s)
string
port
Port
| since |
1.0 |
|---|
Type(s)
int
user
Username
| since |
1.0 |
|---|
Type(s)
string
pass
Password
| since |
1.0 |
|---|
Type(s)
string
path
Path
| since |
1.0 |
|---|
Type(s)
string
query
Query
| since |
1.0 |
|---|
Type(s)
string
fragment
Anchor
| since |
1.0 |
|---|
Type(s)
string
vars
Query variable hash
| since |
1.0 |
|---|
Type(s)
array