hoa/fastcgi

The Hoa\Fastcgi library.

3.19.03.08 2019-03-08 08:29 UTC

README

Hoa

Build status Code coverage Packagist License

Hoa is a modular, extensible and structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.

Hoa\Fastcgi

Help on IRC Help on Gitter Documentation Board

This library allows to manipulate the FastCGI protocol, which ensures the communication between a HTTP server and an external program (such as PHP).

Learn more.

Installation

With Composer, to include this library into your dependencies, you need to require hoa/fastcgi:

$ composer require hoa/fastcgi '~3.0'

For more installation procedures, please read the Source page.

Testing

Before running the test suites, the development dependencies must be installed:

$ composer install

Then, to run all the test suites:

$ vendor/bin/hoa test:run

For more information, please read the contributor guide.

Quick usage

As a quick overview, we propose to execute a PHP file through the FastCGI protocol directly.

Before starting, we need to know that PHP proposes two tools that support FastCGI: php-cgi and php-fpm (for FastCGI Process Manager). We will use php-cgi in local with the standard port 9000 in TCP:

$ php-cgi -b 127.0.0.1:9000

First, we write the Echo.php file, the one we are likely to execute:

<?php

echo 'foobar';

Second, we need to open a connexion to the FastCGI server and send a query with the following headers:

  • SCRIPT_FILENAME which represents the absolute path to the PHP file to execute;
  • REQUEST_METHOD which represents the HTTP method among GET, POST, PUT, DELETE etc.;
  • REQUEST_URI which represents the identifier of the resource we are trying to access.

Thus:

$fastcgi = new Hoa\Fastcgi\Responder(
    new Hoa\Socket\Client('tcp://127.0.0.1:9000')
);
var_dump($fastcgi->send([
    'REQUEST_METHOD'  => 'GET',
    'REQUEST_URI'     => '/',
    'SCRIPT_FILENAME' => __DIR__ . DS . 'Echo.php'
]));
// string(6) "foobar"

We can get the headers from the executed file by calling the Hoa\Fastcgi\Responder::getResponseHeaders method.

This is a good and fast way to execute PHP files (or other programs that support FastCGI) without worrying about binary locations, subshell calls, error handling, etc.

Documentation

The hack book of Hoa\Fastcgi contains detailed information about how to use this library and how it works.

To generate the documentation locally, execute the following commands:

$ composer require --dev hoa/devtools
$ vendor/bin/hoa devtools:documentation --open

More documentation can be found on the project's website: hoa-project.net.

Getting help

There are mainly two ways to get help:

Contribution

Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.

License

Hoa is under the New BSD License (BSD-3-Clause). Please, see LICENSE for details.