bbcarchdev / liblod
一个LOD客户端库。
Requires
- easyrdf/easyrdf: ^0.9.1
- guzzlehttp/guzzle: ^6.2
- guzzlehttp/psr7: ^1.4
- pietercolpaert/hardf: ^0.1.1
Requires (Dev)
- consolidation/robo: ^1.1
- phpcheckstyle/phpcheckstyle: ^0.14.6
- phpmd/phpmd: ^2.6
This package is not auto-updated.
Last update: 2024-09-21 15:53:27 UTC
README
PHP的Linked Open Data客户端库,作为RES项目的一部分开发。
它也适用于Linked Data(没有“Open”),但最初是为LOD开发的,名称保留。
注意,这是一些实验性代码,仍在开发中。
需求
PHP 5.6或更高版本(在PHP 7下运行,但未使用PHP 7的功能)。
安装
要安装此库以供您自己的代码使用,请执行以下操作
composer require bbcarchdev/liblod
用法
见liblod-php_usage.md(在此目录中)。
代码开发
要开发liblod-php,请克隆仓库
git clone https://github.com/bbcarchdev/liblod-php.git liblod-php
cd liblod-php
然后,您需要安装依赖项。您可以使用以下命令来完成此操作
php tools/composer.phar install
运行测试
要运行单元测试
./vendor/bin/robo unit
要运行集成测试
./vendor/bin/robo int
请注意,集成测试针对的是实际的Acropolis堆栈和其他LOD网站,因此您需要网络连接才能运行它们。它们也可能相对脆弱,因为获取的资源语句的数量可能会根据所摄入的内容定期更改,这可能会偶尔导致测试失败。
代码覆盖率
要为测试生成代码覆盖率报告,您首先需要安装XDebug PHP模块。然后,运行
./vendor/bin/robo cov
您可以通过在浏览器中打开build/cov/index.html来查看报告。
代码质量
可以使用以下命令运行代码质量检查
./vendor/bin/robo mess
这使用PHPMD来报告代码的各种问题。
API文档
可以使用以下命令生成基本的(不完整的)API文档
./vendor/bin/robo docs
生成的文档将出现在build/apidocs/目录中。
代码样式检查
可以使用以下命令检查代码样式
./vendor/bin/robo style
代码样式报告将出现在build/style/目录中。
(请注意,代码样式配置在phpcheckstyle-config.xml文件中。)
作者
API设计由Mo McRoberts。
实现由Elliot Smith。
贡献
通过github pull requests接受贡献。
请使用github issue tracker来提出问题。
许可证
Elliot Smith, © BBC 2017
liblod-php根据Apache License 2.0的条款许可(见LICENCE-APACHE.txt)。
liblod-php代码库分发以下软件(在开发期间使用)
- Composer:根据MIT许可证分发。有关完整许可证,请参阅
tools/LICENCE-COMPOSER-MIT.txt。 - PHPUnit:在3-clause BSD许可证下分发。请参阅
tools/LICENCE-PHPUNIT-BSD3.txt以获取完整的许可证。 - phpDocumentor:在MIT许可证下分发。请参阅
tools/LICENCE-PHPDOCUMENTOR-MIT.txt以获取完整的许可证。
(注意:这些库与源代码一起分发,因为它们与运行库使用的依赖项存在版本冲突,或者安装不便。)
liblod-php在运行时依赖于这些库(许可证如所述);这些库不与liblod-php一起分发
- pietercolpaert/hardf - MIT许可证
- easyrdf/easyrdf - BSD 3-clause许可证
- guzzlehttp/psr7 - MIT许可证
- guzzlehttp/guzzle - MIT许可证
liblod-php在开发时依赖于这些库(许可证如所述);这些库不与liblod-php一起分发