tadasei/backend-trashable-notifications

一个提供软删除数据库通知支持的存根包

v1.0.0 2024-09-05 15:30 UTC

This package is auto-updated.

Last update: 2024-09-05 15:44:46 UTC


README

此包为Laravel应用程序后端管理可回收(软删除)数据库通知提供了存根。它通过提供预定义的结构简化了常见的索引、存储、更新和删除通知操作。

特性

  • 快速生成可回收数据库通知管理文件和处理逻辑。
  • 自定义和扩展生成的代码以适应您的项目需求。
  • 通过消除重复任务来提高开发效率。

安装

通过运行以下命令使用Composer安装此包:

composer require tadasei/backend-trashable-notifications --dev

用法

发布可回收通知管理实用工具

要发布实用工具,请运行

php artisan trashable-notifications:install

配置

发布实用工具后,按照以下步骤完成配置

  1. 表单请求配置:修改生成的表单请求(App\Http\Requests\SendNotificationRequest),以适应您应用程序的验证规则和逻辑。

  2. 策略配置:更新生成的策略(App\Policies\DatabaseNotificationPolicy),以控制对通知管理操作的访问,确保它与您项目中的授权系统一致。

  3. 可通知特质替换:该包提供了一个自定义的Notifiable特质,将与其他管理实用工具一起发布。您必须在所需的可通知模型中将内置的Laravel Notifiable特质替换为这个。例如

    use App\Traits\Notifiable;

    这确保了您的模型正确处理可回收通知。

  4. 路由注册:作为管理实用工具的一部分,生成了routes/resources/notification.php文件。您必须在应用程序的内置routes/web.phproutes/api.php中注册此文件,以使包路由可用。例如,在routes/api.php

    <?php
    
    require __DIR__ . '/resources/notification.php';

    默认情况下,生成的路由由auth:sanctum中间件保护。如果您的项目使用不同的身份验证守卫,您可能需要更新中间件以适应您的身份验证系统。

    Route::middleware('auth:your_guard')->group(function () {
        // Register routes
    });
  5. 运行迁移:作为实用工具的一部分,该包生成迁移。您需要运行此迁移以设置管理可回收通知所需的数据结构。使用以下Artisan命令

    php artisan migrate

这些步骤是必要的,以确保该包与您的应用程序现有结构顺利集成。

进一步定制

生成的代码作为起点。您可以进一步扩展和定制它以适应项目需求。

贡献

欢迎贡献!如果您有建议、错误报告或功能请求,请在GitHub存储库中创建一个问题。

许可

此包是开源软件,在MIT许可下授权。