README

Smalldb 的 Symfony 扩展包。

请参阅 https://smalldb.org/

特性

Smalldb Symfony 扩展包将 libSmalldb 集成到 Symfony 框架中，包括 安全子系统。它还提供了便捷的配置和可选的 REST API。

安装

首先，将扩展包添加到您的 composer.json

{
    "require": {
        "smalldb/smalldb-symfony-bundle": "*"
    }
}

然后，在您的 app/AppKernel.php 中注册扩展包

class AppKernel extends \Symfony\Component\HttpKernel\Kernel
{
	public function registerBundles()
	{
		return [
			// ...
			new Smalldb\SmalldbBundle\SmalldbBundle(),
			// ...
		];
	}
}

最后，配置扩展包 — app/config/config.yml

# See: bin/console config:dump-reference SmalldbBundle
smalldb:
    smalldb:
        base_dir: '%kernel.root_dir%/../src/AppBundle/StateMachines'
        cache_disabled: false
    flupdo:
        driver: mysql
        host: ~
        port: ~
        database: ~
        username: ~
        password: ~
        log_query: false
        log_explain: false
    auth:
        class: Smalldb\StateMachine\Auth\CookieAuth

… 并在 app/config/security.yml 中启用身份验证监听器

security:
    firewalls:
        main:
            smalldb: ~

可以使用预定义的路由启用 REST API — app/config/routing.yml

smalldb:
        resource: "@SmalldbBundle/Resources/config/routing.yml"

使用方法

Smaldb Symfony 扩展包将 JsonDirBackend 注册为 smalldb 服务。

因此，您可以在控制器中使用 $this->get('smalldb') 来检索 Smalldb 后端，或者在配置文件中使用 @smalldb 标识符进行注入。

文档

请参阅 https://smalldb.org/doc/smalldb-symfony-bundle/master/

许可证

大部分代码发布在 Apache 2.0 许可证下。有关详细信息，请参阅 LICENSE 文件。

贡献指南

项目的首要仓库托管在 https://git.frozen-doe.net/smalldb/smalldb-symfony-bundle，您可以自由地在那里提交问题或创建合并请求。