SetaFramework API Reference

Parameters

$html : string|\Psr\Http\Message\StreamInterface

HTML or stream for the message body.

$status : int

Integer status code for the response; 200 by default.

$headers : array

Array of headers to use at initialization.

Create a JSON response with the given data.

Default JSON encoding is performed with the following options, which produces RFC4627-compliant JSON, capable of embedding into HTML.

• JSON_HEX_TAG
• JSON_HEX_APOS
• JSON_HEX_AMP
• JSON_HEX_QUOT
• JSON_UNESCAPED_SLASHES

Parameters

$data : mixed

Data to convert to JSON.

$status : int

Integer status code for the response; 200 by default.

$headers : array

Array of headers to use at initialization.

$encodingOptions : int

JSON encoding options to use.

Exceptions

Throws \JsonException

Parameters

$uri : string|\Psr\Http\Message\UriInterface

 

$isExternal : bool

If false the url will be prepended with the requestPathPrefix.

$status : int

 

$headers : array

 

Create a new request.

Parameters

$method : string

The HTTP method associated with the request.

$uri : \Psr\Http\Message\UriInterface|string

The URI associated with the request. If the value is a string, the factory MUST create a UriInterface instance based on it.

Create a new response.

Parameters

$code : int

HTTP status code; defaults to 200

$reasonPhrase : string

Reason phrase to associate with status code in generated response; if none is provided implementations MAY use the defaults as suggested in the HTTP specification.

Create a new server request.

Note that server-params are taken precisely as given - no parsing/processing of the given values is performed, and, in particular, no attempt is made to determine the HTTP method or URI, which must be provided explicitly.

Parameters

$method : string

The HTTP method associated with the request.

$uri : \Psr\Http\Message\UriInterface|string

The URI associated with the request. If the value is a string, the factory MUST create a UriInterface instance based on it.

$serverParams : array

Array of SAPI parameters with which to seed the generated request instance.

Create a new stream from a string.

The stream SHOULD be created with a temporary resource.

Parameters

$content : string

String content with which to populate the stream.

Create a stream from an existing file.

The file MUST be opened using the given mode, which may be any mode supported by the fopen function.

The $filename MAY be any string supported by fopen().

Parameters

$filename : string

Filename or stream URI to use as basis of stream.

$mode : string

Mode with which to open the underlying filename/stream.

Exceptions

Throws \RuntimeException If the file cannot be opened.

Throws \InvalidArgumentException If the mode is invalid.

Create a new stream from an existing resource.

The stream MUST be readable and may be writable.

Parameters

$resource : resource

PHP resource to use as basis of stream.

Create a new uploaded file.

If a size is not provided it will be determined by checking the size of the file.

Parameters

$stream : \Psr\Http\Message\StreamInterface

Underlying stream representing the uploaded file content.

$size : ?int

in bytes

$error : int

PHP file upload error

$clientFilename : ?string

Filename as provided by the client, if any.

$clientMediaType : ?string

Media type as provided by the client, if any.

Exceptions

Throws \InvalidArgumentException If the file resource is not readable.

See

• http://php.net/manual/features.file-upload.post-method.php
• http://php.net/manual/features.file-upload.errors.php

Create a new URI.

Parameters

$uri : string

 

Exceptions

Throws \InvalidArgumentException If the given URI cannot be parsed.