摘要：優(yōu)雅的樹(shù)形數(shù)據(jù)結(jié)構(gòu)管理包基于模式設(shè)計(jì)歡迎不吝優(yōu)雅的樹(shù)形數(shù)據(jù)設(shè)計(jì)模式數(shù)據(jù)和結(jié)構(gòu)分表操作數(shù)據(jù)不影響結(jié)構(gòu)一個(gè)操作簡(jiǎn)單無(wú)需修改表兼容舊數(shù)據(jù)完善的樹(shù)操作方法支持生成樹(shù)形數(shù)據(jù)支持多棵樹(shù)并存多個(gè)根支持節(jié)點(diǎn)樹(shù)修復(fù)支持軟刪除依賴關(guān)于將樹(shù)中每個(gè)節(jié)點(diǎn)與其后代節(jié)點(diǎn)

優(yōu)雅的樹(shù)形數(shù)據(jù)結(jié)構(gòu)管理包,基于Closure Table模式設(shè)計(jì).

github 歡迎不吝Star

優(yōu)雅的樹(shù)形數(shù)據(jù)設(shè)計(jì)模式

數(shù)據(jù)和結(jié)構(gòu)分表,操作數(shù)據(jù)不影響結(jié)構(gòu)

一個(gè)Eloquent Trait操作簡(jiǎn)單

無(wú)需修改表,兼容舊數(shù)據(jù)

完善的樹(shù)操作方法

支持生成樹(shù)形數(shù)據(jù)

支持多棵樹(shù)并存(多個(gè)根)

支持節(jié)點(diǎn)/樹(shù)修復(fù)

支持軟刪除

php > 5.6.0

laravel > 5.1.0

Closure table is a simple and elegant way of storing and querying hierarchical data in any RDBMS. By hierarchical data we mean a set of data that has some parent – child relationship among them. We use the word ‘tree’ instead of hierarchies commonly. As an example we may take the relationships between geographic locations like ‘Countries’, ‘States/ Province’, ‘Districts/ Cities’ etc.

Closure Table將樹(shù)中每個(gè)節(jié)點(diǎn)與其后代節(jié)點(diǎn)的關(guān)系都存儲(chǔ)了下來(lái),
這將需要一個(gè)存儲(chǔ)相互關(guān)系的表name_closure.

部門表:

一個(gè)基本的closure表包含ancestor,descendant,distance3個(gè)字段,如:

這個(gè)表記錄了每個(gè)部門之間的關(guān)系,并且還記錄了一條自身的關(guān)聯(lián).

ClosureTable提供了大量方法操作樹(shù).

makeRoot();
  
// 創(chuàng)建一個(gè)子級(jí)節(jié)點(diǎn),return new model
$menu->createChild($attributes);
  
// 創(chuàng)建一個(gè)新的菜單，此時(shí)該菜單無(wú)任何關(guān)聯(lián),return model
$child = Menu::create($attributes);
  
// 將一個(gè)已存在的菜單添加到子級(jí),$child可為模型實(shí)例、模型實(shí)例集合或id、包含id的數(shù)組,return bool
$menu->addChild($child);
$menu->addChild(12);
$menu->addChild("12");
$menu->addChild([3, 4, 5]);
  
// 移動(dòng)到$parent的下級(jí),后代也將隨之移動(dòng),$parent可為模型實(shí)例或id,return bool
$menu->moveTo($parent);
$menu->moveTo(2); 
$menu->moveTo("2");
  
// 同moveTo()
$menu->addTo($parent);
  
// 添加一個(gè)或多個(gè)同級(jí)節(jié)點(diǎn),$siblings的后代也將隨之移動(dòng),$siblings可為模型實(shí)例集合或id、包含id的數(shù)組,return bool
$menu->addSibling($siblings);
$menu->addSibling(2);
$menu->addSibling("2");
$menu->addSibling([2,3,4]);
  
// 新建一個(gè)同級(jí)節(jié)點(diǎn),return new model
$menu->createSibling($attributes);
  
// 建立一個(gè)自身的關(guān)聯(lián),return bool
$menu->attachSelf();
  
// 解除自身的所有關(guān)聯(lián),并且解除后代的所有關(guān)聯(lián)(這個(gè)操作不保留子樹(shù)，將使自己和所有后代都成孤立狀態(tài)),return bool
$menu->detachSelf();

getDescendants();
  
// 獲取所有后代,包括自己,return model collection
$menu->getDescendantsAndSelf();
 
 // 獲取所有祖先,return model collection
$menu->getAncestors();
  
// 獲取所有祖先,包括自己,return model collection
$menu->getAncestorsAndSelf();
  
// 獲取所有兒女(直接下級(jí)),return model collection
$menu->getChildren();
  
// 獲取父輩(直接上級(jí)),return model
$menu->getParent();
  
// 獲取祖先(根),return model
$menu->getRoot();

