Laravel Taggable Trait 项目教程

1. 项目的目录结构及介绍

laravel-tagging/
├── config/
│   └── tagging.php
├── docs/
├── migrations/
├── src/
│   ├── Providers/
│   │   └── TaggingServiceProvider.php
│   ├── Taggable.php
│   └── ...
├── tests/
├── .gitignore
├── LICENSE
├── README.md
├── composer.json
└── phpunit.xml

目录结构介绍

• config/: 包含项目的配置文件 tagging.php，用于配置标签相关的设置。
• docs/: 包含项目的文档文件，通常是 Markdown 格式的文档。
• migrations/: 包含数据库迁移文件，用于创建标签相关的数据库表。
• src/: 包含项目的源代码，包括服务提供者、Trait 和其他核心文件。
  • Providers/: 包含服务提供者文件 TaggingServiceProvider.php，用于注册和配置标签服务。
  • Taggable.php: 包含 Taggable Trait，用于为 Eloquent 模型添加标签功能。
• tests/: 包含项目的测试文件，用于测试标签功能的正确性。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文件，通常包含项目的简介、安装和使用说明。
• composer.json: Composer 配置文件，定义项目的依赖和其他元数据。
• phpunit.xml: PHPUnit 配置文件，用于配置测试环境。

2. 项目的启动文件介绍

TaggingServiceProvider.php

TaggingServiceProvider.php 是项目的启动文件之一，位于 src/Providers/ 目录下。该文件负责注册和配置标签服务。

namespace Conner\Tagging\Providers;

use Illuminate\Support\ServiceProvider;

class TaggingServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->publishes([
            __DIR__.'/../config/tagging.php' => config_path('tagging.php'),
        ]);

        $this->loadMigrationsFrom(__DIR__.'/../migrations');
    }

    public function register()
    {
        $this->mergeConfigFrom(
            __DIR__.'/../config/tagging.php', 'tagging'
        );
    }
}

功能介绍

• boot(): 负责发布配置文件和加载数据库迁移文件。
• register(): 负责合并配置文件。

3. 项目的配置文件介绍

tagging.php

tagging.php 是项目的配置文件，位于 config/ 目录下。该文件定义了标签相关的配置选项。

return [
    'connection' => null,
    'table' => [
        'tags' => 'tags',
        'taggables' => 'taggables',
    ],
    'slugger' => 'strtolower',
    'normalizer' => 'trim',
    'model' => \Conner\Tagging\Model\Tag::class,
    'tagged_model' => \Conner\Tagging\Model\Tagged::class,
    'use_cache' => false,
    'cache_prefix' => 'tagging_',
    'cache_expire' => 1440,
];

配置项介绍

• connection: 数据库连接配置，默认为 null，使用默认数据库连接。
• table: 定义标签和标签关联表的表名。
• slugger: 定义标签的 slug 生成方式，默认为 strtolower。
• normalizer: 定义标签的规范化方式，默认为 trim。
• model: 定义标签模型类，默认为 \Conner\Tagging\Model\Tag。
• tagged_model: 定义标签关联模型类，默认为 \Conner\Tagging\Model\Tagged。
• use_cache: 是否使用缓存，默认为 false。
• cache_prefix: 缓存前缀，默认为 tagging_。
• cache_expire: 缓存过期时间，默认为 1440 分钟。

通过以上配置，可以灵活地调整标签功能的各项设置，以满足不同项目的需求。