Copied!
Cloneable Final Instantiable
Methods
public static caselessRemove ( $keys , array $data )
 

Remove the items given by the keys, case insensitively from the data.

  • return array
public static copyToStream ( Psr\Http\Message\StreamInterface $source , Psr\Http\Message\StreamInterface $dest , $maxLen = -1 )
 

Copy the contents of a stream into another stream until the given number
of bytes have been read.

  • throws RuntimeException on error.
public static copyToString ( Psr\Http\Message\StreamInterface $stream , $maxLen = -1 )
 

Copy the contents of a stream into a string until the given number of
bytes have been read.

  • return string
  • throws RuntimeException on error.
public static hash ( Psr\Http\Message\StreamInterface $stream , $algo , $rawOutput = false )
 

Calculate a hash of a stream.

This method reads the entire stream to calculate a rolling hash, based
on PHP's hash_init functions.

  • return string Returns the hash of the stream
  • throws RuntimeException on error.
public static modifyRequest ( Psr\Http\Message\RequestInterface $request , array $changes )
 

Clone and modify a request with the given changes.

This method is useful for reducing the number of clones needed to mutate
a message.

The changes can be one of:

  • method: (string) Changes the HTTP method.
  • set_headers: (array) Sets the given headers.
  • remove_headers: (array) Remove the given headers.
  • body: (mixed) Sets the given body.
  • uri: (UriInterface) Set the URI.
  • query: (string) Set the query string value of the URI.
  • version: (string) Set the protocol version.
  • return RequestInterface
public static readLine ( Psr\Http\Message\StreamInterface $stream , $maxLength = NULL )
 

Read a line from the stream up to the maximum allowed buffer length.

  • return string
public static streamFor ( $resource = '' , array $options = [ ] )
 

Create a new stream based on the input type.

Options is an associative array that can contain the following keys:

  • metadata: Array of custom metadata.
  • size: Size of the stream.

This method accepts the following $resource types:

  • Psr\Http\Message\StreamInterface: Returns the value as-is.
  • string: Creates a stream object that uses the given string as the contents.
  • resource: Creates a stream object that wraps the given PHP stream resource.
  • Iterator: If the provided value implements Iterator, then a read-only
    stream object will be created that wraps the given iterable. Each time the
    stream is read from, data from the iterator will fill a buffer and will be
    continuously called until the buffer is equal to the requested read size.
    Subsequent read calls will first read from the buffer and then call next
    on the underlying iterator until it is exhausted.
  • object with __toString(): If the object has the __toString() method,
    the object will be cast to a string and then a stream will be returned that
    uses the string value.
  • NULL: When null is passed, an empty stream object is returned.
  • callable When a callable is passed, a read-only stream object will be
    created that invokes the given callable. The callable is invoked with the
    number of suggested bytes to read. The callable can return any number of
    bytes, but MUST return false when there is no more data to return. The
    stream object that wraps the callable will invoke the callable until the
    number of requested bytes are available. Any additional bytes will be
    buffered and used in subsequent reads.
  • return StreamInterface
  • throws InvalidArgumentException if the $resource arg is not valid.
public static tryFopen ( $filename , $mode )
 

Safely opens a PHP stream resource using a filename.

When fopen fails, PHP normally raises a warning. This function adds an
error handler that checks for errors and throws an exception instead.

  • return resource
  • throws RuntimeException if the file cannot be opened
public static uriFor ( $uri )
 

Returns a UriInterface for the given value.

This function accepts a string or UriInterface and returns a
UriInterface for the given value. If the value is already a
UriInterface, it is returned as-is.

  • return UriInterface
  • throws InvalidArgumentException
Methods
public static caselessRemove ( $keys , array $data )
 

Remove the items given by the keys, case insensitively from the data.

  • return array
public static copyToStream ( Psr\Http\Message\StreamInterface $source , Psr\Http\Message\StreamInterface $dest , $maxLen = -1 )
 

Copy the contents of a stream into another stream until the given number
of bytes have been read.

  • throws RuntimeException on error.
public static copyToString ( Psr\Http\Message\StreamInterface $stream , $maxLen = -1 )
 

Copy the contents of a stream into a string until the given number of
bytes have been read.

  • return string
  • throws RuntimeException on error.
public static hash ( Psr\Http\Message\StreamInterface $stream , $algo , $rawOutput = false )
 

Calculate a hash of a stream.

This method reads the entire stream to calculate a rolling hash, based
on PHP's hash_init functions.

  • return string Returns the hash of the stream
  • throws RuntimeException on error.
public static modifyRequest ( Psr\Http\Message\RequestInterface $request , array $changes )
 

Clone and modify a request with the given changes.

This method is useful for reducing the number of clones needed to mutate
a message.

The changes can be one of:

  • method: (string) Changes the HTTP method.
  • set_headers: (array) Sets the given headers.
  • remove_headers: (array) Remove the given headers.
  • body: (mixed) Sets the given body.
  • uri: (UriInterface) Set the URI.
  • query: (string) Set the query string value of the URI.
  • version: (string) Set the protocol version.
  • return RequestInterface
public static readLine ( Psr\Http\Message\StreamInterface $stream , $maxLength = NULL )
 

Read a line from the stream up to the maximum allowed buffer length.

  • return string
public static streamFor ( $resource = '' , array $options = [ ] )
 

Create a new stream based on the input type.

Options is an associative array that can contain the following keys:

  • metadata: Array of custom metadata.
  • size: Size of the stream.

This method accepts the following $resource types:

  • Psr\Http\Message\StreamInterface: Returns the value as-is.
  • string: Creates a stream object that uses the given string as the contents.
  • resource: Creates a stream object that wraps the given PHP stream resource.
  • Iterator: If the provided value implements Iterator, then a read-only
    stream object will be created that wraps the given iterable. Each time the
    stream is read from, data from the iterator will fill a buffer and will be
    continuously called until the buffer is equal to the requested read size.
    Subsequent read calls will first read from the buffer and then call next
    on the underlying iterator until it is exhausted.
  • object with __toString(): If the object has the __toString() method,
    the object will be cast to a string and then a stream will be returned that
    uses the string value.
  • NULL: When null is passed, an empty stream object is returned.
  • callable When a callable is passed, a read-only stream object will be
    created that invokes the given callable. The callable is invoked with the
    number of suggested bytes to read. The callable can return any number of
    bytes, but MUST return false when there is no more data to return. The
    stream object that wraps the callable will invoke the callable until the
    number of requested bytes are available. Any additional bytes will be
    buffered and used in subsequent reads.
  • return StreamInterface
  • throws InvalidArgumentException if the $resource arg is not valid.
public static tryFopen ( $filename , $mode )
 

Safely opens a PHP stream resource using a filename.

When fopen fails, PHP normally raises a warning. This function adds an
error handler that checks for errors and throws an exception instead.

  • return resource
  • throws RuntimeException if the file cannot be opened
public static uriFor ( $uri )
 

Returns a UriInterface for the given value.

This function accepts a string or UriInterface and returns a
UriInterface for the given value. If the value is already a
UriInterface, it is returned as-is.

  • return UriInterface
  • throws InvalidArgumentException
© 2020 Bruce Wells
Search Namespaces \ Classes
Configuration Numbers (0-9.) only