Skip to main content

Zymba Documentation

URI

object @URI() {
createDataURI(string $string, string $type, string $charset): string {}
createQuery(object $attributes): string {}
decode(string $string): string {}
encode(string $string): string {}
getAuthority(string $uri): string {}
getFragment(string $uri): string {}
getHierarchy(string $uri): string {}
getHost(string $uri): string {}
getPassword(string $uri): string {}
getPath(string $uri): string {}
getPort(string $uri): string {}
getQuery(string $uri): string {}
getScheme(string $uri): string {}
getUser(string $uri): string {}
isAbsolute(string $uri): bool {}
isFile(string $path): bool {}
isValid(string $uri): bool {}
normalize(string $uri): string {}
parse(string $uri): object {}
parseQuery(string $query): object {}
}

Static URI related functions.

Functions

Creates a data URI according to RFC 2397.

@URI.createDataURI(string $string, string $type, string $charset): string
Parameters
NameTypeValueDefault
stringstring""
typestring"text/plain"
charsetstring""
Returns
TypeValue
string

Creates the URI query component out of specific attribute name and value pairs according to RFC 3986.

@URI.createQuery(object $attributes): string
Parameters
NameTypeValueDefault
attributesobject[name: value, ...][]
Returns
TypeValue
string

Decodes a string according to RFC 3986 by replacing sequences incipient with a percent sign ("%") followed by a 2-character hexadecimal number with their applicable characters.

@URI.decode(string $string): string
Parameters
NameTypeValueDefault
stringstring""
Returns
TypeValue
string

Encodes a string according to RFC 3986 by replacing non-alphanumeric characters except "-", "_", "." and "~" with a percent sign ("%") followed by a 2-character hexadecimal number.

@URI.encode(string $string): string
Parameters
NameTypeValueDefault
stringstring""
Returns
TypeValue
string

Gets the authority component of an URI.

@URI.getAuthority(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string

Gets the fragment component of an URI.

@URI.getFragment(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string

Gets the hierarchy component of an URI.

@URI.getHierarchy(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string

Gets the host name component of an URI.

@URI.getHost(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string

Gets the password component of an URI.

@URI.getPassword(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string

Gets the path name component of an URI.

@URI.getPath(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string

Gets the port number component of an URI.

@URI.getPort(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string

Gets the query component of an URI.

@URI.getQuery(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string

Gets the scheme component of an URI.

@URI.getScheme(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string

Gets the username component of an URI.

@URI.getUser(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string

Determines whether an URI is absolute, meaning it has a scheme component.

@URI.isAbsolute(string $uri): bool
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
bool

Determines whether an URI is of the file URI scheme.

@URI.isFile(string $path): bool
Parameters
NameTypeValueDefault
pathstring""
Returns
TypeValue
bool

Determines whether an URI is valid.

@URI.isValid(string $uri): bool
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
bool

Normalizes an URI to its canonicalized representation according to RFC 3986 and the comparison rules of RFC 2616.

@URI.normalize(string $uri): string
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
string
@URI.parse(string $uri): object
Parameters
NameTypeValueDefault
uristring""
Returns
TypeValue
object["scheme": ..., "user": ..., "password": ..., "host": ..., "port": ..., "path": ..., "query": ..., "fragment": ...]
@URI.parseQuery(string $query): object
Parameters
NameTypeValueDefault
querystring""
Returns
TypeValue
object[name: value, ...]