yiisoft/yii-http

Yii HTTP Application

1.0.0 2021-12-08 19:53 UTC

This package is auto-updated.

Last update: 2022-01-11 13:28:21 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii HTTP Application


Latest Stable Version Total Downloads Build status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

This Yii framework package provides the application class, as well as the events and handlers needed to interact with HTTP. The package is implemented using PSR-7 interfaces.

Requirements

  • PHP 8.0 or higher.

Installation

The package could be installed with composer:

composer require yiisoft/yii-http --prefer-dist

General usage

In case you use one of the Yii 3 standard application templates, then the application is already configured there and is running using yiisoft/yii-runner-http package.

If not, then use one of the HTTP runners that is suitable for your environment:

and create an entry script as described in readme of the packages.

If you do not use Yii HTTP runners, then the code for launching the application in your entry script may look like this:

use Yiisoft\Yii\Http\Application;
use Yiisoft\Yii\Http\Handler\NotFoundHandler;
use Yiisoft\Yii\Http\Handler\ThrowableHandler;

/**
 * @var Psr\EventDispatcher\EventDispatcherInterface $eventDispatcher
 * @var Psr\Http\Message\ResponseFactoryInterface $responseFactory
 * @var Psr\Http\Message\ServerRequestInterface $request
 * @var Yiisoft\ErrorHandler\Middleware\ErrorCatcher $errorCatcher
 * @var Yiisoft\Middleware\Dispatcher\MiddlewareDispatcher $dispatcher
 */

$fallbackHandler = new NotFoundHandler($responseFactory);
$application = new Application($dispatcher, $eventDispatcher, $fallbackHandler);

try {
    $application->start();
    $response = $application->handle($request);
    // Emit a response.
} catch (Throwable $throwable) {
    $handler = new ThrowableHandler($throwable);
    $response = $errorCatcher->process($request, $handler);
    // Emit a response with information about the error.
} finally {
    $application->afterEmit($response ?? null);
    $application->shutdown();
}

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

License

The Yii HTTP Application is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack