classera/tincan

体验API(Tin Can API)库

dev-master 2023-04-13 13:22 UTC

This package is not auto-updated.

Last update: 2024-09-28 20:14:53 UTC


README

实现体验API(Tin Can API)的PHP库。

Build Status Latest Stable Version License Total Downloads

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

http://rusticisoftware.github.io/TinCanPHP/

有关体验API的更多信息,请访问:

http://experienceapi.com/

需要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.phptests/config/config.php并设置您的LRS的值来配置LRS端点和凭证。

配置完成后运行

vendor/bin/phpunit

API文档生成

可以使用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.txthttps://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