// 獲取所有兄弟姐妹,return model collection
$menu->getSiblings();
  
//獲取所有兄弟姐妹包括自己,return model collection
$menu->getSiblingsAndSelf();
  
// 獲取所有孤立節(jié)點(diǎn)
Menu::getIsolated();
  
Menu::isolated()->where("id", ">", 5)->get();
  
// 獲取所有根
Menu::getRoots();

以上get...()方法都包含一個(gè)query構(gòu)造器,如getDescendants()對(duì)應(yīng)有一個(gè)queryDescendants,這使得你可以在查詢中加入條件查詢或排序

你可以這樣使用$menu->queryDescendants()->where("id", ">", 5)->orderBy("sort","desc")->get();

getRoot(),getParent(),getRoots(),getIsolated()4個(gè)方法沒(méi)有query構(gòu)造器

如果你想獲取只包含單個(gè)或多個(gè)列的結(jié)果可以在get...()方法里傳入?yún)?shù),如:$menu->getAncestors(["id","name"]);

由于數(shù)據(jù)庫(kù)不需要parent_id列,如果你想在結(jié)果中顯示包含此列的內(nèi)容可以在構(gòu)造器后加入withParent(),

如:$menu->queryDescendantsAndSelf()->withParent()->get().
默認(rèn)列名為parent,如果你想自定義這個(gè)列名在model里定義protected $parentColunm = "parent_id"

提供多種方法生成樹(shù)形數(shù)據(jù),可從任意節(jié)點(diǎn)生成樹(shù)

getTree();
  
// 當(dāng)前節(jié)點(diǎn)作為根生成樹(shù),以sort字段排序,return tree
$menu->getTree(["sortColumn", "desc"]);
  
// 從根節(jié)點(diǎn)生成樹(shù),return tree
$menu->getRoot()->getTree();

//旁樹(shù),不包含自己和下級(jí),return tree
$menu->getBesideTree();

生成的樹(shù)如下:

[
    "id" => 3,
    "name" => "node3",
    "children" => [
        [
            "id" => 4,
            "name" => "node4"
        ],
        [
            "id" => 5,
            "name" => "node5"
            "children" => [
                [
                    "id" => 6,
                    "name" => "node6"
                ]
            ]
        ]
    ]
]

生成的樹(shù)的children鍵默認(rèn)為children,如果你想自定義可以作為第2個(gè)參數(shù)傳入,如:

$menu->getTree(["sortColumn", "desc"], "son");
如果你想獲取只包含單個(gè)或多個(gè)列的結(jié)果可以作為第3個(gè)參數(shù)傳入,如:
$menu->getTree(["sortColumn", "desc"], "son", ["id", "name"]);

你的表里可能包含多棵樹(shù),如果你想一一獲取他們可以這樣做:

getTree();
}
$data = $mutiTree;

isRoot();
  
// 是否葉子節(jié)點(diǎn)
$menu->isLeaf();
 
// 是否孤立節(jié)點(diǎn)
$menu->isIsolated();
  
// 是否有上級(jí)
$menu->hasAncestors();
  
// 是否有下級(jí)
$menu->hasDescendants();
  
// 是否有孩子(直接下級(jí))
$menu->hasChildren();
  
// 是否有直接上級(jí)
$menu->hasParent();
  
// 是否$descendant的上級(jí)
$menu->isAncestorOf($descendant);
  
// 是否$ancestor的下級(jí)
$menu->isDescendantOf($ancestor);
  
// 是否$parent的直接下級(jí)
$menu->isChildOf($parent);
  
// 是否$child的直接上級(jí)
$menu->isParentOf($child);
  
// 是否$sibling的同級(jí)(同一個(gè)上級(jí))
$menu->isSiblingOf($sibling);
  
// 如果$beside不是自己也不是自己的后代返回true
$menu->isBesideOf($beside);

perfectNode();
  
// 修復(fù)樹(shù)關(guān)聯(lián),注意:這將循環(huán)整顆樹(shù)調(diào)用perfectNode(),如果你的樹(shù)很龐大將耗費(fèi)大量資源,請(qǐng)慎用
$menu->perfectTree();

$ composer requrie jiaxincui/closure-table

建立樹(shù)需要新建一個(gè)closure表如:menu_closure

unsignedInteger("ancestor");
            $table->unsignedInteger("descendant");
            $table->unsignedTinyInteger("distance");
            $table->primary(["ancestor", "descendant"]);
        });

在model里使用JiaxincuiClosureTableTraitsClosureTableTrait.

如果你想自定義表名和字段，可在model里定義以下屬性:$closureTable,$ancestorColumn,$descendantColumn,$distanceColumn.

如果你想自定義生成的樹(shù)形數(shù)據(jù)里parent字段,在model里定義屬性$parentColumn.

如下示例:

接下來(lái),你就可以自由的使用ClosureTable帶來(lái)的所有功能了.