摘要：標簽名稱規則說明標簽名里的特殊符號和空格會被替代智能標簽生成，會生成對應的中文拼音，如標簽，拼音一樣的時候會被加上隨機值標簽名清理使用。

本文經授權轉自 PHPHub 社區

使用最簡便的方式，為你的數據模型提供強大「打標簽」功能。

項目地址：https://github.com/summerblue/laravel-taggable

本項目修改于 rtconner/laravel-tagging 項目，增加了一下功能：

標簽名唯一；

增加 etrepat/baum 依賴，讓標簽支持無限級別標簽嵌套；

中文 slug 拼音自動生成支持，感謝超哥的 overtrue/pinyin；

提供完整的測試用例，保證代碼質量。

注意： 本項目只支持 5.1 LTS

此項目由 The EST Group 團隊的 @Summer 維護。

集成 etrepat/baum 讓標簽具備從屬關系。

$root = Tag::create(["name" => "Root"]);

// 創建子標簽
$child1 = $root->children()->create(["name" => "Child1"]);

$child = Tag::create(["name" => "Child2"]);
$child->makeChildOf($root);

// 批量構建樹
$tagTree = [
    "name" => "RootTag",
    "children" => [
        ["name" => "L1Child1",
            "children" => [
                ["name" => "L2Child1"],
                ["name" => "L2Child1"],
                ["name" => "L2Child1"],
            ]
        ],
        ["name" => "L1Child2"],
        ["name" => "L1Child3"],
    ]
];

Tag::buildTree($tagTree);

更多關聯操作請查看：etrepat/baum 。

標簽名里的特殊符號和空格會被 - 替代；

智能標簽 slug 生成，會生成 name 對應的中文拼音 slug ，如：標簽 -> biao-qian，拼音一樣的時候會被加上隨機值；

標簽名清理使用：$normalize_string = EstGroupeTaggableUtil::tagName($name)。

Tag::create(["標簽名"]);
// name: 標簽名
// slug: biao-qian-ming

Tag::create(["表簽名"]);
// name: 表簽名
// slug: biao-qian-ming-3243 （后面 3243 為隨機，解決拼音沖突）

Tag::create(["標簽 名"]);
// name: 標簽-名
// slug: biao-qian-ming

Tag::create(["標簽!名"]);
// name: 標簽-名
// slug: biao-qian-ming

composer require estgroupe/laravel-taggable "5.1.*"

在 config/app.php 的 providers 數組中加入：

"providers" => array(
    EstGroupeTaggableProvidersTaggingServiceProvider::class,
);

php artisan vendor:publish --provider="EstGroupeTaggableProvidersTaggingServiceProvider"
php artisan migrate

請仔細閱讀 config/tagging.php 文件。

不是必須的，不過建議你創建自己項目專屬的 Tag.php 文件。

修改 config/tagging.php 文件中：
    "tag_model"=>"AppModelsTag",
加入 Taggable Trait

「標簽狀態」標示
Taggable 能跟蹤模型是否打過標簽的狀態：
// `no`
$article->is_tagged

// `yes`
$article->tag("Tag1");
$article->is_tagged;

// `no`
$article->unTag();
$article->is_tagged

// This is fast
$taggedArticles = Article::where("is_tagged", "yes")->get()
首先你需要修改 config/tagging.php 文件中：
"is_tagged_label_enable" => true,
然后在你的模型的數據庫創建腳本里加上：
increments("id");
            ...
            // Add this line
            $table->enum("is_tagged", array("yes", "no"))->default("no");
            ...
            $table->timestamps();
        });
    }
}
「推薦標簽」標示
方便你實現「推薦標簽」功能，只需要把 suggest 字段標示為 true：
$tag = EstGroupeTaggableModelTag::where("slug", "=", "blog")->first();
$tag->suggest = true;
$tag->save();
即可以用以下方法讀取：
$suggestedTags = EstGroupeTaggableModelTag::suggested()->get();
重寫 Util 類?
大部分的通用操作都發生在 Util 類，你想獲取更多的定制權力，請創建自己的 Util 類，并注冊服務提供者：
namespace MyProjectProviders;

use EstGroupeTaggableProvidersTaggingServiceProvider as ServiceProvider;
use EstGroupeTaggableContractsTaggingUtility;

class TaggingServiceProvider extends ServiceProvider {

    /**
     * Register the service provider.
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton(TaggingUtility::class, function () {
            return new MyNewUtilClass;
        });
    }

}
然后在
注意 MyNewUtilClass 必須實現 EstGroupeTaggableContractsTaggingUtility 接口。
使用范例
$article = Article::with("tags")->first(); // eager load

// 獲取所有標簽
foreach($article->tags as $tag) {
    echo $tag->name . " with url slug of " . $tag->slug;
}

// 打標簽
$article->tag("Gardening"); // attach the tag
$article->tag("Gardening, Floral"); // attach the tag
$article->tag(["Gardening", "Floral"]); // attach the tag
$article->tag("Gardening", "Floral"); // attach the tag

// 批量通過 tag ids 打標簽
$article->tagWithTagIds([1,2,3]);

// 去掉標簽
$article->untag("Cooking"); // remove Cooking tag
$article->untag(); // remove all tags

// 重打標簽
$article->retag(["Fruit", "Fish"]); // delete current tags and save new tags
$article->retag("Fruit", "Fish");
$article->retag("Fruit, Fish");

$tagged = $article->tagged; // return Collection of rows tagged to article
$tags = $article->tags; // return Collection the actual tags (is slower than using tagged)

// 獲取綁定的標簽名稱數組
$article->tagNames(); // get array of related tag names

// 獲取打了「任意」標簽的 Article 對象
Article::withAnyTag("Gardening, Cooking")->get(); // fetch articles with any tag listed
Article::withAnyTag(["Gardening","Cooking"])->get(); // different syntax, same result as above
Article::withAnyTag("Gardening","Cooking")->get(); // different syntax, same result as above

// 獲取打了「全包含」標簽的 Article 對象
Article::withAllTags("Gardening, Cooking")->get(); // only fetch articles with all the tags
Article::withAllTags(["Gardening", "Cooking"])->get();
Article::withAllTags("Gardening", "Cooking")->get();

EstGroupeTaggableModelTag::where("count", ">", 2)->get(); // return all tags used more than twice

Article::existingTags(); // return collection of all existing tags on any articles
如果你 創建了 Tag.php，即可使用以下標簽讀取功能：
// 通過 slug 獲取標簽
Tag::byTagSlug("biao-qian-ming")->first();

// 通過名字獲取標簽
Tag::byTagName("標簽名")->first();

// 通過名字數組獲取標簽數組
Tag::byTagNames(["標簽名", "標簽2", "標簽3"])->first();

// 通過 Tag ids 數組獲取標簽數組
Tag::byTagIds([1,2，3])->first();

// 通過名字數組獲取 ID 數組
$ids = Tag::idsByNames(["標簽名", "標簽2", "標簽3"])->all();
// [1,2,3]

標簽事件
Taggable trait 提供以下兩個事件：
EstGroupeTaggableEventsTagAdded;

EstGroupeTaggableEventsTagRemoved;
監聽標簽事件：
Event::listen(EstGroupeTaggableEventsTagAdded::class, function($article){
    Log::debug($article->title . " was tagged");
});
單元測試
基本用例測試請見： tests/CommonUsageTest.php。
運行測試：
composer install
vendor/bin/phpunit --verbose
Thanks

Special Thanks to: Robert Conner - http://smartersoftware.net

overtrue/pinyin

etrepat/baum

Made with love by The EST Group - http://estgroupe.com/