shieldon/psr-http

HTTP implementation for PSR standard.

1.2.7 2023-06-06 07:59 UTC

Requires

• php: >=7.1.0
• psr/http-factory: ^1.0
• psr/http-message: ^1.1 || ^2.0
• psr/http-server-handler: ^1.0
• psr/http-server-middleware: ^1.0

Requires (Dev)

• phpunit/phpunit: ^9

MIT

• Terry Lin

• psr7
• php-http
• psr-17
• psr-15

README

This library is a PSR HTTP implementation created for Shieldon firewall 2 , following up the PSR (PHP Standard Recommendation) documents by one hundred percent.

• PSR-7 (HTTP Message Interfaces)
• PSR-15 (HTTP Server Request Handlers)
• PSR-17 (HTTP Factories)

Test Status

Shiledon PSR-HTTP library is strictly tested by unit tests contain almost all conditions that might be happened, if you find any bug or something that can improve this library, please let me know.

You can use it on any framework which is compatible with those PSRs.

Install

composer require shieldon/psr-http

Test

composer install
composer test

Quick Start

The simplest way to start implementing PSR-7 on your PHP applications, let's check out the examples below.

Create a server request.

$serverRequest = ServerRequestFactory::fromGlobal();

Create a request.

$request = RequestFactory::fromNew();

Create a server response

$response = ResponseFactory::fromNew();

Create a URI.

// Create a URI contains visitor's information.

/**
 *  Assume a visior is viewing your website page, 
 *  for example, https://yoursite/en/post1.html
 */
$uri = UriFactory::fromGlobal();

echo $uri->getPath();
// Outputs: /en/post1.html

// Create a URI just a new instance.
$uri = UriFactory::fromNew();

echo $uri->getPath();
// Outputs: 

Create a stream instance.

// Create a stream just a new instance.
$stream = StreamFactory::fromNew();

Create an array with UploadedFile structure.

// Let's see the following example, 
// assume we have a superglobal $_FILES looks like this.
$_FILES = [
    'foo' => [
        'name' => 'example1.jpg',
        'type' => 'image/jpeg',
        'tmp_name' => '/tmp/php200A.tmp',
        'error' => 0,
        'size' => 100000,
    ]
];

$uploadFileArr = UploadedFileFactory::fromGlobal();

echo $uploadFileArr['foo']->getClientFilename();
// Outputs: example1.jpg

Table of Contents

• PSR-17: HTTP Factories

  • RequestFactory

    • createRequest
    • ::fromNew (Non-PSR)

  • ServerRequestFactory

    • createServerRequest
    • ::fromGlobal (Non-PSR)

  • ResponseFactory

    • createResponse
    • ::fromNew (Non-PSR)

  • StreamFactory

    • createStream
    • createStreamFromFile
    • createStreamFromResource
    • ::fromNew (Non-PSR)

  • UploadedFileFactory

    • createUploadedFile
    • ::fromGlobal (Non-PSR)

  • UriFactory

    • createUri
    • ::fromGlobal (Non-PSR)
    • ::fromNew (Non-PSR)

• PSR-7: HTTP Message Interfaces

  • Message

    • getProtocolVersion
    • withProtocolVersion
    • setHeaders (Non-PSR)
    • getHeaders
    • hasHeader
    • getHeader
    • getHeaderLine
    • withHeader
    • withAddedHeader
    • withoutHeader
    • getBody
    • withBody

  • Request (externds Message)

    • __construct (Non-PSR)
    • getRequestTarget
    • withRequestTarget
    • getMethod
    • withMethod
    • getUri
    • withUri

  • ServerRequest (externds Request)

    • __construct (Non-PSR)
    • getServerParams
    • getCookieParams
    • withCookieParams
    • getQueryParams
    • withQueryParams
    • getUploadedFiles
    • withUploadedFiles
    • getParsedBody (See explanation below)
    • withParsedBody
    • getAttributes
    • getAttribute
    • withAttribute
    • withoutAttribute

  • Response (externds Message)

    • __construct (Non-PSR)
    • getStatusCode
    • withStatus
    • getReasonPhrase

  • Stream

    • __construct (Non-PSR)
    • isWritable
    • isReadable
    • isSeekable
    • close
    • detach
    • getSize
    • tell
    • eof
    • seek
    • rewind
    • write
    • read
    • getContents
    • getMetadata
    • __toString

  • UploadedFile

    • __construct (Non-PSR)
    • getStream
    • moveTo
    • getSize
    • getError
    • getClientFilename
    • getClientMediaType
    • getErrorMessage (Non-PSR)

  • Uri

    • __construct (Non-PSR)
    • getScheme
    • getAuthority
    • getUserInfo
    • getHost
    • getPort
    • getPath
    • getQuery
    • getFragment
    • withScheme
    • withUserInfo
    • withHost
    • withPort
    • withPath
    • withQuery
    • withFragment
    • __toString

• PSR-15: HTTP Server Request Handlers

  • RequestHandler

    • __construct (Non-PSR)
    • add
    • handle

  • Middleware

    • process

If you are looking for combined examples, see unit testing.

The Behavior of Handling Request Body

Shieldon PSR-HTTP is ready for RESTful, the following content explains how PRS-HTTP deals with the request body.

The getParsedBody method will return:

• (A) An array of the superglobal $_POST if the request request method is POST and the Content-Type is one of the following types:

  • multipart/form-data
  • application/x-www-form-urlencode

• (B) A JSON object if the request fit to the following conditions.

  • The request Content-Type is application/json
  • The request body is a valid JSON-formatted string.
  • The request method is not GET.

• (C) An array parsed from HTTP build query:

  • The condition is neither A or B.
  • The request method is not GET.

• (D) null if the condition is none of above.

Summary

Hope this helps.

Author

Shieldon PSR HTTP library is brought to you by Terry L. from Taiwan.

License

MIT

References

• PSR-7 (HTTP Message Interfaces)
• PSR-15 (HTTP Server Request Handlers)
• PSR-17 (HTTP Factories)