madeinearnest / contenttools-php-sdk
内容工具分析API文档。
Requires
- php: >=5.4.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- apimatic/jsonmapper: ~1.3.0
- mashape/unirest-php: ~3.0.1
Requires (Dev)
This package is auto-updated.
Last update: 2024-09-24 18:35:57 UTC
README
内容工具分析API文档。
如何构建
生成的代码依赖于外部库,如UniRest。这些依赖关系在SDK附带的composer.json
文件中定义。要解决这些依赖关系,我们使用Composer包管理器,它要求在您的系统中安装PHP大于5.3.2。访问https://getcomposer.org/download/ 下载Composer安装程序文件,并在您的系统中运行它。打开命令提示符并输入composer --version
。如果安装成功,它应显示已安装的Composer的当前版本。
- 使用命令行,导航到包含生成的文件(包括
composer.json
)的SDK目录。 - 运行命令
composer install
。这将安装所有必需的依赖项,并在您的项目目录中创建vendor
目录。
(仅限Windows用户)在php.ini中配置CURL证书路径
CURL过去包含一组接受的CA列表,但不再捆绑任何CA证书。因此,默认情况下,它将拒绝所有SSL证书为不可验证。您必须获取您CA的证书并将curl指向它。步骤如下
- 从https://curl.haxx.se/docs/caextract.html 下载证书捆绑包(.pem文件)到您的系统中。
- 将curl.cainfo = "PATH_TO/cacert.pem" 添加到您的php.ini文件中,该文件位于您的php安装目录中。 “PATH_TO”必须包含.pem文件的绝对路径。
[curl] ; A default value for the CURLOPT_CAINFO option. This is required to be an ; absolute path. ;curl.cainfo =
如何使用
以下部分解释了如何在新的项目中使用ContentTools库。
1. 在IDE中打开项目
打开PHP的IDE,如PhpStorm。这里展示的基本工作流程也适用于您更喜欢使用不同的编辑器或IDE的情况。
在PhpStorm中,单击打开
以浏览到生成的SDK目录,然后单击确定
。
2. 添加新的测试项目
如以下所示,在解决方案名称上右键单击以创建新目录
将目录命名为"test"
向此项目添加PHP文件
命名为"testSDK"
根据您的项目设置,您可能需要在PHP代码中包含composer的自动加载器以启用类的自动加载。
require_once "../vendor/autoload.php";
确保require_once中的路径正确指向依赖安装期间在vendor目录中创建的autoload.php
文件。
之后,您可以添加代码来初始化客户端库并获取Controller类的实例。后续部分给出了初始化客户端库和使用控制器方法的示例代码。
3. 运行测试项目
要运行您的项目,您必须为项目设置解释器。解释器是安装在您计算机上的PHP引擎。
从文件
菜单中打开设置
。
在语言和框架
中,选择PHP
。
在解释器
选项附近浏览解释器并选择您的解释器。
选择解释器后,单击确定
。
要运行您的项目,在测试项目中的PHP文件上右键单击,然后单击运行
。
如何测试
此SDK中的单元测试可以使用PHPUnit运行。
- 首先使用composer安装依赖项,包括
require-dev
依赖项。 - 从命令行运行
vendor\bin\phpunit --verbose
来执行测试。如果您已全局安装 PHPUnit,则使用phpunit --verbose
来运行测试。
您可以在 phpunit.xml
文件中更改 PHPUnit 测试配置。
初始化
身份验证
为了设置 API 客户端的身份验证和初始化,您需要以下信息。
API 客户端可以按照以下方式初始化。
$oAuthAccessToken = 'oAuthAccessToken'; // OAuth 2.0 Access Token $client = new ContentToolsLib\ContentToolsClient($oAuthAccessToken);
类参考
控制器列表
AnalysisController
获取单例实例
可以从 API 客户端访问 AnalysisController
类的单例实例。
$analysis = $client->getAnalysis();
createSentiment
分析文本的情感
function createSentiment($text)
参数
示例用法
$text = 'text'; $result = $analysis->createSentiment($text);
createTopic
TODO: 添加方法描述
function createTopic($text)
参数
示例用法
$text = 'text'; $result = $analysis->createTopic($text);