https://github.com/ibexa/doctrine-schema

https://github.com/ibexa/doctrine-schema

ibexa-bundle

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ibexa/doctrine-schema
• Owner: ibexa
• License: other
• Created: 2021-03-31T07:25:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T13:52:04.000Z (7 months ago)
• Last Synced: 2024-04-11T15:10:58.647Z (7 months ago)
• Topics: ibexa-bundle
• Language: PHP
• Homepage:
• Size: 156 KB
• Stars: 2
• Watchers: 12
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Doctrine Schema Bundle

This Symfony Bundle provides basic abstraction layer for cross-DBMS schema import.

It introduces custom Yaml format for schema definition and provides autowired APIs.

## Schema Builder

Provided by APIs defined on the `\Ibexa\Contracts\DoctrineSchema\SchemaImporterInterface` interface,

imports given Yaml source string or Yaml file into `\Doctrine\DBAL\Schema` object.

## Schema Exporter

Provided by APIs defined on the `\Ibexa\Contracts\DoctrineSchema\SchemaExporterInterface` interface,

exports given `\Doctrine\DBAL\Schema` object to the custom Yaml format.

## SchemaBuilder

Provided by APIs defined on the `\Ibexa\Contracts\DoctrineSchema\Builder\SchemaBuilderInterface`

interface, is an extensibility point to be used by Symfony-based projects.

The `SchemaBuilder` is event-driven. To hook into the process of building schema, a custom `EventSubscriber` is required, e.g.

```php

use Ibexa\Contracts\DoctrineSchema\Event\SchemaBuilderEvent;

use Ibexa\Contracts\DoctrineSchema\SchemaBuilderEvents;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class BuildSchemaSubscriber implements EventSubscriberInterface

{

    private string $schemaFilePath;

    public function __construct(string $schemaFilePath)

    {

        $this->schemaFilePath = $schemaFilePath;

    }

    /**

     * @return string[]

     */

    public static function getSubscribedEvents(): array

    {

        return [

            SchemaBuilderEvents::BUILD_SCHEMA => ['onBuildSchema', 200],

        ];

    }

    public function onBuildSchema(SchemaBuilderEvent $event): void

    {

        $event

            ->getSchemaBuilder()

            ->importSchemaFromFile($this->schemaFilePath);

    }

}

```

Schema provided in this way can be imported into Schema object by e.g.:

```php

    public function __construct(SchemaBuilder $schemaBuilder)

    {

        $this->schemaBuilder = $schemaBuilder;

    }

    public function importSchema(): void

    {

        $schema = $this->schemaBuilder->buildSchema();

        // ...

    }

```

## COPYRIGHT

Copyright (C) 1999-2024 Ibexa AS (formerly eZ Systems AS). All rights reserved.

## LICENSE

This source code is available separately under the following licenses:

A - Ibexa Business Use License Agreement (Ibexa BUL),

version 2.4 or later versions (as license terms may be updated from time to time)

Ibexa BUL is granted by having a valid Ibexa DXP (formerly eZ Platform Enterprise) subscription,

as described at: https://www.ibexa.co/product

For the full Ibexa BUL license text, please see:

https://www.ibexa.co/software-information/licenses-and-agreements (latest version applies)

AND

B - GNU General Public License, version 2

Grants an copyleft open source license with ABSOLUTELY NO WARRANTY. For the full GPL license text, please see:

https://www.gnu.org/licenses/old-licenses/gpl-2.0.html