beebmx/kirby-env

启用 Kirby 3 & 4 的环境变量

安装次数: 24,748

依赖项: 0

建议者: 0

安全性: 0

星标: 15

关注者: 2

分支: 0

开放问题: 0

类型:kirby-plugin

4.2.1 2024-07-01 15:33 UTC

This package is auto-updated.

Last update: 2024-08-31 15:50:05 UTC


README

Latest Stable Version GitHub Workflow Status Total Downloads License

Kirby Env 使用 vlucas/phpdotenv 包来启用 Kirby 的功能。如果您希望将项目凭证或变量存储在代码之外的地方,或者希望在不同地方有开发和生产访问权限,则应使用此包。

安装

使用 composer 安装

composer require beebmx/kirby-env

使用方法

如果您想在任何 $page 中访问,不需要做任何事情,只需使用页面方法即可。

$page->env('VAR');

但是,如果您想在 config.php 文件中设置变量,首先您需要使用以下方式加载对象:

\Beebmx\KirbyEnv::load('main/path');

您需要在 main/path 目录中有一个 .env 文件。
您可以将任何凭证或变量安全地存储如下:

KIRBY_DEBUG=false

SECRET_KEY=my_secret_key
PUBLIC_KEY=my_public_key

FOO=BAR
BAZ=${FOO}

选项

当您创建 \Beebmx\KirbyEnv 的实例时,您需要使用以下方式加载环境:

\Beebmx\KirbyEnv::load();

如果您需要 vlucas/phpdotenv 提供的不变性,只需

\Beebmx\KirbyEnv::overload();

示例

以下是一个 config.php 文件中的配置示例

<?php

\Beebmx\KirbyEnv::load('main/path');

return [
    'debug' => env('KIRBY_DEBUG', false),
    'SECRET' => env('SECRET_KEY'),
    'PUBLIC' => env('PUBLIC_KEY'),
];

使用说明

您非常重要地需要在 .gitignore 中添加 .env 文件。其中 main/path.env 文件所在的位置。