README

Yii FrankenPHP Runner

The package contains a bootstrap for running Yii3 applications using FrankenPHP worker mode.

Note: If you do not want to run Yii3 in worker mode, please use yiisoft/yii-runner-http.

Requirements

PHP 8.1 or higher.

Installation

The package could be installed with Composer:

composer require yiisoft/yii-runner-frankenphp

General usage

Create worker.php in your application root directory:

use Yiisoft\Yii\Runner\FrankenPHP\FrankenPHPApplicationRunner;

ini_set('display_errors', 'stderr');

require_once __DIR__ . '/autoload.php';

(new FrankenPHPApplicationRunner(
    rootPath: __DIR__, 
    debug: $_ENV['YII_DEBUG'], 
    checkEvents: $_ENV['YII_DEBUG'], 
    environment: $_ENV['YII_ENV']
))->run();

Run FrankenPHP with the specified config using Docker:

docker run \
    -e FRANKENPHP_CONFIG="worker /app/path/to/your/worker.php" \
    -v $PWD:/app \
    -p 80:80 -p 443:443 -p 443:443/udp \
    dunglas/frankenphp

or, if you prefer standalone binaries:

frankenphp php-server --worker /app/path/to/your/worker.php

You can add --watch="/path/to/your/app/**/*.php" to make the worker restart on source code changes.

Additional configuration

By default, the FrankenPHPApplicationRunner is configured to work with Yii application templates and follows the config groups convention.

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 in a config parameters group. This is needed for recursive merge parameters.

$nestedEventsGroups — configuration group names that are included in events' configuration group. This is needed for reverse and recursive merge events' configurations.

Immutable setters

If the configuration instance settings differ from the default, you can specify a customized configuration instance:

/**
 * @var Yiisoft\Config\ConfigInterface $config
 * @var Yiisoft\Yii\Runner\FrankenPHP\FrankenPHPApplicationRunner $runner
 */

$runner = $runner->withConfig($config);

The default container is Yiisoft\Di\Container. But you can specify any implementation of the Psr\Container\ContainerInterface:

/**
 * @var Psr\Container\ContainerInterface $container
 * @var Yiisoft\Yii\Runner\FrankenPHP\FrankenPHPApplicationRunner $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:

/**
 * @var Psr\Log\LoggerInterface $logger
 * @var Yiisoft\ErrorHandler\Renderer\PlainTextRenderer $renderer
 * @var Yiisoft\Yii\Runner\FrankenPHP\FrankenPHPApplicationRunner $runner
 */

$runner = $runner->withTemporaryErrorHandler(
    new Yiisoft\ErrorHandler\ErrorHandler($logger, $renderer),
);

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

Documentation

Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

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

Maintained by Yii Software.

yiisoft / yii-runner-frankenphp

Maintainers

Details