Documentation

Uri
in package
implements UriInterface

Implements an URI object

Tags
see
https://datatracker.ietf.org/doc/html/rfc3986
see
https://datatracker.ietf.org/doc/html/rfc7320
see
https://datatracker.ietf.org/doc/html/rfc8820
phpstan-type

ParsedUrl array{scheme?: string, host?: string, port?: int|string, user?: string, pass?: string, path?: string, query?: string, fragment?: string}

Table of Contents

Interfaces

UriInterface

Constants

CHAR_GEN_DELIMS  = ':\/\?#\[\]@'
Generic delimiters for use in a regex.
CHAR_PERCENT_HEX  = '%(?![a-fA-F0-9]{2})'
Percent encoded
CHAR_SUB_DELIMS  = '!\$&\'\(\)\*\+,;='
Sub delimiters for use in a regex.
CHAR_UNRESERVED  = 'a-zA-Z0-9_\-\.~'
Unreserved characters for use in a regex.

Properties

$fragment  : string
$host  : string
$pass  : string
$path  : string
$port  : int|null
$query  : string
$scheme  : string
$user  : string

Methods

__construct()  : mixed
Uri constructor.
__toString()  : string
getAuthority()  : string
getFragment()  : string
getHost()  : string
getPath()  : string
getPort()  : int|null
getQuery()  : string
getScheme()  : string
getUserInfo()  : string
withFragment()  : static
withHost()  : static
withPath()  : static
withPort()  : static
withQuery()  : static
withScheme()  : static
withUserInfo()  : static
filterHost()  : string
filterPath()  : string
filterPort()  : int|null
filterQueryOrFragment()  : string
filterScheme()  : string
filterUserInfo()  : string
parseUriParts()  : static
replaceChars()  : string

Constants

Properties

$fragment

protected string $fragment = ''

$host

protected string $host = ''

$pass

protected string $pass = ''

$path

protected string $path = ''

$port

protected int|null $port = null

$query

protected string $query = ''

$scheme

protected string $scheme = ''

$user

protected string $user = ''

Methods

__construct()

Uri constructor.

public __construct([array<string|int, mixed>|string|null $uri = null ]) : mixed
Parameters
$uri : array<string|int, mixed>|string|null = null
Tags
throws
InvalidArgumentException
phpstan-param

ParsedUrl|string|null $uri

__toString()

public __toString() : string
Tags
throws
InvalidArgumentException
Return values
string

getAuthority()

public getAuthority() : string
Return values
string

getFragment()

public getFragment() : string
Return values
string

getHost()

public getHost() : string
Return values
string

getPath()

public getPath() : string
Return values
string

getPort()

public getPort() : int|null
Return values
int|null

getQuery()

public getQuery() : string
Return values
string

getScheme()

public getScheme() : string
Return values
string

getUserInfo()

public getUserInfo() : string
Return values
string

withFragment()

public withFragment(string $fragment) : static
Parameters
$fragment : string
Return values
static

withHost()

public withHost(string $host) : static
Parameters
$host : string
Return values
static

withPath()

public withPath(string $path) : static
Parameters
$path : string
Return values
static

withPort()

public withPort(int|null $port) : static
Parameters
$port : int|null
Return values
static

withQuery()

public withQuery(string $query) : static
Parameters
$query : string
Return values
static

withScheme()

public withScheme(string $scheme) : static
Parameters
$scheme : string
Return values
static

withUserInfo()

public withUserInfo(string $user[, string|null $password = null ]) : static
Parameters
$user : string
$password : string|null = null
Return values
static

filterHost()

protected filterHost(string $host) : string
Parameters
$host : string
Return values
string

filterPath()

protected filterPath(string $path) : string
Parameters
$path : string
Return values
string

filterPort()

protected filterPort(int|null $port) : int|null
Parameters
$port : int|null
Tags
throws
InvalidArgumentException
Return values
int|null

filterQueryOrFragment()

protected filterQueryOrFragment(string $queryOrFragment) : string
Parameters
$queryOrFragment : string
Return values
string

filterScheme()

protected filterScheme(string $scheme) : string
Parameters
$scheme : string
Tags
throws
InvalidArgumentException
Return values
string

filterUserInfo()

protected filterUserInfo(string $userOrPass) : string
Parameters
$userOrPass : string
Return values
string

parseUriParts()

protected parseUriParts(array<string|int, mixed> $parts) : static
Parameters
$parts : array<string|int, mixed>
Tags
phpstan-param

ParsedUrl $parts

Return values
static

replaceChars()

protected replaceChars(string $str, string $regex) : string
Parameters
$str : string
$regex : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results