README

一个用于实现 Experience API (Tin Can API) 的 PHP 库。

有关托管 API 文档、基本使用说明、支持的版本列表等信息，请访问主项目网站：

有关 Experience API 的更多信息，请访问：

需要 PHP 5.5 或更高版本。 (如果您必须运行更早的版本，您应该查看 0.x 版本系列或 PHP_5_2 分支。)

TinCanPHP 通过 Composer 提供。

php composer.phar require rusticisoftware/tincan:@stable

当不使用 Composer 时，需要引入自动加载器

require 'path/to/TinCan/autoload.php';

测试使用最新稳定版本的 PHPUnit 实现。当使用 Composer 时会安装。通过复制 tests/config/config.dist.php 到 tests/config/config.php 并设置您的 LRS 的值来配置 LRS 端点和凭证。

配置完成后运行

vendor/bin/phpunit

可以使用 phpDocumentor2 输出文档。当使用 Composer 时会安装。要生成文档

vendor/bin/phpdoc

在运行 php composer.phar update 后从存储库的根目录生成。文档将输出到 doc/api。

如果您在 php.ini 文件中没有设置默认时区，您可以在存储库的根目录下创建一个，并使用 PHPRC 环境变量指向它。例如：

export PHPRC="/path/to/repos/TinCanPHP/php.ini"

并在该文件中设置时区

[PHP]

date.timezone = "US/Central"

以下说明是在已安装 OpenSSL 的 Mac 上创建所需公钥/私钥对和证书的步骤。请参阅 https://www.openssl.org/docs/HOWTO/certificates.txt 和 https://www.openssl.org/docs/HOWTO/keys.txt。

生成不带密码的私钥（不建议）

openssl genrsa -out privkey.pem 2048

要生成带密码的私钥

openssl genrsa -des3 -out privkey.pem 2048

创建证书签名请求

 openssl req -new -key privkey.pem -out cert.csr

要创建自签名证书（而非由 CA 签名的证书），主要用于测试目的

openssl req -new -x509 -key privkey.pem -out cacert.pem -days 1095

opigno / tincan