Docs For Class Net

$anchor =

[line 105]

Anchor

Access: public

Type:

string

[ Top ]

$host =

[line 81]

Host

Access: public

Type:

string

[ Top ]

$options = array(
'encode_query_keys' => false,
)

[line 49]

Options

This is the options available for the neturl options.

Var: The options of Net_URL2
Access: public

Type:

array

[ Top ]

$pass =

[line 75]

Password

Access: public

Type:

string

[ Top ]

$path =

[line 93]

Path

Access: public

Type:

string

[ Top ]

$port =

[line 87]

Port

Access: public

Type:

integer

[ Top ]

$protocol =

[line 63]

Protocol

Access: public

Type:

string

[ Top ]

$querystring =

[line 99]

Query string

Access: public

Type:

array

[ Top ]

$url =

[line 57]

Full url

Access: public

Type:

string

[ Top ]

$useBrackets =

[line 111]

Whether to use [] in querystrings

Access: public

Type:

boolean

[ Top ]

$user =

[line 69]

Username

Access: public

Type:

string

[ Top ]

__construct (Constructor) [line 124]

Net_URL2 __construct(
[string
$url = null], [bool
$useBrackets = true])

Constructor

Parses the given url and stores the various parts Defaults are used in certain cases

Access: public

Parameters:

string	`$url`	—	Optional URL
bool	`$useBrackets`	—	Whether to use square brackets when multiple querystrings with the same name exist

[ Top ]

addQueryString [line 231]

void addQueryString(
string
$name, string
$value, [bool
$preencoded = false])

Adds a querystring item

Access: public

Parameters:

string	`$name`	—	Name of item
string	`$value`	—	Value of item
bool	`$preencoded`	—	Whether value is rawurlencoded or not, default = not

[ Top ]

addRawQueryString [line 266]

void addRawQueryString(
string
$querystring)

Sets the querystring to literally what you supply

Access: public

Parameters:

string $querystring — The querystring data. Should be of the format foo=bar&x=y etc

[ Top ]

getOption [line 452]

mixed getOption(

$optionName)

Get an option

This function will get an option from the options private variable.

Return: Bool false if the key doesn't exist and the value of the option if it exists.
See: $this->options
Access: public

Parameters:

$optionName —

[ Top ]

getQueryString [line 276]

string getQueryString(
)

Returns flat querystring

Return: Querystring
Access: public

[ Top ]

getStandardPort [line 362]

integer getStandardPort(
string
$scheme)

Returns the standard port number for a protocol

Return: Port number or NULL if no scheme matches
Author: Philippe Jausions <Philippe.Jausions@11abacus.com>
Access: public

Parameters:

string $scheme — The protocol to lookup

[ Top ]

getURL [line 209]

string getURL(
)

Returns full url

Return: Full url
Access: public

[ Top ]

removeQueryString [line 250]

void removeQueryString(
string
$name)

Removes a querystring item

Access: public

Parameters:

string $name — Name of item

[ Top ]

resolvePath [line 325]

string resolvePath(

$path, string
$url)

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

Return: The result
Access: public

Parameters:

string	`$url`	—	URL path to resolve
	`$path`	—

[ Top ]

setOption [line 437]

void setOption(
string
$optionName, string
$value)

Set a private option

This function sets a private option

Access: public

Parameters:

string	`$optionName`	—	The option name
string	`$value`	—	The value of this option

[ Top ]

setProtocol [line 308]

void setProtocol(
string
$protocol, [integer
$port = null])

Forces the URL to a particular protocol

Access: public

Parameters:

string	`$protocol`	—	Protocol to force the URL to
integer	`$port`	—	Optional port (standard port is used by default)

[ Top ]

Class: Net_URL2

Class Overview

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$anchor =

$host =

$options = array(
'encode_query_keys' => false,
)

$pass =

$path =

$port =

$protocol =

$querystring =

$url =

$useBrackets =

$user =

Method Detail

__construct (Constructor) [line 124]

Parameters:

addQueryString [line 231]

Parameters:

addRawQueryString [line 266]

Parameters:

getOption [line 452]

Parameters:

getQueryString [line 276]

getStandardPort [line 362]

Parameters:

getURL [line 209]

removeQueryString [line 250]

Parameters:

resolvePath [line 325]

Parameters:

setOption [line 437]

Parameters:

setProtocol [line 308]

Parameters:

Class: Net_URL2

Class Overview

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$anchor =

$host =

$options = array( 'encode_query_keys' => false, )

$pass =

$path =

$port =

$protocol =

$querystring =

$url =

$useBrackets =

$user =

Method Detail

__construct (Constructor) [line 124]

Parameters:

addQueryString [line 231]

Parameters:

addRawQueryString [line 266]

Parameters:

getOption [line 452]

Parameters:

getQueryString [line 276]

getStandardPort [line 362]

Parameters:

getURL [line 209]

removeQueryString [line 250]

Parameters:

resolvePath [line 325]

Parameters:

setOption [line 437]

Parameters:

setProtocol [line 308]

Parameters:

$options = array(
'encode_query_keys' => false,
)