Docs For Class Net

__construct (Constructor) [line 141]

Net_URL2 __construct(
string
$url, [array
$options = null])

Constructor.

Access: public

Parameters:

string	`$url`	—	an absolute or relative URL
array	`$options`	—	an array of OPTION_xxx constants

[ Top ]

getAuthority [line 353]

string|bool getAuthority(
)

Returns the authority part, i.e. [ userinfo "@" ] host [ ":" port ], or false if there is no authority.

Access: public

[ Top ]

getCanonical [line 846]

string getCanonical(
)

Returns a Net_URL2 instance representing the canonical URL of the currently executing PHP script.

Access: public

[ Top ]

getFragment [line 454]

string|bool getFragment(
)

Returns the fragment name, or false if "#" is not present in the URL.

Access: public

[ Top ]

getHost [line 305]

string|bool getHost(
)

Returns the host part, or false if there is no authority part, e.g.

relative URLs.

Return: a hostname, an IP address, or false
Access: public

[ Top ]

getNormalizedURL [line 641]

string getNormalizedURL(
)

Returns a normalized string representation of this URL. This is useful for comparison of URLs.

Access: public

[ Top ]

getOption [line 923]

mixed getOption(
string
$optionName)

Returns the value of the specified option.

Parameters:

string $optionName — The name of the option to retrieve

[ Top ]

getPassword [line 264]

string|bool getPassword(
)

Returns the password part of the userinfo part (the part after the first ":"), or false if there is no userinfo part (i.e. the URL does not contain "@" in front of the hostname) or the userinfo part does not contain ":".

Access: public

[ Top ]

getPath [line 406]

string getPath(
)

Returns the path part (possibly an empty string).

Access: public

[ Top ]

getPort [line 329]

int|bool getPort(
)

Returns the port number, or false if there is no port number specified, i.e. if the default port is to be used.

Access: public

[ Top ]

getQuery [line 430]

string|bool getQuery(
)

Returns the query string (excluding the leading "?"), or false if "?" is not present in the URL.

See: self::getQueryVariables()
Access: public

[ Top ]

getQueryVariables [line 479]

array getQueryVariables(
)

Returns the query string like an array as the variables would appear in $_GET in a PHP script. If the URL does not contain a "?", an empty array is returned.

Access: public

[ Top ]

getRequested [line 882]

Net_URL2 getRequested(
)

Returns a Net_URL2 instance representing the URL used to retrieve the current request.

Access: public

[ Top ]

getRequestedURL [line 871]

string getRequestedURL(
)

Returns the URL used to retrieve the current request.

Access: public

[ Top ]

getScheme [line 222]

string|bool getScheme(
)

Returns the scheme, e.g. "http" or "urn", or false if there is no scheme specified, i.e. if this is a relative URL.

Access: public

[ Top ]

getURL [line 598]

string getURL(
)

Returns a string representation of this URL.

Access: public

[ Top ]

getUser [line 249]

string|bool getUser(
)

Returns the user part of the userinfo part (the part preceding the first ":"), or false if there is no userinfo part.

Access: public

[ Top ]

getUserinfo [line 277]

string|bool getUserinfo(
)

Returns the userinfo part, or false if there is none, i.e. if the authority part does not contain "@".

Access: public

[ Top ]

isAbsolute [line 698]

bool isAbsolute(
)

Returns whether this instance represents an absolute URL.

Access: public

[ Top ]

normalize [line 653]

Net_URL2 normalize(
)

Returns a normalized Net_URL2 instance.

Access: public

[ Top ]

removeDotSegments [line 782]

string removeDotSegments(
string
$path)

Removes dots as described in RFC 3986, section 5.2.4, e.g.

"/foo/../bar/baz" => "/bar/baz"

Return: a path
Access: public

Parameters:

string $path — a path

[ Top ]

resolve [line 711]

Net_URL2 resolve(
Net_URL2|string
$reference)

Returns an Net_URL2 instance representing an absolute URL relative to this URL.

Access: public

Parameters:

Net_URL2|string $reference — relative URL

[ Top ]

setAuthority [line 384]

void setAuthority(
string|false
$authority)

Sets the authority part, i.e. [ userinfo "@" ] host [ ":" port ]. Specify false if there is no authority.

Access: public

Parameters:

string|false $authority — a hostname or an IP addresse, possibly with userinfo prefixed and port number appended, e.g. "foo:bar@example.org:81".

[ Top ]

setFragment [line 467]

void setFragment(
string|bool
$fragment)

Sets the fragment name. Specify false if "#" is not present in the URL.

Access: public

Parameters:

string|bool $fragment — a fragment excluding the leading "#", or false

[ Top ]

setHost [line 318]

void setHost(
string|bool
$host)

Sets the host part. Specify false if there is no authority part, e.g.

relative URLs.

Access: public

Parameters:

