arekushi/cycle-orm-factory

Cycle ORM Factories for Mezzio

dev-main 2024-10-07 23:00 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• composer/package-versions-deprecated: ^1.10.99
• cycle/annotated: ^4.2
• cycle/database: ^2.5
• cycle/entity-behavior: ^1.3
• cycle/entity-behavior-uuid: ^1.2
• cycle/migrations: ^4.2
• cycle/orm: ^2.9
• cycle/schema-migrations-generator: ^2.2
• symfony/cache: ^5.4 || ^6.3 || ^7.0
• symfony/console: ^6.3 || ^7.0

Requires (Dev)

• codeception/codeception: ^5.0
• codeception/module-asserts: *
• codeception/module-phpbrowser: *
• ergebnis/composer-normalize: ^2.39
• mockery/mockery: ^1.6
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpstan/phpstan-mockery: ^1.1
• roave/security-advisories: dev-master
• symfony/filesystem: ^5.4 || ^6.3

MIT

• Sirix

README

This is a fork of the original repository: https://github.com/sirix777/cycle-orm-factory

This package provides factories for integrating Cycle ORM into the Mezzio framework, providing seamless setup and configuration.

Installation

composer require arekushi/cycle-orm-factory

Configuration

Create a configuration file, for example, config/autoload/cycle-orm.global.php:

<?php

declare(strict_types=1);

use Cycle\Database\Config;
use Sirix\Cycle\Enum\SchemaProperty;


return [
    'cycle'           => [
        'default'     => 'default',
        'databases'   => [
            'default' => [
                'connection' => 'mysql',
            ]
        ],
        'connections' => [
            'mysql' => new Config\MySQLDriverConfig(
                connection: new Config\MySQL\TcpConnectionConfig(
                    database: 'cycle-orm',
                    host: '127.0.0.1',
                    port: 3306,
                    user: 'cycle',
                    password: 'password'
                ),
                reconnect: true,
                timezone: 'UTC',
                queryCache: true,
            ),
        ]
    ],
    'migrator'        => [
        'directory' => 'db/migrations',
        'table'     => 'migrations'
    ],
    'entities'        => [
        'src/App/src/Entity',
    ],
    'schema'   => [
        'property' => SchemaProperty::GenerateMigrations,
        'cache'    => true,
        'directory' => 'data/cache'
    ],
];

Migrator Configuration

'migrator' => [
    'directory' => 'db/migrations',
    'table'     => 'migrations',
],

• directory: Specifies the directory where the migration files will be stored.
• table: Specifies the name of the table used to store migration information.

Entities Configuration

'entities' => [
    'src/App/src/Entity',
],

• Specifies the directory in which your entity classes are located.

Schema Configuration

'schema' => [
    'property' => null,
    'cache'    => true,
    'directory' => 'data/cache'
],

• property: Configures the schema property, options include null, SchemaProperty::SyncTables, or SchemaProperty::GenerateMigrations.
• cache: Enables or disables caching of the generated schema.
• directory: Specifies the directory in which to store the cached schema.

Schema Property Options

SchemaProperty::SyncTables

The SyncTables option synchronizes the database tables based on the provided entity classes. It ensures that the tables match the structure defined in the entity classes. This can be useful during development when the database schema evolves along with your application.

SchemaProperty::GenerateMigrations

The GenerateMigrations option is used to automatically generate migration files based on changes detected in your entity classes. When enabled, the ORM analyzes the differences between the current database schema and the defined entities. It then generates migration files to apply these changes, making it easier to version and manage your database schema changes.

Select the appropriate SchemaProperty option based on the requirements of your project. Customize the configuration to your needs and enjoy the seamless integration of Cycle ORM with Mezzio.

Use in your project

$container->get('orm'); // Cycle\ORM\ORM
$container->get('dbal'); // Cycle\Database\DatabaseInterface
$container->get('migrator'); // Cycle\Migrations\Migrator

These factories provide the necessary components to work seamlessly with Cycle ORM within the Mezzio Framework. Customize the configuration to meet the needs of your project.

For more information about Cycle ORM, see the Cycle ORM documentation.

Migrator Commands

The Sirix\Cycle\Command\Migrator namespace provides two commands for managing database migrations using Cycle ORM. These commands are intended for use with the laminas-cli tool.

1. migrator:migrate Command

Description

The migrator:migrate command performs the necessary database migration steps, applying changes specified in migration files to synchronize your database schema.

Usage

php vendor/bin/laminas migrator:migrate

Options

This command has no additional options.

2. migrator:rollback Command

Description

The migrator:rollback command undoes the changes made by the last migration, reverting your database schema to its previous state.

Usage

php vendor/bin/laminas migrator:rollback

Options

This command does not have any additional options.

Note: Make sure that you have correctly configured the database connection and migrations settings in your project's configuration file.

For more information about using migrations with Cycle ORM, see the Cycle ORM Documentation.