mabrouk/project-setting

这是一个用于处理项目设置分组的 Laravel 扩展包

1.2.0 2024-09-18 13:04 UTC

README

mabrouk/project-setting 是一个用于处理项目设置的 Laravel API 扩展包。

目录

使用顺序

安装

根据项目需求进行配置

开箱即用的模型

开箱即用的路由

还有其他什么吗?

还有其他什么吗?

许可证

使用顺序

安装和修改配置后

  • 运行以下命令:php artisan setting:install
  • 在您的 API 文档中包含预定义的路由,这些路由控制项目设置类型、分组、部分和设置显示名称,以便前端开发者可以从前端实现。或者指导前端开发者查阅模型 API 资源以期望在请求和响应中这一部分

安装

您可以使用 composer 安装此包。

composer require mabrouk/project-setting
  • 现在您需要运行以下 命令 以迁移包表并将 project_settings.php 配置文件发布到配置目录
php artisan setting:install

根据项目需求进行配置

配置文件有多个配置选项,并已包含足够的注释来描述每个键的意义和使用方法。

您可以在 config/project_settings.php 下访问它

修改 project_settings.php 配置文件后,请务必运行以下命令

php artisan config:cache

开箱即用的模型

我们处理了 4 个基本模型

  • ProjectSettingType
  • ProjectSettingGroup
  • ProjectSettingSection
  • ProjectSetting

开箱即用的路由

让我们运行 route:list 命令来发现我们包中预定义的路由

php artisan route:list

还有其他什么吗?

// 待续

还有其他什么吗?

实际上,还有一点需要知道的是,此包依赖于 mabrouk/translatable 包来处理所选语言的动态翻译。

您需要在提到的模型更新请求中传递额外的输入 "locale",并需要使用您应用程序的默认语言创建组和部分。

要获取带有所需语言的响应,您需要在请求中传递额外的头 "X-locale",其值为您应用程序中可用的一个区域设置

"locale" 和 "X-locale" 都接受如 ['en', 'ar', 'fr', ...] 等值,具体取决于您项目中支持的语言。

许可证

mabrouk/project-setting 包是开源软件,许可协议为 MIT 许可