thecodingmachine/splash-service-provider

Cross-framework module for splash

dev-master / 10.0.x-dev 2020-09-03 16:36 UTC

This package is auto-updated.

Last update: 2024-10-29 05:46:35 UTC


README

Latest Stable Version Latest Unstable Version License Build Status Coverage Status

Splash router universal module

This package integrates thecodingmachine/splash-router in any container-interop compatible framework/container.

Installation

composer require thecodingmachine/splash-service-provider

Once installed, you need to register the TheCodingMachine\Splash\DI\SplashServiceProvider into your container.

If your container supports thecodingmachine/discovery integration, you have nothing to do. Otherwise, refer to your framework or container's documentation to learn how to register service providers.

Introduction

Splash provides a service-provider to be easily integrated in any container-interop/service-provider compatible framework/container.

If you need a complete working sample, check the Splash standalone installation guide.

This service provider will provide a default Splash router.

It requires an instance of Doctrine's annotation reader to be available.

Note: you can get a service provider providing a Doctrine annotation reader using the following packages:

composer require thecodingmachine/doctrine-annotations-universal-module

It will use a PSR-6 cache if the cache is available. Note: you can get a service provider providing a working PSR-6 cache using the following packages:

composer require thecodingmachine/stash-universal-module

This will install Stash and its related service-provider.

Expected values / services

This service provider expects the following configuration / services to be available:

Provided services

This service provider provides the following services:

Extended services

This service provider registers the SplashDefaultRouter::class in the MiddlewareListServiceProvider::MIDDLEWARES_QUEUE.