byyoursitenl / doccloud
DocCloud Web API 的 PHP 封装。由 ByYourSite BV 编写并支持。
Requires
- php: ^5.6 || ^7.0
- guzzlehttp/guzzle: ^6.1
Requires (Dev)
- phpunit/phpunit: ^4.8 || ^5.7
- smalot/pdfparser: ^0.9
- squizlabs/php_codesniffer: ^3.0
- symfony/var-dumper: ^3.0
This package is not auto-updated.
Last update: 2024-10-03 06:09:49 UTC
README
这是 DocCloud Web API 的官方 PHP 封装。它由 Byyoursite BV 编写并支持。
最低要求
DocCloud PHP 封装需要 PHP 5.6 或更高版本。有两个技术原因
-
PHP 5.6 之前的所有版本都已达到 生命周期的结束,因此不应在生产环境中使用。
-
依赖项 guzzlehttp/guzzle 需要 PHP 5.6 或更高版本。
如果您的应用程序正在运行在较旧的环境中,强烈建议升级到更新的 PHP 版本。
如果您无法或不愿意更新您的 PHP 安装,可以通过直接访问 [Web API] 来使用 DocCloud 而不使用此封装。在这种情况下,建议使用 curl 扩展来调用 API。
使用 Composer 安装
在您的项目中安装 DocCloud PHP 封装的最佳方式是使用 Composer
composer require byyoursitenl/doccloud:^1.0
安装后,您需要要求 Composer 的自动加载器
require 'vendor/autoload.php';
然后您可以稍后使用 Composer 更新 DocCloud PHP 封装
composer update
并为了最佳自动加载性能相应地执行
composer dump-autoload --optimize
演示和单元测试的用户名和密码
DocCloud PHP 封装附带了一些示例应用程序(请参阅目录 /demo
)和 phpunit 测试(请参阅目录 /test
)。这些目录中的脚本需要 DocCloud 的用户名和密码才能执行。为了确保您的用户名和密码不会无意中通过公共 GIT 仓库公开,您首先需要指定它们。您可以通过两种方式做到这一点
使用 PHP 常量
define('DOCCLOUD_USERNAME', 'your-username'); define('DOCCLOUD_PASSWORD', 'your-password');
使用环境变量(例如在 .bashrc
或 .env
中)
export DOCCLOUD_USERNAME='your-username' export DOCCLOUD_PASSWORD='your-password'
注意,这些说明仅适用于演示脚本和 phpunit 测试。当您在应用程序中使用 DocCloud 时,请使用构造函数设置凭证,使用 setApiKey($apiKey)
或 setUsername($username)
和 setPassword($password)
方法。有关示例,请参阅 /demo/instantiation.php
。