PHPFUI/InstaDoc

CloneableFinalInstantiable

Methods

public static chooseHandler() : callable

Chooses and creates a default handler to use based on the environment.

The returned handler is not wrapped by any default middlewares.

throws phpDocumentor\Reflection\Types\Object_ if no viable Handler is available.
return

public static currentTime() : float

Wrapper for the hrtime() or microtime() functions
(depending on the PHP version, one of the two is used)

return phpDocumentor\Reflection\Types\Float_ UNIX timestamp
internal

public static debugResource( $value = NULL)

Returns a debug stream based on the provided variable.

param phpDocumentor\Reflection\Types\Mixed_ $value Optional value
return phpDocumentor\Reflection\Types\Resource_

public static defaultCaBundle() : string

Returns the default cacert bundle for the current system.

First, the openssl.cafile and curl.cainfo php.ini settings are checked.
If those settings are not configured, then the common locations for
bundles found on Red Hat, CentOS, Fedora, Ubuntu, Debian, FreeBSD, OS X
and Windows are checked. If any of these file locations are found on
disk, they will be utilized.

Note: the result of this function is cached for subsequent calls.

throws phpDocumentor\Reflection\Types\Object_ if no bundle can be found.
deprecated Utils::defaultCaBundle will be removed in guzzlehttp/guzzle:8.0. This method is not needed in PHP 5.6+.

public static defaultUserAgent() : string

Get the default User-Agent string to use with Guzzle.

public static describeType( $input) : string

Debug function used to describe the provided value type and class.

param phpDocumentor\Reflection\Types\Mixed_ $input
return phpDocumentor\Reflection\Types\String_ Returns a string containing the type of the variable and
if a class is provided, the class name.

public static getenv(string $name) : ?string

internal

public static headersFromLines(iterable $lines) : array

Parses an array of header lines into an associative array of headers.

param phpDocumentor\Reflection\Types\Iterable_ $lines Header lines array of strings in the following
format: "Name: Value"

public static idnUriConvert(Psr\Http\Message\UriInterface $uri, int $options = 0) : Psr\Http\Message\UriInterface

throws phpDocumentor\Reflection\Types\Object_
internal

public static isHostInNoProxy(string $host, array $noProxyArray) : bool

Returns true if the provided host matches any of the no proxy areas.

This method will strip a port from the host if it is present. Each pattern
can be matched with an exact match (e.g., "foo.com" == "foo.com") or a
partial match: (e.g., "foo.com" == "baz.foo.com" and ".foo.com" ==
"baz.foo.com", but ".foo.com" != "foo.com").

Areas are matched in the following cases:

"*" (without quotes) always matches any hosts.
An exact match.
The area starts with "." and the area is the last part of the host. e.g.
'.mit.edu' will match any host that ends with '.mit.edu'.

param phpDocumentor\Reflection\Types\String_ $host Host to check against the patterns.
param phpDocumentor\Reflection\Types\Array_ $noProxyArray An array of host patterns.
throws phpDocumentor\Reflection\Types\Object_

public static jsonDecode(string $json, bool $assoc = false, int $depth = 512, int $options = 0)

Wrapper for json_decode that throws when an error occurs.

param phpDocumentor\Reflection\Types\String_ $json JSON data to parse
param phpDocumentor\Reflection\Types\Boolean $assoc When true, returned objects will be converted
into associative arrays.
param phpDocumentor\Reflection\Types\Integer $depth User specified recursion depth.
param phpDocumentor\Reflection\Types\Integer $options Bitmask of JSON decode options.
return phpDocumentor\Reflection\Types\Compound
throws phpDocumentor\Reflection\Types\Object_ if the JSON cannot be decoded.
link https://www.php.net/manual/en/function.json-decode.php

public static jsonEncode( $value, int $options = 0, int $depth = 512) : string

Wrapper for JSON encoding that throws when an error occurs.

param phpDocumentor\Reflection\Types\Mixed_ $value The value being encoded
param phpDocumentor\Reflection\Types\Integer $options JSON encode option bitmask
param phpDocumentor\Reflection\Types\Integer $depth Set the maximum depth. Must be greater than zero.
throws phpDocumentor\Reflection\Types\Object_ if the JSON cannot be encoded.
link https://www.php.net/manual/en/function.json-encode.php

