Laravel-Userstamps 项目教程

Laravel-Userstamps 项目教程

Laravel-UserstampsLaravel Userstamps provides an Eloquent trait which automatically maintains `created_by` and `updated_by` columns on your model, populated by the currently authenticated user in your application.项目地址:https://gitcode.com/gh_mirrors/la/Laravel-Userstamps

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

Laravel-Userstamps 项目的目录结构如下：

Laravel-Userstamps/
├── src/
│   ├── Userstamps.php
│   └── UserstampsServiceProvider.php
├── tests/
│   └── UserstampsTest.php
├── .editorconfig
├── .gitignore
├── .styleci.yml
├── .travis.yml
├── LICENSE
├── README.md
├── composer.json
└── phpunit.xml.dist

目录介绍

• src/: 包含项目的主要源代码文件。
  • Userstamps.php: 提供 Eloquent 模型的 trait，用于自动维护 created_by 和 updated_by 列。
  • UserstampsServiceProvider.php: 服务提供者，用于注册和引导包。
• tests/: 包含项目的测试文件。
  • UserstampsTest.php: 用于测试 Userstamps 功能的测试文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置。
• .styleci.yml: StyleCI 配置文件，用于代码风格检查。
• .travis.yml: Travis CI 配置文件，用于持续集成。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• composer.json: Composer 依赖管理文件。
• phpunit.xml.dist: PHPUnit 测试配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 UserstampsServiceProvider.php，它位于 src/ 目录下。

UserstampsServiceProvider.php

该文件是 Laravel 服务提供者，负责注册和引导 Userstamps 包。主要功能包括：

• 注册服务提供者。
• 发布配置文件。

namespace Wildside\Userstamps;

use Illuminate\Support\ServiceProvider;

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

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

3. 项目的配置文件介绍

项目的配置文件是 config/userstamps.php，可以通过以下命令发布到 Laravel 项目的 config/ 目录下：

php artisan vendor:publish --provider="Wildside\Userstamps\UserstampsServiceProvider" --tag="config"

config/userstamps.php

该配置文件包含以下内容：

return [
    'users_table' => 'users',
    'users_table_column_type' => 'bigIncrements',
    'users_table_column_id_name' => 'id',
];

配置项介绍

• users_table: 定义用于检索用户的表名。
• users_table_column_type: 定义用户表中 id 列的类型，可选值为 increments, bigIncrements, uuid，默认值为 bigIncrements。
• users_table_column_id_name: 定义用户表中 id 列的名称，默认值为 id。

以上是 Laravel-Userstamps 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

Laravel-UserstampsLaravel Userstamps provides an Eloquent trait which automatically maintains `created_by` and `updated_by` columns on your model, populated by the currently authenticated user in your application.项目地址:https://gitcode.com/gh_mirrors/la/Laravel-Userstamps