toolkit

Url

Parse, build, encode and decode URLs and query strings.

Url:: Phlat\Toolkit\Url 12 methods

Parsing 1

  • parse Extracts a component from a URL. $component is a PHP_URL_* constant.

Building 2

  • join Joins URL path segments, normalising slashes between them.
  • query Builds a query string from an array of parameters.

Construction 1

  • withQuery Appends query parameters to a URL.

Inspection 2

  • isAbsolute Whether the URL has a scheme.
  • isLocal A path on this site: '//host' and '/\host' are other sites to a browser.

Encoding 6

  • encode Encodes a string for use in a query string (spaces become +).
  • decode Decodes a query-string-encoded string.
  • rawEncode Encodes a string for use in a URL path (spaces become %20, RFC 3986).
  • rawDecode Decodes a percent-encoded string.
  • base64Encode Base64-encodes data for safe use in a URL (replaces +/= with URL-safe chars).
  • base64Decode Decodes a URL-safe base64 string.

Parsing

parse

Url::parse(string $url, int $component): ?string

Extracts a component from a URL. $component is a PHP_URL_* constant.

Parameters (2)
$url string
$component int

Returns ?string

phlat/src/Toolkit/Url.php:17

Building

join

Url::join(string ...$parts): string

Joins URL path segments, normalising slashes between them.

No trailing slash.

Parameters (1)
...$parts string

Returns string

phlat/src/Toolkit/Url.php:26

query

Url::query(array $params): string

Builds a query string from an array of parameters.

Parameters (1)
$params array

Returns string

phlat/src/Toolkit/Url.php:34

Construction

withQuery

Url::withQuery(string $url, array $params): string

Appends query parameters to a URL.

Parameters (2)
$url string
$params array

Returns string

phlat/src/Toolkit/Url.php:42

Inspection

isAbsolute

Url::isAbsolute(string $url): bool

Whether the URL has a scheme.

Parameters (1)
$url string

Returns bool

phlat/src/Toolkit/Url.php:50

isLocal

Url::isLocal(string $url): bool

A path on this site: '//host' and '/\host' are other sites to a browser.

Parameters (1)
$url string

Returns bool

phlat/src/Toolkit/Url.php:56

Encoding

encode

Url::encode(string $string): string

Encodes a string for use in a query string (spaces become +).

Parameters (1)
$string string

Returns string

phlat/src/Toolkit/Url.php:64

decode

Url::decode(string $string): string

Decodes a query-string-encoded string.

Parameters (1)
$string string

Returns string

phlat/src/Toolkit/Url.php:70

rawEncode

Url::rawEncode(string $string): string

Encodes a string for use in a URL path (spaces become %20, RFC 3986).

Parameters (1)
$string string

Returns string

phlat/src/Toolkit/Url.php:76

rawDecode

Url::rawDecode(string $string): string

Decodes a percent-encoded string.

Parameters (1)
$string string

Returns string

phlat/src/Toolkit/Url.php:82

base64Encode

Url::base64Encode(string $data): string

Base64-encodes data for safe use in a URL (replaces +/= with URL-safe chars).

Parameters (1)
$data string

Returns string

phlat/src/Toolkit/Url.php:88

base64Decode

Url::base64Decode(string $data): string

Decodes a URL-safe base64 string.

Parameters (1)
$data string

Returns string

phlat/src/Toolkit/Url.php:94