public static normalizeHeaderKeys(array $headers) : array

Creates an associative array of lowercase header names to the actual
header casing.

Methods

private static idnToAsci(string $domain, int $options, ?array $info = [])

return phpDocumentor\Reflection\Types\Compound

Methods

public static chooseHandler() : callable

Chooses and creates a default handler to use based on the environment.

The returned handler is not wrapped by any default middlewares.

throws phpDocumentor\Reflection\Types\Object_ if no viable Handler is available.
return

public static currentTime() : float

Wrapper for the hrtime() or microtime() functions
(depending on the PHP version, one of the two is used)

return phpDocumentor\Reflection\Types\Float_ UNIX timestamp
internal

public static debugResource( $value = NULL)

Returns a debug stream based on the provided variable.

param phpDocumentor\Reflection\Types\Mixed_ $value Optional value
return phpDocumentor\Reflection\Types\Resource_

public static defaultCaBundle() : string

Returns the default cacert bundle for the current system.

Note: the result of this function is cached for subsequent calls.

throws phpDocumentor\Reflection\Types\Object_ if no bundle can be found.
deprecated Utils::defaultCaBundle will be removed in guzzlehttp/guzzle:8.0. This method is not needed in PHP 5.6+.

public static defaultUserAgent() : string

Get the default User-Agent string to use with Guzzle.

public static describeType( $input) : string

Debug function used to describe the provided value type and class.

param phpDocumentor\Reflection\Types\Mixed_ $input
return phpDocumentor\Reflection\Types\String_ Returns a string containing the type of the variable and
if a class is provided, the class name.

public static getenv(string $name) : ?string

internal

public static headersFromLines(iterable $lines) : array

Parses an array of header lines into an associative array of headers.

param phpDocumentor\Reflection\Types\Iterable_ $lines Header lines array of strings in the following
format: "Name: Value"

private static idnToAsci(string $domain, int $options, ?array $info = [])

return phpDocumentor\Reflection\Types\Compound

public static idnUriConvert(Psr\Http\Message\UriInterface $uri, int $options = 0) : Psr\Http\Message\UriInterface

throws phpDocumentor\Reflection\Types\Object_
internal

public static isHostInNoProxy(string $host, array $noProxyArray) : bool

Returns true if the provided host matches any of the no proxy areas.

Areas are matched in the following cases:

"*" (without quotes) always matches any hosts.
An exact match.
The area starts with "." and the area is the last part of the host. e.g.
'.mit.edu' will match any host that ends with '.mit.edu'.

param phpDocumentor\Reflection\Types\String_ $host Host to check against the patterns.
param phpDocumentor\Reflection\Types\Array_ $noProxyArray An array of host patterns.
throws phpDocumentor\Reflection\Types\Object_

public static jsonDecode(string $json, bool $assoc = false, int $depth = 512, int $options = 0)

Wrapper for json_decode that throws when an error occurs.

param phpDocumentor\Reflection\Types\String_ $json JSON data to parse
param phpDocumentor\Reflection\Types\Boolean $assoc When true, returned objects will be converted
into associative arrays.
param phpDocumentor\Reflection\Types\Integer $depth User specified recursion depth.
param phpDocumentor\Reflection\Types\Integer $options Bitmask of JSON decode options.
return phpDocumentor\Reflection\Types\Compound
throws phpDocumentor\Reflection\Types\Object_ if the JSON cannot be decoded.
link https://www.php.net/manual/en/function.json-decode.php

public static jsonEncode( $value, int $options = 0, int $depth = 512) : string

Wrapper for JSON encoding that throws when an error occurs.

param phpDocumentor\Reflection\Types\Mixed_ $value The value being encoded
param phpDocumentor\Reflection\Types\Integer $options JSON encode option bitmask
param phpDocumentor\Reflection\Types\Integer $depth Set the maximum depth. Must be greater than zero.
throws phpDocumentor\Reflection\Types\Object_ if the JSON cannot be encoded.
link https://www.php.net/manual/en/function.json-encode.php

public static normalizeHeaderKeys(array $headers) : array

Creates an associative array of lowercase header names to the actual
header casing.

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only