README

在服务器端集成Monk ID身份验证和单点登录功能。

概览

使用Composer，将monkdev/monk-id添加到您的composer.json文件中

{
  "require": {
    "monkdev/monk-id": "~1.0"
  }
}

$ composer update

或者

$ composer require monkdev/monk-id:~1.0

配置在外部INI文件中完成。此存储库中有一个示例文件：config/monkId.sample.yml。将此文件复制到您的代码库中，然后在初始化期间在您的代码中加载配置

Monk\Id::loadConfig('/path/to/monkId.ini', 'development');

请记住，用您自己的值替换示例值，并确保文件安全，因为它包含您的应用程序密钥。

如果您已将Monk ID JS配置为自动将有效负载存储在cookie中（默认行为），则可以跳过下一部分，因为cookie也将自动加载。

如果没有，则可以直接传递编码后的有效负载，这在您在GET/POST请求中发送它时非常有用

Monk\Id::loadPayload($monkIdPayload);

必须在尝试访问有效负载中存储的任何值之前加载有效负载。在MVC框架中，这通常意味着将其放置在您的ApplicationController中的方法中，该方法在处理特定操作之前执行。

一旦加载了有效负载，您可以询问用户是否已登录

Monk\Id::loggedIn()

或请求他们的ID和电子邮件

Monk\Id::userId()
Monk\Id::userEmail()

如果用户未登录或无法解码和验证有效负载，则返回null。

使用Composer进行依赖项管理和任务执行。首先安装依赖项

$ composer install

使用PHPUnit进行测试。要运行测试

$ composer test

通过Travis CI设置持续集成以在PHP v5.6、v7.0和v7.1上运行测试。（Circle CI也已设置，用于在PHP v5.6上运行测试，但现在作为备用，直到可以轻松指定多个版本。）代码覆盖率结果在CI期间发送到Codecov以进行时间跟踪。这两个徽章都显示在此README的顶部。

虽然测试套件是完整的，但在现实世界的集成中手动测试更改也不是坏事。

使用phpDocumentor进行代码文档。要构建

$ composer phpdoc

这将在doc目录中创建（该目录由git忽略）。

配置了多个代码质量工具以帮助开发。要一次性运行所有工具

$ composer quality

每个工具也可以单独运行

将版本发布到 Packagist 简单地需要创建一个 Git 标签

$ git tag -a vMAJOR.MINOR.PATCH -m "Version MAJOR.MINOR.PATCH"
$ git push origin vMAJOR.MINOR.PATCH

请务必根据语义化版本控制选择正确的版本。

发布新版本后，必须手动构建文档并将其发布到 gh-pages 分支。