icanboogie / bind-activerecord

v6.0.0 2024-11-19 04:02 UTC

Requires

• php: >=8.2
• icanboogie/activerecord: ^6.0
• icanboogie/icanboogie: ^6.0

Requires (Dev)

• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^11.4

MIT

• Olivier Laviale

Published on Packagist.org on 2026-10-14 12:14 UTC

README

The icanboogie/bind-activerecord package binds the icanboogie/activerecord package to ICanBoogie, using its Autoconfig feature. It provides configuration builders for active record connections and models, as well as getters for the connection provider and the model provider.

<?php
namespace ICanBoogie\Binding\ActiveRecord;

use ICanBoogie\Application;
use ICanBoogie\ActiveRecord\Config;
use ICanBoogie\ActiveRecord\Model;
use ICanBoogie\ActiveRecord\ConnectionProvider;
use ICanBoogie\ActiveRecord\ModelProvider;

/* @var Application $app */

$app = boot();

$config = $app->configs[Config::class];

echo count($config->connections);
echo count($config->models);

$primary_connection = $app->service_for_id('active_record.connection.primary', Connection::class);
# or
$primary_connection = $app->service_for_class(ConnectionProvider::class)->connection_for_id('primary');

$nodes = $app->service_for_class(ModelProvider::class)->model_for_record(Node::class);

Installation

composer require icanboogie/bind-activerecord

Autoconfig

The package provides a configuration builder for ICanBoogie\ActiveRecord\Config.

The activerecord config fragment

Currently activerecord fragments are used to configure connections and models, which are suitable to create ConnectionRegistry and ModelRegistry instances.

The following example demonstrates how to define connections and models. Two connections are defined: primary is a connection to the MySQL server;cache is a connection to a SQLite database. The nodes model is also defined.

<?php

// config/activerecord.php

use ICanBoogie\ActiveRecord\ConnectionOptions;
use ICanBoogie\ActiveRecord\Model;
use ICanBoogie\ActiveRecord\Schema;
use ICanBoogie\ActiveRecord\SchemaColumn;
use ICanBoogie\ActiveRecord\Config;
use ICanBoogie\ActiveRecord\ConfigBuilder;
use ICanBoogie\ActiveRecord\SchemaBuilder;
use ICanBoogie\Env;

return fn(ConfigBuilder $config) => $config
    ->enable_discovery()
    ->add_connection(
        id: Config::DEFAULT_CONNECTION_ID,
        dsn: Env::string('APP_DATABASE_DSN'),
        username: Env::string('APP_DATABASE_USERNAME'),
        password: Env::string('APP_DATABASE_PASSWORD'),
        table_name_prefix: 'myprefix',
        time_zone: '+02:00',
    )
    ->add_connection(
        id: 'cache',
        dsn: 'sqlite:var/cache.sqlite'
    )
    ->add_record(Node::class)
;

Server-Timing

Installing the package registers ActiveRecordServerTimingProvider with the server_timing_providers option of the application. Once the application calls enable_server_timing() on its AppConfigBuilder, the response gets a db metric:

Server-Timing: db;dur=12.3;desc="7 queries"

dur is the sum of the time spent executing queries, in milliseconds, on the connections that are established. Connections that are not are skipped, the provider never opens one, and nothing is added when no query was executed.

The header exposes internals to every client, enable it for development and staging only. To drop the metric, call remove_server_timing_provider(ActiveRecordServerTimingProvider::class) in the app config of the application.

Continuous Integration

The project is continuously tested by GitHub Actions.

Code of Conduct

This project adheres to a Contributor Code of Conduct. By participating in this project and its community, you're expected to uphold this code.

Contributing

See CONTRIBUTING for details.