Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yiisoft/yii-http

Yii HTTP Application
https://github.com/yiisoft/yii-http

hacktoberfest http yii3

Last synced: about 1 month ago
JSON representation

Yii HTTP Application

Host: GitHub
URL: https://github.com/yiisoft/yii-http
Owner: yiisoft
License: bsd-3-clause
Created: 2021-11-10T20:23:01.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2024-04-04T08:52:52.000Z (8 months ago)
Last Synced: 2024-04-13T23:52:53.747Z (7 months ago)
Topics: hacktoberfest, http, yii3
Language: PHP
Homepage: https://www.yiiframework.com/
Size: 71.3 KB
Stars: 8
Watchers: 17
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md

Awesome Lists containing this project

README

        


    

        

    

    
Yii HTTP Application

    


[![Latest Stable Version](https://poser.pugx.org/yiisoft/yii-http/v)](https://packagist.org/packages/yiisoft/yii-http)

[![Total Downloads](https://poser.pugx.org/yiisoft/yii-http/downloads)](https://packagist.org/packages/yiisoft/yii-http)

[![Build status](https://github.com/yiisoft/yii-http/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/yii-http/actions/workflows/build.yml)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yiisoft/yii-http/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/yii-http/?branch=master)

[![Code Coverage](https://scrutinizer-ci.com/g/yiisoft/yii-http/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/yii-http/?branch=master)

[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fyii-http%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-http/master)

[![static analysis](https://github.com/yiisoft/yii-http/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/yii-http/actions?query=workflow%3A%22static+analysis%22)

[![type-coverage](https://shepherd.dev/github/yiisoft/yii-http/coverage.svg)](https://shepherd.dev/github/yiisoft/yii-http)

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](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-7-http-message.md) interfaces.

## Requirements

- PHP 8.0 or higher.

## Installation

The package could be installed with [Composer](https://getcomposer.org):

```shell

composer require yiisoft/yii-http

```

## 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](https://github.com/yiisoft/yii-runner-http) package.

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

- [HTTP](https://github.com/yiisoft/yii-runner-http)

- [RoadRunner](https://github.com/yiisoft/yii-runner-roadrunner)

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:

```php

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();

}

```

## Documentation

- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.

You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

## License

The Yii HTTP Application is free software. It is released under the terms of the BSD License.

Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

## Support the project

[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)

## Follow updates

[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)

[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)

[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)

[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)

[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)