ascetic-soft / rowcast-bundle
Symfony bundle integration for Rowcast and RowcastSchema
Package info
github.com/ascetic-soft/RowcastBundle
Type:symfony-bundle
pkg:composer/ascetic-soft/rowcast-bundle
Requires
- php: >=8.4
- ext-pdo: *
- ascetic-soft/rowcast: ^2.0
- symfony/config: ^7.0
- symfony/dependency-injection: ^7.0
- symfony/http-kernel: ^7.0
Requires (Dev)
- ascetic-soft/rowcast-schema: ^1.0
- phpunit/phpunit: ^11.0
- symfony/console: ^7.0
Suggests
- ascetic-soft/rowcast-schema: Required for schema migrations and rowcast:* schema commands
- symfony/console: Required for console commands
README
Symfony bundle for integrating:
ascetic-soft/rowcast(Connection + DataMapper)ascetic-soft/rowcast-schema(optional schema/migration services + console commands)
Requirements
- PHP
>=8.4 - Symfony components:
symfony/configsymfony/dependency-injectionsymfony/http-kernel
- Optional:
ascetic-soft/rowcast-schemasymfony/console
Installation
composer require ascetic-soft/rowcast-bundle
If Symfony Flex does not auto-register the bundle, add it manually to config/bundles.php:
<?php return [ AsceticSoft\RowcastBundle\RowcastBundle::class => ['all' => true], ];
Symfony Flex private recipe
For automatic creation of config/packages/rowcast.yaml and .env variables, use a private Symfony Flex recipe repository.
Prepared recipe files are located in:
../RowcastBundleRecipes/index.json../RowcastBundleRecipes/ascetic-soft.rowcast-bundle.1.0.json
Current endpoint configured in composer.json:
"extra": { "symfony": { "bundle": "AsceticSoft\\RowcastBundle\\RowcastBundle", "endpoint": [ "https://api.github.com/repos/ABorodulin/rowcast-bundle-recipes/contents/index.json", "flex://defaults" ] } }
Before using in production, replace ABorodulin/rowcast-bundle-recipes with your real GitHub account/repository and ensure the recipe JSON files are published at that endpoint.
Configuration
Create config/packages/rowcast.yaml:
rowcast: connection: dsn: '%env(DATABASE_DSN)%' username: '%env(DATABASE_USER)%' password: '%env(DATABASE_PASSWORD)%' options: [] nest_transactions: true schema: path: '%kernel.project_dir%/database/schema.php' migrations_path: '%kernel.project_dir%/database/migrations' migration_table: '_rowcast_migrations' ignore_tables: []
Attributes schema support
rowcast.schema.path can point either to:
- a schema file (
.php,.yaml,.yml) - a directory with classes that contain Rowcast attributes
Parser selection is automatic:
- if
pathis a directory andAttributeSchemaParseris available, bundle uses attribute parser - otherwise bundle uses file parser based on file extension
Example for attribute-based schema:
rowcast: schema: path: '%kernel.project_dir%/src/Entity' migrations_path: '%kernel.project_dir%/database/migrations' migration_table: '_rowcast_migrations' ignore_tables: []
Registered services
Core services (always):
AsceticSoft\Rowcast\Connection- alias
AsceticSoft\Rowcast\ConnectionInterface->AsceticSoft\Rowcast\Connection AsceticSoft\Rowcast\DataMapperrowcast.pdo(factory:Connection::getPdo())
Schema services (only when ascetic-soft/rowcast-schema is installed):
AsceticSoft\RowcastSchema\Parser\SchemaParserInterfaceAsceticSoft\RowcastSchema\Diff\SchemaDifferAsceticSoft\RowcastSchema\Migration\MigrationGeneratorAsceticSoft\RowcastSchema\Migration\MigrationLoaderAsceticSoft\RowcastSchema\Introspector\IntrospectorFactoryAsceticSoft\RowcastSchema\Platform\PlatformFactoryAsceticSoft\RowcastSchema\Platform\PlatformInterfaceAsceticSoft\RowcastSchema\Cli\TableIgnoreMatcherAsceticSoft\RowcastSchema\Migration\DatabaseMigrationRepository- alias
AsceticSoft\RowcastSchema\Migration\MigrationRepositoryInterface->DatabaseMigrationRepository AsceticSoft\RowcastSchema\Migration\MigrationRunner
Console commands
When both ascetic-soft/rowcast-schema and symfony/console are available:
bin/console rowcast:diff [--dry-run]bin/console rowcast:makebin/console rowcast:migratebin/console rowcast:rollback [--step=1]bin/console rowcast:status
Usage example
<?php use AsceticSoft\Rowcast\DataMapper; final readonly class UserRepository { public function __construct(private DataMapper $mapper) { } // ... }