1. class
  2. Nette
  3. \
  4. Http
  5. \
  6. UrlImmutable

UrlImmutable

class UrlImmutable implements JsonSerializable

Immutable representation of a URL.

scheme  user  password  host  port      path        query    fragment
  |      |      |        |      |        |            |         |
/--\   /--\ /------\ /-------\ /--\/------------\ /--------\ /------\
http://john:x0y17575@nette.org:8042/en/manual.php?name=param#fragment  <-- absoluteUrl
\______\__________________________/
    |               |
 hostUrl        authority

Properties

string read-only $scheme
string read-only $user
string read-only $password
string read-only $host
int read-only $port
string read-only $path
string read-only $query
string read-only $fragment
string read-only $absoluteUrl
string read-only $authority
string read-only $hostUrl
array read-only $queryParameters

Methods

__construct(Url $url)

No description

UrlImmutable
withScheme(string $scheme)

No description

string
getScheme()

No description

UrlImmutable
withUser(string $user)

No description

string
getUser()

No description

UrlImmutable
withPassword(string $password)

No description

string
getPassword()

No description

UrlImmutable
withoutUserInfo()

No description

UrlImmutable
withHost(string $host)

No description

string
getHost()

No description

string
getDomain(int $level = 2)

No description

UrlImmutable
withPort(int $port)

No description

int|null
getPort()

No description

int|null
getDefaultPort()

No description

UrlImmutable
withPath(string $path)

No description

string
getPath()

No description

UrlImmutable
withQuery(string|array $query)

No description

string
getQuery()

No description

UrlImmutable
withQueryParameter(string $name, mixed $value)

No description

array
getQueryParameters()

No description

array|string|null
getQueryParameter(string $name)

No description

UrlImmutable
withFragment(string $fragment)

No description

string
getFragment()

No description

string
getAbsoluteUrl()

Returns the entire URI including query string and fragment.

string
getAuthority()

Returns the [user[:pass]@]host[:port] part of URI.

string
getHostUrl()

Returns the scheme and authority part of URI.

string
__toString()

No description

bool
isEqual(Url|self $url)

No description

UrlImmutable
resolve(string $reference)

Resolves relative URLs in the same way as browser. If path is relative, it is resolved against base URL, if begins with /, it is resolved against the host root.

string
mergePath(string $path)

No description

string
jsonSerialize()

No description

array
export()

No description

Details

at line 61
__construct(Url $url)

No description

Parameters

Url $url

Exceptions

InvalidArgumentException

at line 68
UrlImmutable withScheme(string $scheme)

No description

Parameters

string $scheme

Return Value

UrlImmutable

at line 77
string getScheme()

No description

Return Value

string

at line 83
UrlImmutable withUser(string $user)

No description

Parameters

string $user

Return Value

UrlImmutable

at line 94
string getUser()

No description

Return Value

string

at line 102
UrlImmutable withPassword(string $password)

No description

Parameters

string $password

Return Value

UrlImmutable

at line 113
string getPassword()

No description

Return Value

string

at line 121
UrlImmutable withoutUserInfo()

No description

Return Value

UrlImmutable

at line 132
UrlImmutable withHost(string $host)

No description

Parameters

string $host

Return Value

UrlImmutable

at line 141
string getHost()

No description

Return Value

string

at line 147
string getDomain(int $level = 2)

No description

Parameters

int $level

Return Value

string

at line 159
UrlImmutable withPort(int $port)

No description

Parameters

int $port

Return Value

UrlImmutable

at line 168
int|null getPort()

No description

Return Value

int|null

at line 174
int|null getDefaultPort()

No description

Return Value

int|null

at line 180
UrlImmutable withPath(string $path)

No description

Parameters

string $path

Return Value

UrlImmutable

at line 193
string getPath()

No description

Return Value

string

at line 199
UrlImmutable withQuery(string|array $query)

No description

Parameters

string|array $query

Return Value

UrlImmutable

at line 207
string getQuery()

No description

Return Value

string

at line 213
UrlImmutable withQueryParameter(string $name, mixed $value)

No description

Parameters

string $name
mixed $value

Return Value

UrlImmutable

at line 221
array getQueryParameters()

No description

Return Value

array

at line 227
array|string|null getQueryParameter(string $name)

No description

Parameters

string $name

Return Value

array|string|null

at line 233
UrlImmutable withFragment(string $fragment)

No description

Parameters

string $fragment

Return Value

UrlImmutable

at line 241
string getFragment()

No description

Return Value

string

at line 250
string getAbsoluteUrl()

Returns the entire URI including query string and fragment.

Return Value

string

at line 261
string getAuthority()

Returns the [user[:pass]@]host[:port] part of URI.

Return Value

string

at line 278
string getHostUrl()

Returns the scheme and authority part of URI.

Return Value

string

at line 285
string __toString()

No description

Return Value

string

at line 291
bool isEqual(Url|self $url)

No description

Parameters

Url|self $url

Return Value

bool

at line 301
UrlImmutable resolve(string $reference)

Resolves relative URLs in the same way as browser. If path is relative, it is resolved against base URL, if begins with /, it is resolved against the host root.

Parameters

string $reference

Return Value

UrlImmutable

at line 332
protected string mergePath(string $path)

internal  
 

No description

Parameters

string $path

Return Value

string

at line 339
string jsonSerialize()

No description

Return Value

string

at line 346
final array export()

internal  
 

No description

Return Value

array

Traits

SmartObject