Inheritance diagram for Sabre\HTTP\Sapi:

Collaboration diagram for Sabre\HTTP\Sapi:

Static Public Member Functions
static	getRequest ()
	This static method will create a new Request object, based on the current PHP request. More...

static	sendResponse (ResponseInterface $response)
	Sends the HTTP response back to a HTTP client. More...

static	createFromServerArray (array $serverArray)
	This static method will create a new Request object, based on a PHP $_SERVER array. More...

Detailed Description

PHP SAPI.

This object is responsible for:

Constructing a Request object based on the current HTTP request sent to the PHP process.
Sending the Response object back to the client.

It could be said that this class provides a mapping between the Request and Response objects, and php's:

$_SERVER
$_POST
$_FILES
php://input
echo()
header()
php://output

You can choose to either call all these methods statically, but you can also instantiate this as an object to allow for polymorhpism.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 31 of file Sapi.php.

Member Function Documentation

◆ createFromServerArray()

static Sabre\HTTP\Sapi::createFromServerArray ( array $serverArray )

static

This static method will create a new Request object, based on a PHP $_SERVER array.

Parameters

array $serverArray

Returns: Request

Definition at line 107 of file Sapi.php.

                                                              {
 
        $headers = [];
        $method = null;
        $url = null;
        $httpVersion = '1.1';
 
        $protocol = 'http';
        $hostName = 'localhost';
 
        foreach ($serverArray as $key => $value) {
 
            switch ($key) {
 
                case 'SERVER_PROTOCOL' :
                    if ($value === 'HTTP/1.0') {
                        $httpVersion = '1.0';
                    }
                    break;
                case 'REQUEST_METHOD' :
                    $method = $value;
                    break;
                case 'REQUEST_URI' :
                    $url = $value;
                    break;
 
                // These sometimes show up without a HTTP_ prefix
                case 'CONTENT_TYPE' :
                    $headers['Content-Type'] = $value;
                    break;
                case 'CONTENT_LENGTH' :
                    $headers['Content-Length'] = $value;
                    break;
 
                // mod_php on apache will put credentials in these variables.
                // (fast)cgi does not usually do this, however.
                case 'PHP_AUTH_USER' :
                    if (isset($serverArray['PHP_AUTH_PW'])) {
                        $headers['Authorization'] = 'Basic ' . base64_encode($value . ':' . $serverArray['PHP_AUTH_PW']);
                    }
                    break;
 
                // Similarly, mod_php may also screw around with digest auth.
                case 'PHP_AUTH_DIGEST' :
                    $headers['Authorization'] = 'Digest ' . $value;
                    break;
 
                // Apache may prefix the HTTP_AUTHORIZATION header with
                // REDIRECT_, if mod_rewrite was used.
                case 'REDIRECT_HTTP_AUTHORIZATION' :
                    $headers['Authorization'] = $value;
                    break;
 
                case 'HTTP_HOST' :
                    $hostName = $value;
                    $headers['Host'] = $value;
                    break;
 
                case 'HTTPS' :
                    if (!empty($value) && $value !== 'off') {
                        $protocol = 'https';
                    }
                    break;
 
                default :
                    if (substr($key, 0, 5) === 'HTTP_') {
                        // It's a HTTP header
 
                        // Normalizing it to be prettier
                        $header = strtolower(substr($key, 5));
 
                        // Transforming dashes into spaces, and uppercasing
                        // every first letter.
                        $header = ucwords(str_replace('_', ' ', $header));
 
                        // Turning spaces into dashes.
                        $header = str_replace(' ', '-', $header);
                        $headers[$header] = $value;
 
                    }
                    break;
 
 
            }
 
        }
 
        $r = new Request($method, $url, $headers);
        $r->setHttpVersion($httpVersion);
        $r->setRawServerData($serverArray);
        $r->setAbsoluteUrl($protocol . '://' . $hostName . $url);
        return $r;
 
    }

References $header, $key, GuzzleHttp\Psr7\$protocol, $r, and $url.

Here is the caller graph for this function:

◆ getRequest()

static Sabre\HTTP\Sapi::getRequest ( )

static

This static method will create a new Request object, based on the current PHP request.

Returns: Request

Definition at line 39 of file Sapi.php.

                                 {
 
        $r = self::createFromServerArray($_SERVER);
        $r->setBody(fopen('php://input', 'r'));
        $r->setPostData($_POST);
        return $r;
 
    }

References $_POST, $_SERVER, $r, and Sabre\HTTP\Sapi\createFromServerArray().

Referenced by Sabre\HTTP\RequestTest\testCreateFromPHPRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendResponse()

static Sabre\HTTP\Sapi::sendResponse ( ResponseInterface $response )

static

Sends the HTTP response back to a HTTP client.

This calls php's header() function and streams the body to php://output.

Parameters

ResponseInterface $response

Returns: void

Reimplemented in Sabre\HTTP\SapiMock.

Definition at line 56 of file Sapi.php.

                                                              {
 
        header('HTTP/' . $response->getHttpVersion() . ' ' . $response->getStatus() . ' ' . $response->getStatusText());
        foreach ($response->getHeaders() as $key => $value) {
 
            foreach ($value as $k => $v) {
                if ($k === 0) {
                    header($key . ': ' . $v);
                } else {
                    header($key . ': ' . $v, false);
                }
            }
 
        }
 
        $body = $response->getBody();
        if (is_null($body)) return;
 
        $contentLength = $response->getHeader('Content-Length');
        if ($contentLength !== null) {
            $output = fopen('php://output', 'wb');
            if (is_resource($body) && get_resource_type($body) == 'stream') {
                if (PHP_INT_SIZE !== 4){
                    // use the dedicated function on 64 Bit systems
                    stream_copy_to_stream($body, $output, $contentLength);
                } else {
                    // workaround for 32 Bit systems to avoid stream_copy_to_stream
                    while (!feof($body)) {
                        fwrite($output, fread($body, 8192));
                    }
                }
            } else {
                fwrite($output, $body, $contentLength);
            }
        } else {
            file_put_contents('php://output', $body);
        }
 
        if (is_resource($body)) {
            fclose($body);
        }
 
    }

References $contentLength, $key, Sabre\VObject\$output, and $response.

Referenced by Sabre\HTTP\SapiTest\testSend(), Sabre\HTTP\SapiTest\testSendLimitedByContentLengthStream(), and Sabre\HTTP\SapiTest\testSendLimitedByContentLengthString().

Here is the caller graph for this function:

The documentation for this class was generated from the following file:

libs/composer/vendor/sabre/http/lib/Sapi.php

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ createFromServerArray()

◆ getRequest()

◆ sendResponse()