Download the PHP package fyre/server without Composer

FyreServer

FyreServer is a free, open-source immutable HTTP server request/response library for PHP.

Table Of Contents

• Installation
• Server Requests
• Client Responses
• Download Responses
• Redirect Responses
• Uploaded Files

Installation

Using Composer

Server Requests

This class extends the Request class.

• $config is a Config.
• $options is an array containing configuration options.
  • method is a string representing the request method, and will default to the server request method.
  • body is a string representing the request body, and will default to the value of php://input.
  • headers is an array containing headers to set, and will default to the server headers.
  • protocolVersion is a string representing the protocol version, and will default to "1.1".

Default configuration options will be resolved from the "App" key in the Config.

• $options is an array containing configuration options.
  • baseUri is a string representing the base URI to use, and will default to "".
  • defaultLocale is a string representing the default locale, and will default to the system default.
  • supportedLocales is an array containing the supported locales, and will default to [].

Autoloading

It is recommended to bind the ServerRequest to the Container as a singleton.

Any dependencies will be injected automatically when loading from the Container.

Server Request Methods

Get Cookie

Get a value from the $_COOKIE array.

• $key is a string representing the array key using "dot" notation.
• $filter is a number representing the filter to apply, and will default to FILTER_DEFAULT.
• $options is a number or array containing flags to use when filtering, and will default to 0.

If the $key argument is omitted, this method will return an array containing all values.

Get Data

Get a value from the $_POST array or JSON body data.

• $key is a string representing the array key using "dot" notation.
• $filter is a number representing the filter to apply, and will default to FILTER_DEFAULT.
• $options is a number or array containing flags to use when filtering, and will default to 0.

If the $key argument is omitted, this method will return an array containing all values.

Get Default Locale

Get the default locale.

Get Environment

Get a value from the $_ENV array.

• $key is a string representing the array key.
• $filter is a number representing the filter to apply, and will default to FILTER_DEFAULT.
• $options is a number or array containing flags to use when filtering, and will default to 0.

Get File

Get an UploadedFile or array of files from the $_FILE array.

• $key is a string representing the array key using "dot" notation.

If the $key argument is omitted, this method will return an array containing all files.

Get Json

Get a value from JSON body data.

• $key is a string representing the array key using "dot" notation.
• $filter is a number representing the filter to apply, and will default to FILTER_DEFAULT.
• $options is a number or array containing flags to use when filtering, and will default to 0.

If the $key argument is omitted, this method will return an array containing all values.

Get Locale

Get the current locale.

Get Post

Get a value from the $_POST array.

• $key is a string representing the array key using "dot" notation.
• $filter is a number representing the filter to apply, and will default to FILTER_DEFAULT.
• $options is a number or array containing flags to use when filtering, and will default to 0.

If the $key argument is omitted, this method will return an array containing all values.

Get Query

Get a value from the $_GET array.

• $key is a string representing the array key using "dot" notation.
• $filter is a number representing the filter to apply, and will default to FILTER_DEFAULT.
• $options is a number or array containing flags to use when filtering, and will default to 0.

If the $key argument is omitted, this method will return an array containing all values.

Get Server

Get a value from the $_SERVER array.

• $key is a string representing the array key.
• $filter is a number representing the filter to apply, and will default to FILTER_DEFAULT.
• $options is a number or array containing flags to use when filtering, and will default to 0.

If the $key argument is omitted, this method will return an array containing all values.

Get User Agent

Get the user agent.

This method will return a UserAgent.

Is AJAX

Determine whether the request was made using AJAX.

Is CLI

Determine whether the request was made from the CLI.

Is Secure

Determine whether the request is using HTTPS.

Negotiate

Negotiate a value from HTTP headers.

• $type is a string representing the type of negotiation to perform, and must be one of either "content", "encoding" or "language".
• $supported is an array containing the supported values.
• $strict is a boolean indicating whether to not use a default fallback, and will default to false.

Set Locale

Set the current locale.

• $locale is a string representing the locale.

The locale must be present in the supportedLocales property of the ServerRequest $options parameter.

Client Responses

This class extends the Response class.

• $options is an array containing configuration options.
  • body is a string representing the message body, and will default to "".
  • headers is an array containing additional headers to set.
  • protocolVersion is a string representing the protocol version, and will default to "1.1".
  • statusCode is a number representing the status code, and will default to 200.

Delete Cookie

• $name is a string representing the cookie name.
• $options is an array containing cookie options.
  • domain is a string representing the cookie domain, and will default to "".
  • path is a string representing the cookie path, and will default to "/".
  • secure is a boolean indicating whether to set a secure cookie, and will default to false.
  • httpOnly is a boolean indicating whether to the cookie should be HTTP only, and will default to false.
  • sameSite is a string representing the cookie same site, and will default to "Lax".

Get Cookie

• $name is a string representing the cookie name.

This method will return a Cookie.

Has Cookie

Determine whether a cookie has been set.

• $name is a string representing the cookie name.

No Cache

Set headers to prevent browser caching.

Send

Send the response to the client.

Set Content Type

Set the content type header

• $mimeType is a string representing the MIME type.
• $charset is a string representing the character set, and will default to "UTF-8".

Set Cookie

Set a cookie value.

• $name is a string representing the cookie name.
• $value is a string representing the cookie value.
• $options is an array containing cookie options.
  • expires is a number representing the cookie lifetime, and will default to 0.
  • domain is a string representing the cookie domain, and will default to "".
  • path is a string representing the cookie path, and will default to "/".
  • secure is a boolean indicating whether to set a secure cookie, and will default to false.
  • httpOnly is a boolean indicating whether to the cookie should be HTTP only, and will default to false.
  • sameSite is a string representing the cookie same site, and will default to "Lax".

Set Date

Set the date header.

• $date is a string, number or DateTime object representing the date.

Set JSON

Set a JSON response.

• $data is the data to send.

Set Last Modified

Set the last modified date header.

• $date is a string, number or DateTime object representing the date.

Set XML

Set an XML response.

• $data is a SimpleXMLElement containing the data to send.

Download Responses

This class extends the ClientResponse class.

• $path is a string representing the file path.
• $options is an array containing configuration options.
  • filename is a string representing the download filename, and will default to the file name.
  • mimeType is a string representing the MIME type, and will default to the file MIME type.
  • headers is an array containing additional headers to set.
  • protocolVersion is a string representing the protocol version, and will default to "1.1".
  • statusCode is a number representing the status code, and will default to 200.

From Binary

• $data is a string representing the file data.
• $options is an array containing configuration options.
  • filename is a string representing the download filename, and will default to the file name.
  • mimeType is a string representing the MIME type, and will default to the file MIME type.

Get File

Get the download File.

Redirect Responses

This class extends the ClientResponse class.

• $uri is a Uri or string representing the URI to redirect to.
• $code is a number representing the header status code, and will default to 302.
• $options is an array containing configuration options.

Uploaded Files

This class extends the File class.

Client Extension

Get the client extension.

Client MIME Type

Get the client MIME type.

Client Name

Get the client filename.

Error

Get the uploaded error code.

Has Moved

Determine whether the uploaded file has been moved.

Is Valid

Determine whether the uploaded file is valid.

Move To

Move the uploaded file.

• $destination is string representing the destination folder.
• $name is a string representing the new filename, and will default to the client name.

This method will return a new File for the moved file.