arandu / laravel-site-options
该软件包最新版本(v4.0.0)没有可用的许可证信息。
v4.0.0
2024-09-01 01:17 UTC
Requires
- php: ^8.2
- illuminate/database: ^11.0
- illuminate/support: ^11.0
Requires (Dev)
- orchestra/testbench: ^9.0
- phpunit/phpunit: ~11.0
README
Laravel Site Options 是一个功能强大且易于使用的软件包,专为需要轻松管理全局网站设置的 Laravel 开发者量身定制。无论是构建动态 Web 应用程序还是复杂的平台,该软件包都提供了一个干净、直观的界面,用于存储和检索全局选项,并内置缓存以提供卓越的性能。
🚀 安装
通过 Composer 安装包开始使用
composer require arandu/laravel-site-options
接下来,发布配置和迁移文件
php artisan vendor:publish --provider="Arandu\LaravelSiteOptions\SiteOptionsServiceProvider"
运行迁移以创建必要的数据库表
php artisan migrate
💡 使用
Laravel Site Options 提供了一个流畅的 API,使管理网站选项变得轻松
use Arandu\LaravelSiteOptions\Option; // Store options Option::set('welcome_message', 'Hello, World!'); Option::set('site_settings', ['theme' => 'dark', 'layout' => 'wide']); // Retrieve options echo Option::get('welcome_message'); $settings = Option::get('site_settings', [ // ... the default settings ]); // Check if an option exists if (Option::has('maintenance_mode')) { // Perform action } // Remove options Option::rm('outdated_option');
有关更多详细信息,请参阅高级使用部分。
🌟 特点
- 功能开关:轻松管理功能标志,以便实时启用或禁用功能。
- 全局网站设置:存储和检索必要的网站设置,如网站名称、标志等。
- 动态内容:允许管理员配置内容,例如页脚电话号码或弹出延迟时间。
- 更多:可能性无限!
⚙️ 配置
在 config/site-options.php 中自定义软件包设置
table:定义存储选项的数据库表名称。cache:微调缓存设置。enabled:切换缓存(true/false),可通过.env文件作为SITE_OPTIONS_CACHE_ENABLED配置。key:设置存储选项的缓存键。ttl:定义缓存 TTL(分钟),可通过.env文件作为SITE_OPTIONS_CACHE_TTL配置。
hard_defaults:指定选项的硬编码默认值。如果您在调用Option::get()时指定默认值,则该值将优先。
修改 config/site-options.php 以满足您的需求,并使用 .env 文件进行特定环境的配置。
🔄 版本兼容性
请参阅下表以匹配您的 Laravel 版本与相应的 Laravel Site Options 版本
🛠️ 测试
composer test
🚨 问题
遇到问题?在我们的 GitHub 问题跟踪器 上报告。
🔒 安全
有关安全问题,请参阅 SECURITY.md。
🤝 贡献
我们欢迎社区贡献!请阅读 CONTRIBUTING.md 以开始。
📜 许可证
本项目采用 MIT 许可证开源。有关详细信息,请参阅 LICENSE 文件。