README

一个WordPress PHP Composer包，提供在其它Nomad Composer包中使用的辅助函数和实用工具。

安装

您可以使用Composer在项目中安装Nomad Helper。

$ composer require jakesutherland/nomad-helpers

文档

Nomad Helper提供的大多数函数和实用工具都相当直观，已在代码库中进行了良好的文档记录。

以下是需要您关注的重要信息。

Nomad 环境

使用 NOMAD_ENV 常量确定WordPress安装运行的环境类型。这应在您的 wp-config.php 文件中定义。

可能的值：development staging production

默认值：production

如果您正在在计算机上构建项目，则需要为开发配置环境

define( 'NOMAD_ENV', 'development' );

如果您正在测试测试环境中的网站

define( 'NOMAD_ENV', 'staging' );

如果您的网站是实时运行的，则配置生产环境

define( 'NOMAD_ENV', 'production' );

强烈建议您永远不要将实时生产网站设置为 development。

Nomad 调试

在 development 环境中，使用 NOMAD_DEBUG 常量显示额外的调试信息。这也应在您的 wp-config.php 文件中定义。

define( 'NOMAD_DEBUG', true );

Nomad 错误

在开发环境中工作项目时，您可能会遇到Nomad错误。Nomad错误的目的在于帮助您在使用Nomad功能和实用工具进行开发时找到正确的方向。

当 NOMAD_ENV 设置为 development 时，Nomad错误将停止所有处理并显示错误消息。

如果 NOMAD_ENV 设置为 staging 或 production，则不会显示Nomad错误。

重要：如果 NOMAD_ENV 未定义且未设置为 development，则不会看到任何Nomad错误消息！默认假设您在开发环境中。

Nomad 异常

Nomad异常与Nomad错误大不相同，当代码无法从自身恢复并且应用程序需要停止处理时发生。某些东西出了问题。

Nomad异常将显示，无论您的 NOMAD_ENV 设置如何。

注册Nomad包和插件

使用 register_nomad_package() 和 register_nomad_plugin() 函数在全局范围内注册Nomad包或插件。这样，系统就知道哪些Nomad包或插件可用和正在使用。它通过传入其安装路径来帮助确定特定包被加载的位置。这是很重要的，因为每个Nomad插件可能都利用多个Nomad包作为依赖项，而每个Nomad包也可能有自己的依赖项。

每个Nomad包都经过开发，无论在其它各种Nomad插件或包中安装了多少实例，都只会加载一次。

变更日志

1.2.0

• 添加了 register_nomad_package() 和 register_nomad_plugin() 函数。
• 添加了包含各种常量的 Nomad_Constants 类。
• 更新了 Nomad_Exception 类的文件名，以 class- 前缀开头。
• 更新了变更日志版本号格式。
• 修复了 nomad_format_attributes()，当属性是布尔值且其值为false时，不应将键添加到属性列表中。
• 从 composer.json 文件中删除了 type 属性。

1.1.0

• 更新了常量（包名为Nomad Helpers，而非Nomad Helper）。
• 更新了常量注释，包括上下文和添加版本号。
• 更新了nomad_error()函数注释，提供更多预期上下文。
• 在README.md中添加了NOMAD_ENV文档。
• 添加了NOMAD_HELPERS_SRC_PATH常量。
• 添加了NOMAD_DEBUG常量（默认值为false）。
• 在README.md中添加了NOMAD_DEBUG文档。
• 添加了Nomad_Exception类。
• 在README.md中添加了Nomad_Exception文档。
• 在README.md中添加了nomad_error()文档。
• 添加了nomad_array_keys_exist()函数。
• 添加了nomad_array_keys_missing()函数。
• 在README.md中添加了变更日志。

1.0.0

• 初始版本发布

许可协议

MIT 许可协议（MIT）。请参阅许可文件以获取更多信息。

版权

版权（c）2021 Jake Sutherland