Methods summary
public static
Guzzle\Http\Url
|
#
factory( string $url )
Factory method to create a new URL from a URL string
Factory method to create a new URL from a URL string
Parameters
- $url
string $url Full URL used to create a Url object
Returns
|
public static
string
|
#
buildUrl( array $parts )
Build a URL from parse_url parts. The generated URL will be a relative URL if
a scheme or host are not provided.
Build a URL from parse_url parts. The generated URL will be a relative URL if
a scheme or host are not provided.
Parameters
- $parts
array $parts Array of parse_url parts
Returns
string
|
public
|
#
__construct( string $scheme, string $host, string $username = null, string $password = null, integer $port = null, string $path = null, Guzzle\Http\QueryString $query = null, string $fragment = null )
Create a new URL from URL parts
Create a new URL from URL parts
Parameters
- $scheme
string $scheme Scheme of the URL
- $host
string $host Host of the URL
- $username
string $username Username of the URL
- $password
string $password Password of the URL
- $port
integer $port Port of the URL
- $path
string $path Path of the URL
- $query
Guzzle\Http\QueryString |array|string
$query Query string of the URL
- $fragment
string $fragment Fragment of the URL
|
public
|
|
public
string
|
#
__toString( )
Returns the URL as a URL string
Returns the URL as a URL string
Returns
string
|
public
array
|
#
getParts( )
Get the parts of the URL as an array
Get the parts of the URL as an array
Returns
array
|
public
Guzzle\Http\Url
|
#
setHost( string $host )
Set the host of the request.
Set the host of the request.
Parameters
Returns
|
public
string
|
#
getHost( )
Get the host part of the URL
Get the host part of the URL
Returns
string
|
public
Guzzle\Http\Url
|
#
setScheme( string $scheme )
Set the scheme part of the URL (http, https, ftp, etc)
Set the scheme part of the URL (http, https, ftp, etc)
Parameters
- $scheme
string $scheme Scheme to set
Returns
|
public
string
|
#
getScheme( )
Get the scheme part of the URL
Get the scheme part of the URL
Returns
string
|
public
Guzzle\Http\Url
|
#
setPort( integer $port )
Set the port part of the URL
Set the port part of the URL
Parameters
- $port
integer $port Port to set
Returns
|
public
integer|null
|
#
getPort( )
Get the port part of the URl. Will return the default port for a given scheme
if no port has been set.
Get the port part of the URl. Will return the default port for a given scheme
if no port has been set.
Returns
integer|null
|
public
Guzzle\Http\Url
|
#
setPath( array|string $path )
Set the path part of the URL
Set the path part of the URL
Parameters
- $path
array|string $path Path string or array of path segments
Returns
|
public
Guzzle\Http\Url
|
#
normalizePath( )
Normalize the URL so that double slashes and relative paths are removed
Normalize the URL so that double slashes and relative paths are removed
Returns
|
public
Guzzle\Http\Url
|
#
addPath( string $relativePath )
Add a relative path to the currently set path
Add a relative path to the currently set path
Parameters
- $relativePath
string $relativePath Relative path to add
Returns
|
public
string
|
#
getPath( )
Get the path part of the URL
Get the path part of the URL
Returns
string
|
public
array
|
#
getPathSegments( )
Get the path segments of the URL as an array
Get the path segments of the URL as an array
Returns
array
|
public
Guzzle\Http\Url
|
#
setPassword( string $password )
Set the password part of the URL
Set the password part of the URL
Parameters
- $password
string $password Password to set
Returns
|
public
null|string
|
#
getPassword( )
Get the password part of the URL
Get the password part of the URL
Returns
null|string
|
public
Guzzle\Http\Url
|
#
setUsername( string $username )
Set the username part of the URL
Set the username part of the URL
Parameters
- $username
string $username Username to set
Returns
|
public
null|string
|
#
getUsername( )
Get the username part of the URl
Get the username part of the URl
Returns
null|string
|
public
Guzzle\Http\QueryString
|
#
getQuery( )
Get the query part of the URL as a QueryString object
Get the query part of the URL as a QueryString object
Returns
|
public
Guzzle\Http\Url
|
|
public
null|string
|
#
getFragment( )
Get the fragment part of the URL
Get the fragment part of the URL
Returns
null|string
|
public
Guzzle\Http\Url
|
#
setFragment( string $fragment )
Set the fragment part of the URL
Set the fragment part of the URL
Parameters
- $fragment
string $fragment Fragment to set
Returns
|
public
boolean
|
#
isAbsolute( )
Check if this is an absolute URL
Check if this is an absolute URL
Returns
boolean
|
public
Guzzle\Http\Url
|
#
combine( string $url )
Combine the URL with another URL. Follows the rules specific in RFC 3986
section 5.4.
Combine the URL with another URL. Follows the rules specific in RFC 3986
section 5.4.
Parameters
- $url
string $url Relative URL to combine with
Returns
Throws
Link
|