string|bool $host — a hostname, an IP address, or false

[ Top ]

setOption [line 908]

void setOption(
string
$optionName, mixed
$value)

Sets the specified option.

See: self::OPTION_ENCODE_KEYS
See: self::OPTION_USE_BRACKETS
See: self::OPTION_STRICT

Parameters:

string	`$optionName`	—	a self::OPTION_ constant
mixed	`$value`	—	option value

[ Top ]

setPath [line 418]

void setPath(
string
$path)

Sets the path part (possibly an empty string).

Access: public

Parameters:

string $path — a path

[ Top ]

setPort [line 342]

void setPort(
int|bool
$port)

Sets the port number. Specify false if there is no port number specified, i.e. if the default port is to be used.

Access: public

Parameters:

int|bool $port — a port number, or false

[ Top ]

setQuery [line 444]

void setQuery(
string|bool
$query)

Sets the query string (excluding the leading "?"). Specify false if "?" is not present in the URL.

See: self::setQueryVariables()
Access: public

Parameters:

string|bool $query — a query string, e.g. "foo=1&bar=2"

[ Top ]

setQueryVariable [line 572]

array setQueryVariable(
string
$name, mixed
$value)

Sets the specified variable in the query string.

Access: public

Parameters:

string	`$name`	—	variable name
mixed	`$value`	—	variable value

[ Top ]

setQueryVariables [line 537]

void setQueryVariables(
array
$array)

Sets the query string to the specified variable in the query string.

Access: public

Parameters:

array $array — (name => value) array

[ Top ]

setScheme [line 238]

void setScheme(
string|bool
$scheme)

Sets the scheme, e.g. "http" or "urn". Specify false if there is no scheme specified, i.e. if this is a relative URL.

See: Net_URL2::getScheme()
Access: public

Parameters:

string|bool $scheme — e.g. "http" or "urn", or false if there is no scheme specified, i.e. if this is a relative URL

[ Top ]

setUserinfo [line 291]

void setUserinfo(
string|bool
$userinfo, [string|bool
$password = false])

Sets the userinfo part. If two arguments are passed, they are combined in the userinfo part as username ":" password.

Access: public

Parameters:

string\|bool	`$userinfo`	—	userinfo or username
string\|bool	`$password`	—	optional password, or false

[ Top ]

unsetQueryVariable [line 586]

void unsetQueryVariable(
string
$name)

Removes the specifed variable from the query string.

Access: public

Parameters:

string $name — a query string variable, e.g. "foo" in "?foo=1"

[ Top ]

urlencode [line 832]

string urlencode(
$raw
$string)

Percent-encodes all non-alphanumeric characters except these: _ . - ~ Similar to PHP's rawurlencode(), except that it also encodes ~ in PHP 5.2.x and earlier.

Access: public

Parameters:

$raw $string — the string to encode

[ Top ]

__get [line 206]

mixed __get(
string
$var)

Magic Getter.

This is the magic get method to retrieve the private variable that was set by either __set() or it's setter...

Return: Either a boolean false if the property is not set or the value of the private property.
Access: public

Parameters:

string $var — The property name to retrieve.

[ Top ]

__set [line 187]

void __set(
string
$var, mixed
$arg)

Magic Setter.

This method will magically set the value of a private variable ($var) with the value passed as the args

Access: public

Parameters:

string	`$var`	—	The private variable to set.
mixed	`$arg`	—	An argument of any type.

[ Top ]

__toString [line 630]

string __toString(
)

Returns a string representation of this URL.

See: toString()
Access: public

[ Top ]

Class: Net_URL2

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

__construct (Constructor) [line 141]

Parameters:

getAuthority [line 353]

getCanonical [line 846]

getFragment [line 454]

getHost [line 305]

getNormalizedURL [line 641]

getOption [line 923]

Parameters:

getPassword [line 264]

getPath [line 406]

getPort [line 329]

getQuery [line 430]

getQueryVariables [line 479]

getRequested [line 882]

getRequestedURL [line 871]

getScheme [line 222]

getURL [line 598]

getUser [line 249]

getUserinfo [line 277]

isAbsolute [line 698]

normalize [line 653]

removeDotSegments [line 782]

Parameters:

resolve [line 711]

Parameters:

setAuthority [line 384]

Parameters:

setFragment [line 467]

Parameters:

setHost [line 318]

Parameters:

setOption [line 908]

Parameters:

setPath [line 418]

Parameters:

setPort [line 342]

Parameters:

setQuery [line 444]

Parameters:

setQueryVariable [line 572]

Parameters:

setQueryVariables [line 537]

Parameters:

setScheme [line 238]

Parameters:

setUserinfo [line 291]

Parameters:

unsetQueryVariable [line 586]

Parameters:

urlencode [line 832]

Parameters:

__get [line 206]

Parameters:

__set [line 187]

Parameters:

__toString [line 630]