https://github.com/yiisoft/yii-runner-http
Yii HTTP Runner
https://github.com/yiisoft/yii-runner-http
hacktoberfest http runner yii3
Last synced: 3 months ago
JSON representation
Yii HTTP Runner
- Host: GitHub
- URL: https://github.com/yiisoft/yii-runner-http
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2021-11-02T09:42:53.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-04T15:07:43.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T00:31:14.773Z (almost 2 years ago)
- Topics: hacktoberfest, http, runner, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 129 KB
- Stars: 10
- Watchers: 20
- Forks: 4
- Open Issues: 3
-
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 Runner
[](https://packagist.org/packages/yiisoft/yii-runner-http)
[](https://packagist.org/packages/yiisoft/yii-runner-http)
[](https://github.com/yiisoft/yii-runner-http/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/yii-runner-http)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-runner-http/master)
[](https://github.com/yiisoft/yii-runner-http/actions/workflows/static.yml?query=branch%3Amaster)
[](https://shepherd.dev/github/yiisoft/yii-runner-http)
The package contains a bootstrap for running Yii3 HTTP application.
## Requirements
- PHP 8.1 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/yii-runner-http
```
## General usage
In your HTTP entry script do the following:
```php
use Yiisoft\Yii\Runner\Http\HttpApplicationRunner;
require_once __DIR__ . '/autoload.php';
(new HttpApplicationRunner(
rootPath: __DIR__,
debug: $_ENV['YII_DEBUG'],
checkEvents: $_ENV['YII_DEBUG'],
environment: $_ENV['YII_ENV']
))->run();
```
### Additional configuration
By default, the `HttpApplicationRunner` is configured to work with Yii application templates and follows the
[config groups convention](https://github.com/yiisoft/docs/blob/master/022-config-groups.md).
You can override the default configuration using constructor parameters and immutable setters.
#### Constructor parameters
`$rootPath` — the absolute path to the project root.
`$debug` — whether the debug mode is enabled.
`$checkEvents` — whether check events' configuration.
`$environment` — the environment name.
`$bootstrapGroup` — the bootstrap configuration group name.
`$eventsGroup` — the events' configuration group name.
`$diGroup` — the container definitions' configuration group name.
`$diProvidersGroup` — the container providers' configuration group name.
`$diDelegatesGroup` — the container delegates' configuration group name.
`$diTagsGroup` — the container tags' configuration group name.
`$paramsGroup` — the config parameters group name.
`$nestedParamsGroups` — configuration group names that are included into config parameters group. This is needed for
recursive merge parameters.
`$nestedEventsGroups` — configuration group names that are included into events' configuration group. This is needed for
reverse and recursive merge events' configurations.
`$configModifiers` — [configuration modifiers](https://github.com/yiisoft/config#configuration-modifiers).
`$configDirectory` — the relative path from `$rootPath` to the configuration storage location.
`$vendorDirectory` — the relative path from `$rootPath` to the vendor directory.
`$configMergePlanFile` — the relative path from `$configDirectory` to merge plan.
`$logger` — the logger to collect errors while container is building.
`$bufferSize` — the size of the buffer in bytes to send the content of the message body (default, 8Mb).
`$temporaryErrorHandler` — a temporary error handler that is needed to handle creating of configuration and container
instances.
`$emitter` — an emitter to send the response.
`$useRemoveBodyByStatusMiddleware` — whether to remove the body of the response for specific response status codes.
`$useContentLengthMiddleware` — whether to manage the `Content-Length` header to the response.
`$useHeadRequestMiddleware` — whether to remove the body of the response for HEAD requests.
#### Immutable setters
If the configuration instance settings differ from the default you can specify a customized configuration instance:
```php
/**
* @var Yiisoft\Config\ConfigInterface $config
* @var Yiisoft\Yii\Runner\Http\HttpApplicationRunner $runner
*/
$runner = $runner->withConfig($config);
```
The default container is `Yiisoft\Di\Container`. But you can specify any implementation
of the `Psr\Container\ContainerInterface`:
```php
/**
* @var Psr\Container\ContainerInterface $container
* @var Yiisoft\Yii\Runner\Http\HttpApplicationRunner $runner
*/
$runner = $runner->withContainer($container);
```
In addition to the error handler that is defined in the container, the runner uses a temporary error handler.
A temporary error handler is needed to handle the creation of configuration and container instances,
then the error handler configured in your application configuration will be used.
By default, the temporary error handler uses HTML renderer and logging to a file. You can override this as follows:
```php
/**
* @var Psr\Log\LoggerInterface $logger
* @var Yiisoft\ErrorHandler\Renderer\PlainTextRenderer $renderer
* @var Yiisoft\Yii\Runner\Http\HttpApplicationRunner $runner
*/
$runner = $runner->withTemporaryErrorHandler(
new Yiisoft\ErrorHandler\ErrorHandler($logger, $renderer),
);
```
## 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 Runner 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
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)