Skip to content

Guillaume-Rossignol/glide-module

 
 

Repository files navigation

Glide universal module

This package integrates Glide in any definition-interop compatible framework/container.

Installation

composer require mnapoli/glide-module

Once installed, you need to register the definition provider into your container:

$definitionProvider = new \GlideModule\GlideDefinitionProvider();

// register $definitionProvider in your container or framework

Refer to your framework or container's documentation to learn how to register definition-interop modules.

Usage

This module registers the Glide server (League\Glide\Server) under the glide key in your service container. You can now inject it in your services. Have a look at the official documentation to know how to use the server.

Since Glide's server requires the source and cache options to be configured, you must define a glide.options entry in your container. That entry should be an array containing Glide options.

Here is an example using PHP-DI's syntax:

return [
    'glide.options' => [
        'source' => 'path/to/source/folder',
        'cache' => 'path/to/cache/folder',
    ]
];

Here is the same example using Pimple:

$pimple['glide.options'] = [
    'source' => 'path/to/source/folder',
    'cache' => 'path/to/cache/folder',
];

Advanced options

The glide.options array is passed straight to Glide's ServerFactory. Have a look at the official documentation about configuration to learn about all the options you can use.

About

[EXPERIMENTAL] Glide integration for definition-interop compatible frameworks and containers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 100.0%