野兔巴纳/laravel-js-settings

JavaScript 中的 Laravel 设置

v1.0 2021-08-30 12:40 UTC

This package is auto-updated.

Last update: 2024-09-02 10:28:40 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License PHP Version Require

本包将您从 Laravel 应用中生成的所有设置键和值(oriceon/laravel-settings)转换为 JavaScript,使用一个小的库与这些设置进行交互,语法与您熟悉的语法非常相似。

功能

  • 支持 Laravel 5+。
  • 允许指定不转换为 JS 的所需通配符键。
  • 设置将由包:oriceon/laravel-settings 生成

安装

composer require vildanbina/laravel-js-settings

在您的 Laravel 应用中,转到 config/app.php 并添加以下服务提供者

vildanbina\SettingsJs\LaravelJsSettingsServiceProvider::class

用法

Laravel-JS-Settings 包提供了一个命令,用于生成所有设置的 JavaScript 版本。生成的 JavaScript 文件将包含所有设置。

生成 JS 设置

php artisan settings:js

指定自定义目标

php artisan settings:js public/assets/dist/settings.dist.js

压缩 JS 文件

php artisan settings:js -c

输出 JSON 文件。

php artisan settings:js --json

配置

首先,运行以下命令以发布默认包的配置文件

php artisan vendor:publish --provider="vildanbina\SettingsJs\LaravelJsSettingsServiceProvider"

配置将被发布到 config/settings-js.php

您可以通过编辑配置文件中的 exclude_keys 数组来定义您在 JavaScript 代码中排除的设置键。

<?php

return [
    'exclude_keys' => [
        'smtp_*', 
    ],
];

文档

这是有关此包的快速文档

获取设置

Settings.get('foo');

获取具有默认值的设置

Settings.get('foo', 'bar');

检查设置键是否存在

Settings.has('foo');

先决条件

您需要安装以下软件。

  • Composer。
  • PHP 7+。

开发环境设置

获取所有所需的软件后,您可以运行以下命令来准备一切

  1. 安装 PHP 依赖项
    composer install

贡献

有关详细信息,请参阅 CONTRIBUTING

安全漏洞

请通过电子邮件 vildanbina@gmail.com 报告任何安全漏洞,而不是问题跟踪器。

致谢

许可

MIT 许可证(MIT)。有关更多信息,请参阅 许可文件