slim/http

Slim PSR-7 Object Decorators

Maintainers

Details

github.com/slimphp/Slim-Http

Homepage

Source

Issues

Installs: 1 611 011

Dependents: 69

Suggesters: 1

Security: 0

Stars: 151

Watchers: 15

Forks: 46

Open Issues: 6

1.4.0 2024-06-24 18:27 UTC

Requires

Requires (Dev)

MIT a8def7b8e9eabd0cdc21654ad4a82606942e066a

httppsr-7psr7

This package is auto-updated.

Last update: 2024-11-24 19:21:10 UTC

README

Slim PSR-7 Object Decorators

Build Status Coverage Status Total Downloads License

Installation

It's recommended that you use Composer to install this library.

$ composer require slim/http

This will install the slim/http component and all required dependencies. PHP 7.4, or newer, is required.

Tests

To execute the test suite, you'll need to install all development dependencies.

$ git clone https://github.com/slimphp/Slim-Http
$ composer install
$ composer test

Usage

The Decoration Repo Provides 3 Factories which instantiate the Decorators. They respectively return PSR-7 Compatible Interfaces.

  • DecoratedResponseFactory
  • DecoratedServerRequestFactory
  • DecoratedUriFactory

Example for Instantiating a Decorated Nyholm/Psr7 Response

<?php

use Nyholm\Psr7\Factory\Psr17Factory;
use Slim\Http\Factory\DecoratedResponseFactory;

$nyholmFactory = new Psr17Factory();

/**
 * DecoratedResponseFactory takes 2 parameters
 * @param \Psr\Http\Message\ResponseFactoryInterface which should be a ResponseFactory originating from the PSR-7 Implementation of your choice
 * @param \Psr\Http\Message\StreamFactoryInterface which should be a StreamFactory originating from the PSR-7 Implementation of your choice
 * Note: Nyholm/Psr17 has one factory which implements Both ResponseFactoryInterface and StreamFactoryInterface see https://github.com/Nyholm/psr7/blob/master/src/Factory/Psr17Factory.php
 */
$decoratedResponseFactory = new DecoratedResponseFactory($nyholmFactory, $nyholmFactory);

/**
 * @var \Slim\Http\Response $response
 * The returned variable is a Response which has methods like withJson()
 */
$response = $decoratedResponseFactory->createResponse(200, 'OK');
$response = $response->withJson(['data' => [1, 2, 3]]);

Example for Instantiating a Decorated Laminas Diactoros Response

<?php

use Laminas\Diactoros\ResponseFactory;
use Laminas\Diactoros\StreamFactory;
use Slim\Http\Factory\DecoratedResponseFactory;

$responseFactory = new ResponseFactory();
$streamFactory = new StreamFactory();

/**
 * DecoratedResponseFactory takes 2 parameters
 * @param \Psr\Http\Message\ResponseFactoryInterface which should be a ResponseFactory originating from the PSR-7 Implementation of your choice
 * @param \Psr\Http\Message\StreamFactoryInterface which should be a StreamFactory originating from the PSR-7 Implementation of your choice
 */
$decoratedResponseFactory = new DecoratedResponseFactory($responseFactory, $streamFactory);

/**
 * @var \Slim\Http\Response $response
 * The returned variable is a Response which has methods like withJson()
 */
$response = $decoratedResponseFactory->createResponse(200, 'OK');
$response = $response->withJson(['data' => [1, 2, 3]]);

Decorated Response Object Methods

The decorated ResponseInterface provides the following additional methods:

Response::withJson($data, $status, $options, $depth)

Response::withFileDownload($file, $name)

Triggers the client to download the specified file.

Response::withFile($file, $contentType)

Response with file to client

Response::withRedirect($url, $status)

Response::write($data)

Response::isClientError()

Assert the underlying response's status code is between 400 and 500.

Response::isEmpty()

Assert the underlying response's status code is 204, 205 or 304.

Response::isForbidden()

Assert the underlying response's status code is 403.

Response::isInformational()

Assert the underlying response's status code is between 100 and 200.

Response::isOk()

Assert the underlying response's status code is 200.

Response::isNotFound()

Assert the underlying response's status code is 404.

Response::isRedirect()

Assert the underlying response's status code is 301, 302, 303, 307 or 308.

Response::isRedirection()

Assert the underlying response's status code is between 300 and 400.

Response::isServerError()

Assert the underlying response's status code is between 500 and 600.

Response::isSuccessful()

Assert the underlying response's status code is between 200 and 300.

Response::__toString()

Will return a string formatted representation of the underlying response object.

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{"Hello": "World"}

Decorated ServerRequest Object Methods

The decorated ServerRequestInterface provides the following additional methods:

ServerRequest::withAttributes($attributes)

ServerRequest::getContentCharset()

Returns the detected charset from the Content-Type header of the underlying server request object. Returns null if no value is present.

ServerRequest::getContentType()

Returns the value from the Content-Type header of the underlying server request object. Returns null if no value is present.

ServerRequest::getContentLength()

Returns the value from the Content-Length header of the underlying server request object. Returns null if no value is present.

ServerRequest::getCookieParam($key, $default)

ServerRequest::getMediaType()

Returns the first detected value from the Content-Type header of the underlying server request object. Returns null if no value is present.

ServerRequest::getMediaTypeParams()

Returns an array of detected values from the Content-Type header of the underlying server request object. Returns an empty array if no values are present.

ServerRequest::getParam($key, $default)

Returns the value from key in $_POST or $_GET

ServerRequest::getParams()

Returns a merged associative array of the $_POST and $_GET parameters.

ServerRequest::getParsedBody()

Returns the parsed body from the underlying server request object if it already has been parsed by the underlying PSR-7 implementation. If the parsed body is empty, our decorator attempts to detect the content type and parse the body using one of the registered media type parsers.

The default media type parsers support:

  • JSON
  • XML

You can register your own media type parser using the ServerRequest::registerMediaTypeParser() method.

ServerRequest::getParsedBodyParam($key, $default)

Returns the value from key in the parsed body of the underlying server request object.

ServerRequest::getQueryParam($key, $default)

Returns the value from key in the parsed ServerRequest query string

ServerRequest::getServerParam($key, $default)

Returns the value from key in parsed server parameters from the underlying underlying server request object.

ServerRequest::registerMediaTypeParser($key, $default)

Returns the value from key in parsed server parameters from the underlying server request object.

ServerRequest::isMethod($method)

ServerRequest::isDelete()

Asserts that the underlying server request's method is DELETE

ServerRequest::isGet()

Asserts that the underlying server request's method is GET

ServerRequest::isHead()

Asserts that the underlying server request's method is HEAD

ServerRequest::isOptions()

Asserts that the underlying server request's method is OPTIONS

ServerRequest::isPatch()

Asserts that the underlying server request's method is PATCH

ServerRequest::isPost()

Asserts that the underlying server request's method is POST

ServerRequest::isPut()

Asserts that the underlying server request's method is PUT

ServerRequest::isXhr()

Asserts that the header X-Requested-With from the underlying server request is XMLHttpRequest

Decorated Uri Object Methods

The decorated UriInterface provides the following additional methods:

Uri::getBaseUrl()

Returns the fully qualified base URL of the underlying uri object.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover security related issues, please email security@slimframework.com instead of using the issue tracker.

Credits

License

This component is licensed under the MIT license. See License File for more information.