README

适用于任何项目的基库，也是其他diamond项目的依赖库。

入门指南

以下说明将帮助您在本地机器上复制项目并进行开发测试。有关如何在生产系统上部署项目的说明，请参阅部署部分。

先决条件

您需要安装Composer来安装Diamond。

$ composer require diverproject/diamond-lang "^3.0"

安装

要执行所有测试用例（或套件），您需要PHP Unit

$ phpunit

设置系统环境，这可以产生不同的反应，请参阅wiki中受此设置影响的类或类文档。例如，当运行PHP Unit时，启用ENVIRONMENT_TEST_CASE并使用diamond\test\lang\AbstractDiamondTest

Diamond::setEnvironment(Diamond::ENVIRONMENT_HOMOLOG); // Options: ENVIRONMENT_HOMOLOG, ENVIRONMENT_TEST_CASE or ENVIRONMENT_PRODUCTION

将解析方法抛出的异常设置为不同的类，请参阅wiki中受此设置影响的方法或方法文档。启用时，解析失败将抛出异常，否则将返回NULL或默认值（如果可能）。在某些情况下，默认值无法解决问题，因此将返回NULL。

Diamond::setEnabledParseThrows(TRUE); // Options: TRUE or FALSE

这就完成了，不要忘记在像composer这样的使用中包含库，例如include 'vendor/autoload.php'（将取决于您的系统文件结构）

运行测试

测试脚本位于test根目录中。

Composer更新

首先更新依赖库并生成composer的vendor autoload

$ composer update

or if you are in Windows execute 'composer-update.bat' (it's more easy) - it's same think as above

现在您可以执行PHP Unit并检查测试结果，有两种方法

第一种方法更简单，即执行phpunit.bat；检查内容文件以了解详情，如果您不知道PHP Unit，请参阅此链接这里。

第二种方法仅在您在Eclipse PHP中打开项目时才有效，设置PHP Unit Preferences并运行单个脚本或选择一个或多个并运行。

观察

一些类可能没有测试脚本，因为需要其他东西才能工作，例如Cookie、Get、Post和Session类在diamond\lang\http中。

如果您看到一些问题或没有测试脚本的类，请告诉我们。

部署

别忘了 将您系统环境的运行类型改为

Diamond::setEnvironment(Diamond::ENVIRONMENT_PRODUCTION);

构建工具

Composer - 依赖管理框架

版本控制

我们使用SemVer进行版本控制。有关可用的版本，请参阅此存储库的标签。

修订日志有些不同，因为它是开发者发现更容易更改的地方，并使github提交消息更干净。.

作者

Andrew Mello da Silva - 开发者 - Driw

许可证

本项目的许可证为MIT许可证 - 有关详细信息，请参阅LICENSE.md文件

致谢

比莉·汤普森 - 阅读模板 - PurpleBooth

diverproject / diamond-lang

维护者

详细信息