dbal nested set

Doctrine dbal nested set

用于 Shopware 5 的 B2B Suite

DBAL 用户的多根嵌套集实现。

描述

该库为每个表具有多个根节点的嵌套集提供写入、读取和检查类。仅仅依靠 DBAL 主义。

与其他解决方案相反，该库具有明确的边界，并将软件设计留给您。

• 没有树抽象 - 只有嵌套集
• 没有实体 - 只是带有普通参数的方法调用

安装

使用composer安装库

 > composer require shopware/dbal-nested-set

用法

您始终需要一个配置来设置实现的基本列名称：

 use Shopware  DbalNestedSet  NestedSetConfig ;

$ config = new NestedSetConfig (
    ' id ' , // Primary key column name
    ' left ' , // left column name
    ' right ' ,  // right column name
    ' level ' // level column name
);

然后您可以使用NestedSetFactory创建库的不同类。

 use Shopware  DbalNestedSet  NestedSetFactory ;
use Doctrine  DBAL  Connection ;

$ writer = NestedSetFactory:: createWriter ( $ dbalConnection , $ config );

创建一棵树

您可能想要为嵌套集合表创建规范化模式，这可以通过NestedSetTableFactory来完成。它将为带有索引的树创建基本 DDL。因此，如果您想添加一个带有名称列和自动增量 id 的简单树，它将如下所示：

 $ tableFactory = NestedSetFactory:: createTableFactory ( $ connection , $ config );

$ schema = new  Doctrine  DBAL  Schema  Schema ();
$ table = $ tableFactory -> createTable (
    $ schema ,
    ' tree ' , // table name
    ' root_id ' // nested set root id
);
$ table -> addColumn ( ' id ' , ' integer ' , [ ' unsigned ' => true , ' autoincrement ' => true ]);
$ table -> addColumn ( ' name ' , ' string ' , [ ' length ' => 255 ]);
$ table -> setPrimaryKey ([ ' id ' ]);

$ addSql = $ schema -> toSql ( $ connection -> getDatabasePlatform ());

当然，这是可选的并且可以通过任何模式配置工具来完成。

修改树

该库提供了一个NestedSetWriter类，其中包含所有插入、移动和更新操作。所有操作都应该让人想起DoctrineDBALConnection::insert()和DoctrineDBALConnection::update()并且只需要纯数据。

作为示例，您可以使用它来创建一棵树

 $ writer = NestedSetFactory:: createWriter ( $ dbalConnection , $ config );

// create a Root node
$ writer -> insertRoot ( ' tree ' , ' root_id ' , 100 , [ ' name ' => ' Clothing ' ]);

// create subnodes
$ writer -> insertAsFirstChild ( ' tree ' , ' root_id ' , 1 , [ ' name ' => ' Men ' ]);
$ writer -> insertAsNextSibling ( ' tree ' , ' root_id ' , 2 , [ ' name ' => ' Women ' ]);
$ writer -> insertAsFirstChild ( ' tree ' , ' root_id ' , 2 , [ ' name ' => ' Suits ' ]);
$ writer -> insertAsFirstChild ( ' tree ' , ' root_id ' , 3 , [ ' name ' => ' Dresses ' ]);
$ writer -> insertAsNextSibling ( ' tree ' , ' root_id ' , 5 , [ ' name ' => ' Skirts ' ]);
$ writer -> insertAsNextSibling ( ' tree ' , ' root_id ' , 6 , [ ' name ' => ' Blouses ' ]);
$ writer -> insertAsFirstChild ( ' tree ' , ' root_id ' , 4 , [ ' name ' => ' Jackets ' ]);
$ writer -> insertAsFirstChild ( ' tree ' , ' root_id ' , 4 , [ ' name ' => ' Slacks ' ]);
$ writer -> insertAsFirstChild ( ' tree ' , ' root_id ' , 5 , [ ' name ' => ' Evening Gowns ' ]);
$ writer -> insertAsNextSibling ( ' tree ' , ' root_id ' , 10 , [ ' name ' => ' Sun Dresses ' ]);

然后使用 writer 来移动节点

 $ writer -> moveAsNextSibling ( ' tree ' , ' root_id ' , 4 , 7 );

检查节点

您可能想要检索有关不同节点的信息。这可以通过NestedSetTableNodeInspector来完成。

 $ inspector = NestedSetFactory:: createTableNodeInspector ( $ connection , $ config );

$ inspector -> isLeaf ( ' tree ' , ' root_id ' , 9 ); // true | false
$ inspector -> isAncestor ( ' tree ' , ' root_id ' , 1 , 2 ) // true | false

检查树

NestedSetQueryFactory帮助从树中检索一组节点。由于该库没有实体的概念，它只会为您准备查询构建器，准备添加选择、连接和其他条件。

 $ queryFactory = NestedSetFactory:: createQueryFactory ( $ connection , $ config );
$ data = $ queryFactory
            -> createChildrenQueryBuilder ( ' tree ' , ' t ' , ' root_id ' , 2 )
            -> select ( ' * ' )
            -> execute ()
            -> fetchAll ();

当地发展

如果您想在本地开发，您可能需要通过一些 shell 脚本配置数据库访问：

 #! /usr/bin/env bash

export DB_USER= ' foo '
export DB_PASSWORD= ' bar '
export DB_HOST= ' baz '
export DB_NAME= ' dbal_nested_set '

bin/phpunit