README

此库提供优化常用分类功能的库，例如： 分类树、导航路径、子分类项，通过一个 SQL 查询实现。

支持

mysql5.7.22+ laravel php8.0+

安装包

通过 composer 安装

composer require denis-kisel/nested-categories

安装或升级分类表

如果您还没有分类表，请安装它

# Created table 'categories'
php artisan nested-category:install 

#Or specify table name
php artisan nested-category:install --table-name=categories

如果您已经有了分类表，只需升级它
假设您的表具有以下字段：id、parent_id

#Specify model to upgrade
php artisan nested-category:upgrade App\\Models\\Category

配置

将 trait NestableCategory 添加到分类模型

use DenisKisel\NestedCategory\NestableCategory;

class Category extends Model
{
    use NestableCategory;
    ....
}

将 path 添加到 fillable 或设置 guarded

class Category extends Model
{
    ....
    protected $fillable = ['path'];
    ....
}

#OR
class Category extends Model
{
    ....
    protected $guarded = [];
    ....
}

[可选]
将 trait AutoRebuildNested 添加到分类模型以自动在事件 created、updated、deleted 之后重建分类结构。但是，它在批量操作后不会自动重建（见重建结构）。

后台使用一个查询来重建整个表

use DenisKisel\NestedCategory\NestableCategory;
use DenisKisel\NestedCategory\AutoRebuildNested;

class Category extends Model
{
    use NestableCategory, AutoRebuildNested;
    ....
}

#The same
$category->save();
$category->rebuild();

$category->update();
$category->rebuild();

$category->delete();
$category->rebuild();

用法

作为数组的树

$result = Category::asArrayTree();
dump($result)
//Output:
[
    'id' => 1,
    'parent_id' => NULL,
    'name' => 'Parent',
    'children' => [
        [
            'id' => 2,
            'parent_id' => 1,
            'name' => 'Child1',
            'children' => []
        ],
        [
            'id' => 3,
            'parent_id' => 1,
            'name' => 'Child2',
            'children' => []
        ]
    ]      
]

# Specify needed fields
$result = Category::asArrayTree(fields: ['name', 'order']);
dump($result)
//Output:
[
    'name' => 'Parent',
    'order' => 0,
    'children' => [
        [
            'name' => 'Child1',
            'order' => 0,
            'children' => []
        ],
        [
            'name' => 'Child2',
            'order' => 1,
            'children' => []
        ]
    ]      
]

# Specify cache time(minutes or DateTimeInterface)
$result = Category::asArrayTree(cacheTTL: 10);
//Cached data

$result = Category::asArrayTree(cacheTTL: 10);
//Data from previous cache

$result = Category::asArrayTree();
//Data without cache


# Get array of objects
$result = Category::asArrayTree(associative: false);
dump($result)
//Output:
[
    {
        name: 'Parent',
        order: 0,
        children: [{...}]
    },
....
]

导航路径

后端使用一个 SQL 查询处理 N 个嵌套分类

$category = Category::find(2)
dump($category->breadcrumbs());

//Output
Collection {
    array:2 [
        Category {id: 1, ...},
        Category {id: 2, ...},
    ]   
}

叶子/子分类项（嵌套产品、文章、播客等）

输入表： categories(id, parent_id, name), products(id, category_id, name)。
后端使用一个 SQL 查询处理嵌套叶子

ParentCategory(id: 1)
│   Product_1
│   Product_2    
│
└───ChildCategory_1(id: 2)
│   │   Product_3
│   │   Product_4
│   │
│   └───ChildCategory_1_1(id: 3)
│       │   Product_5
│       │   Product_6
│   
└───ChildCategory_2(id: 4)
    │   Product_7
    │   Product_8

#GetAllProducts
$products = Category::find(1)->leafs(App\Models\Product::class)->get();
dump($products->count());
//Output: 8

#In Models\Category
....
public nestedProducts() :Builder
{
    return $this->leafs(Product::class)
}

public nestedPosts() :Builder
{
    return $this->leafs(Post::class)
}
....

#Client Code
$products = Category::find(1)->nestedProducts()->where('name', 'like', '%some%')->get();
$products = Category::first()->nestedPosts()->count();

重建结构

在批量 CRUD 操作之后重建分类结构，需要使用 rebuild 方法。或者您可以在单次操作后使用 trait AutoRebuildNested（更多内容见配置）。