Skip to content

About

The package provides the ability to build schema for Cycle ORM from different sources.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

3 watching

Forks

Repository files navigation

Build a Cycle ORM schema from a chain of providers: files, cache, merged sources

Documentation Sponsor Discord

Psalm Level Type Coverage Codecov Mutation testing badge


Cycle ORM uses an object implementing the Cycle\ORM\SchemaInterface interface as a schema. This schema can be constructed from a PHP array with a specific structure. The package at hand offers a comprehensive solution for building a schema from different sources. It includes a collection of providers that implements the Cycle\Schema\Provider\SchemaProviderInterface interface. These providers are grouped in the Cycle\Schema\Provider\Support\SchemaProviderPipeline.

This pipeline orchestrates the execution of providers in a predetermined order, one after another. If one of the providers returns the schema, subsequent providers are not executed.

Get Started

Installation

The package requires PHP 8.2+.

composer require cycle/schema-provider

PHP Latest Version on Packagist License Total Downloads

Usage

Let's explore a straightforward example of schema creation using this package. For example, we have a schema in two php files schema1.php and schema2.php. In this scenario, we can use the Cycle\Schema\Provider\FromFilesSchemaProvider to build the schema from multiple files. Before this provider, we can add a Cycle\Schema\Provider\SimpleCacheSchemaProvider, capable of caching the schema. Upon subsequent schema builds, this provider retrieves the schema from the cache, eliminating the need to build the schema using FromFilesSchemaProvider.

use Cycle\ORM\Schema;
use Cycle\Schema\Provider\FromFilesSchemaProvider;
use Cycle\Schema\Provider\SimpleCacheSchemaProvider;
use Cycle\Schema\Provider\Support\SchemaProviderPipeline;

$pipeline = (new SchemaProviderPipeline($container))->withConfig([
    SimpleCacheSchemaProvider::class => SimpleCacheSchemaProvider::config(key: 'cycle-schema'),
    FromFilesSchemaProvider::class => FromFilesSchemaProvider::config(files: [
        'runtime/schema1.php',
        'runtime/schema2.php',
    ]),
]);

$schema = new Schema($pipeline->read());

The SimpleCacheSchemaProvider requires an implementation of Psr\SimpleCache\CacheInterface, which must be defined in your container. It uses this interface to retrieve and store the schema array. Alternatively, you can use the Cycle\Schema\Provider\PhpFileSchemaProvider, which can save the schema to a PHP file.

Building DB schema from different providers

To merge schema parts obtained from different providers, use Cycle\Schema\Provider\MergeSchemaProvider.

use Cycle\ORM\Schema;
use Cycle\Schema\Provider\FromFilesSchemaProvider;
use Cycle\Schema\Provider\SimpleCacheSchemaProvider;
use Cycle\Schema\Provider\MergeSchemaProvider;
use Cycle\Schema\Provider\Support\SchemaProviderPipeline;

$pipeline = (new SchemaProviderPipeline($container))->withConfig([
    SimpleCacheSchemaProvider::class => SimpleCacheSchemaProvider::config(key: 'cycle-schema'),
    MergeSchemaProvider::class => [
        FromFilesSchemaProvider::class => FromFilesSchemaProvider::config(files: [
            'runtime/schema1.php',
            'runtime/schema2.php',
        ]),
        CustomSchemaProvider::class => ['some' => 'config'],
    ],
]);

$schema = new Schema($pipeline->read());

About

The package provides the ability to build schema for Cycle ORM from different sources.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

3 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages