eureka/component-database

3.3.0 2024-02-06 16:45 UTC

This package is auto-updated.

Last update: 2024-09-06 17:59:09 UTC


README

Current version Supported PHP version CI Quality Gate Status Coverage

PHP PDO抽象层,带工厂处理重连和连接到多个数据库。

安装

如果您想在项目中安装它,请通过composer要求安装

composer require eureka/component-database

您可以使用以下命令安装组件(用于测试)

make install

更新

您可以使用以下命令更新组件(用于测试)

make update

用法

<?php

use Eureka\Component\Database\ConnectionFactory;

$factory = new ConnectionFactory(
    [
        'common' => [
            'dsn'      => 'mysql:dbname=my_database;host=localhost;charset=UTF8',
            'user'     => 'user',
            'password' => 'pass',
            'options'  => null,
        ],
    ]
);

$connection = $factory->getConnection('common');
$connection->query('SELECT * FROM my_table');

测试 & CI(持续集成)

您可以使用以下命令在您的侧运行测试

make tests   # run tests with coverage
make testdox # run tests without coverage reports but with prettified output

您也可以使用以下命令运行代码风格检查或代码风格修复

make phpcs   # run checks on check style
make phpcbf  # run check style auto fix

要执行代码的静态分析(使用phpstan,默认为lvl 9),您可以使用以下命令

make phpstan
make analyze # Same as phpstan but with CLI output as table

为确保您的代码与当前支持的PHP版本以及未来版本的PHP兼容,您需要运行以下命令(两个都是必需的以实现全面支持)

make php74compatibility # run compatibility check on current minimal version of php we support
make php81compatibility # run compatibility check on last version of php we will support in future

最后,“辅助”命令,您可以在提交和推送之前运行

make ci

此命令清除以前的报告,如果需要则安装组件,并运行测试(带有覆盖率报告),检查代码风格和检查PHP兼容性,就像在我们的CI中做的那样。

贡献

查看CONTRIBUTING文件。

许可协议

本项目目前受MIT许可协议(MIT)保护。有关更多信息,请参阅LICENCE文件。