PHP Class Neos\Flow\Http\Uri

Mostra file Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$arguments array Array representation of the URI query
$fragment string Fragment / anchor, if one was specified.
$host string Host of the locator, eg. some.subdomain.example.com
$password string Password of a login, if any
$path string The hierarchical part of the URI, eg. /products/acme_soap
$port integer Port of the locator, if any was specified. Eg. 80
$query string Query string of the locator, if any. Eg. color=red&size=large
$scheme string The scheme / protocol of the locator, eg. http
$username string User name of a login, if any

Public Methods

Method Description
__construct ( string $uriString ) Constructs the URI object from a string
__toString ( ) : string Returns a string representation of this URI
getArguments ( ) : array Returns the arguments from the URI's query part
getFragment ( ) : string Returns the fragment / anchor, if any
getHost ( ) : string Returns the host(s) of the URI
getPassword ( ) : string Returns the password of a login
getPath ( ) : string Returns the URI path
getPort ( ) : integer Returns the port of the URI
getQuery ( ) : string Returns the URI's query part
getScheme ( ) : string Returns the URI's scheme / protocol
getUsername ( ) : string Returns the username of a login
setFragment ( string $fragment ) : void Sets the fragment in the URI
setHost ( string $host ) : void Sets the host(s) of the URI
setPassword ( string $password ) : void Sets the URI's password
setPath ( string $path ) : void Sets the path of the URI
setPort ( string $port ) : void Sets the port in the URI
setQuery ( string $query ) : void Sets the URI's query part. Updates (= overwrites) the arguments accordingly!
setScheme ( string $scheme ) : void Sets the URI's scheme / protocol
setUsername ( string $username ) : void Sets the URI's username

Method Details

__construct() public method

Constructs the URI object from a string
public __construct ( string $uriString )
$uriString string String representation of the URI

__toString() public method

Returns a string representation of this URI
public __toString ( ) : string
return string This URI as a string

getArguments() public method

Returns the arguments from the URI's query part
public getArguments ( ) : array
return array Associative array of arguments and values of the URI's query part

getFragment() public method

Returns the fragment / anchor, if any
public getFragment ( ) : string
return string The fragment

getHost() public method

Returns the host(s) of the URI
public getHost ( ) : string
return string The hostname(s)

getPassword() public method

Returns the password of a login
public getPassword ( ) : string
return string Password of the login

getPath() public method

Returns the URI path
public getPath ( ) : string
return string URI path

getPort() public method

Returns the port of the URI
public getPort ( ) : integer
return integer Port

getQuery() public method

Returns the URI's query part
public getQuery ( ) : string
return string The query part

getScheme() public method

Returns the URI's scheme / protocol
public getScheme ( ) : string
return string URI scheme / protocol

getUsername() public method

Returns the username of a login
public getUsername ( ) : string
return string User name of the login

setFragment() public method

Sets the fragment in the URI
public setFragment ( string $fragment ) : void
$fragment string The fragment (aka "anchor")
return void

setHost() public method

Sets the host(s) of the URI
public setHost ( string $host ) : void
$host string The hostname(s)
return void

setPassword() public method

Sets the URI's password
public setPassword ( string $password ) : void
$password string Password of the login
return void

setPath() public method

Sets the path of the URI
public setPath ( string $path ) : void
$path string The path
return void

setPort() public method

Sets the port in the URI
public setPort ( string $port ) : void
$port string The port number
return void

setQuery() public method

Sets the URI's query part. Updates (= overwrites) the arguments accordingly!
public setQuery ( string $query ) : void
$query string The query string.
return void

setScheme() public method

Sets the URI's scheme / protocol
public setScheme ( string $scheme ) : void
$scheme string The scheme. Allowed values are "http" and "https"
return void

setUsername() public method

Sets the URI's username
public setUsername ( string $username ) : void
$username string User name of the login
return void

Property Details

$arguments protected_oe property

Array representation of the URI query
protected array $arguments
return array

$fragment protected_oe property

Fragment / anchor, if one was specified.
protected string $fragment
return string

$host protected_oe property

Host of the locator, eg. some.subdomain.example.com
protected string $host
return string

$password protected_oe property

Password of a login, if any
protected string $password
return string

$path protected_oe property

The hierarchical part of the URI, eg. /products/acme_soap
protected string $path
return string

$port protected_oe property

Port of the locator, if any was specified. Eg. 80
protected int $port
return integer

$query protected_oe property

Query string of the locator, if any. Eg. color=red&size=large
protected string $query
return string

$scheme protected_oe property

The scheme / protocol of the locator, eg. http
protected string $scheme
return string

$username protected_oe property

User name of a login, if any
protected string $username
return string