This package is abandoned and no longer maintained
We suggests using the spiral/roadrunner-laravel package instead

[RoadRunner][roadrunner] ⇆ Laravel bridge

[![Version][badgepackagistversion]][linkpackagist] [![Version][badgephpversion]][link_packagist] [![Build Status][badgebuildstatus]][linkbuildstatus] [![Coverage][badgecoverage]][linkcoverage] [![Downloads count][badgedownloadscount]][link_packagist] [![License][badgelicense]][link_license]

Easy way for connecting [RoadRunner][roadrunner] and [Laravel][laravel] applications.

Installation

Require this package with composer using next command:

shell script
$ composer require avto-dev/roadrunner-laravel "^3.3"

Installed

composer

is required ([how to install composer][getcomposer]).

You need to fix the major version of package.

Previous major versions still available, but it's development is abandoned. Use only latest major version!

After that you can "publish" package configuration file (

./config/roadrunner.php

shell script
$ php ./artisan vendor:publish --provider='AvtoDev\RoadRunnerLaravel\ServiceProvider' --tag=config

And basic RoadRunner configuration file (

./.rr.yaml.dist

shell script
$ php ./artisan vendor:publish --provider='AvtoDev\RoadRunnerLaravel\ServiceProvider' --tag=rr-config

After that you can modify configuration files as you wish.

Important: despite the fact that worker allows you to refresh application instance on each HTTP request (if environment variable `APPREFRESH

set to

Usage

After package installation you can use provided "binary" file as RoadRunner worker:

./vendor/bin/rr-worker

BeforeLoopStartedEvent

BeforeLoopIterationEvent

BeforeRequestHandlingEvent

AfterRequestHandlingEvent

AfterLoopIterationEvent

AfterLoopStoppedEvent

LoopErrorOccurredEvent

Simple

.rr.yaml

env:
  #APP_REFRESH: true

http:
  address: 0.0.0.0:8080
  workers:
    command: 'php ./vendor/bin/rr-worker'
static:
  dir: 'public'

Roadrunner server starting:

shell script
$ rr -c ./.rr.yaml serve -d

Listeners

This package provides event listeners for resetings application state without full application reload (like cookies, HTTP request, application instance, service-providers and other). Some of them already declared in configuration file, but you can declare own without any limitations.

Environment variables

You can use the following environment variables:

APP_FORCE_HTTPS

APP_REFRESH

Known issues

Controller constructors

You should avoid to use HTTP controller constructors (created or resolved instances in constructor can be shared between different requests). Use dependencies resolving in controller methods instead.

Bad:

class UserController extends Controller
{
    /**
     * The user repository instance.
     */
    protected $users;

/**
 * @var Request
 */
protected $request;

/**
 * @param UserRepository $users
 * @param Request        $request
 */
public function __construct(UserRepository $users, Request $request)
{
    $this->users   = $users;
    $this->request = $request;
}

/**
 * @return Response
 */
public function store(): Response
{
    $user = $this->users->getById($this->request->id);

    // ...
}
}

Good:

class UserController extends Controller
{
    /**
     * @param  Request        $request
     * @param  UserRepository $users
     *
     * @return Response
     */
    public function store(Request $request, UserRepository $users): Response
    {
        $user = $users->getById($request->id);

    // ...
}
}

Middleware constructors

You should never to use middleware constructor for

session

session.store

auth

Guard

Request

Bad:

class Middleware
{
    /**
     * @var Store
     */
    protected $session;

/**
 * @param Store $session
 */
public function __construct(Store $session)
{
    $this->session = $session;
}

/**
 * Handle an incoming request.
 *
 * @param Request  $request
 * @param \Closure $next
 *
 * @return mixed
 */
public function handle(Request $request, Closure $next)
{
    $name = $this->session->getName();

    // ...

    return $next($request);
}
}

Good:

class Middleware
{
    /**
     * Handle an incoming request.
     *
     * @param Request  $request
     * @param \Closure $next
     *
     * @return mixed
     */
    public function handle(Request $request, Closure $next)
    {
        $name = $request->session()->getName();
        // $name = resolve('session')->getName();

    // ...

    return $next($request);
}
}

Testing

For package testing we use

phpunit

docker-ce

docker-compose

shell script
$ make build
$ make latest # or 'make lowest'
$ make test

Changes log

[![Release date][badgereleasedate]][linkreleases] [![Commits since latest release][badgecommitssince_release]][linkcommits]

Changes log can be [found here][linkchangeslog].

Support

[![Issues][badgeissues]][link_issues] [![Issues][badgepulls]][link_pulls]

If you will find any package errors, please, [make an issue][linkcreateissue] in current repository.

License

This is open-sourced software licensed under the [MIT License][link_license].

[badgepackagistversion]:https://img.shields.io/packagist/v/avto-dev/roadrunner-laravel.svg?maxAge=180 [badgephpversion]:https://img.shields.io/packagist/php-v/avto-dev/roadrunner-laravel.svg?longCache=true [badgebuildstatus]:https://travis-ci.org/avto-dev/roadrunner-laravel.svg?branch=master [badgecoverage]:https://img.shields.io/codecov/c/github/avto-dev/roadrunner-laravel/master.svg?maxAge=60 [badgedownloadscount]:https://img.shields.io/packagist/dt/avto-dev/roadrunner-laravel.svg?maxAge=180 [badgelicense]:https://img.shields.io/packagist/l/avto-dev/roadrunner-laravel.svg?longCache=true [badgereleasedate]:https://img.shields.io/github/release-date/avto-dev/roadrunner-laravel.svg?style=flat-square&maxAge=180 [badgecommitssincerelease]:https://img.shields.io/github/commits-since/avto-dev/roadrunner-laravel/latest.svg?style=flat-square&maxAge=180 [badgeissues]:https://img.shields.io/github/issues/avto-dev/roadrunner-laravel.svg?style=flat-square&maxAge=180 [badgepulls]:https://img.shields.io/github/issues-pr/avto-dev/roadrunner-laravel.svg?style=flat-square&maxAge=180 [linkreleases]:https://github.com/avto-dev/roadrunner-laravel/releases [linkpackagist]:https://packagist.org/packages/avto-dev/roadrunner-laravel [linkbuildstatus]:https://travis-ci.org/avto-dev/roadrunner-laravel [linkcoverage]:https://codecov.io/gh/avto-dev/roadrunner-laravel/ [linkchangeslog]:https://github.com/avto-dev/roadrunner-laravel/blob/master/CHANGELOG.md [linkissues]:https://github.com/avto-dev/roadrunner-laravel/issues [linkcreateissue]:https://github.com/avto-dev/roadrunner-laravel/issues/new/choose [linkcommits]:https://github.com/avto-dev/roadrunner-laravel/commits [linkpulls]:https://github.com/avto-dev/roadrunner-laravel/pulls [linklicense]:https://github.com/avto-dev/roadrunner-laravel/blob/master/LICENSE [getcomposer]:https://getcomposer.org/download/ [roadrunner]:https://github.com/spiral/roadrunner [laravel]:https://laravel.com [laravel_events]:https://laravel.com/docs/events [#10]:https://github.com/avto-dev/roadrunner-laravel/issues/10