README

Plainmark SDK for PHP 是一个简单的类，它为基于 HTTP 的 RESTful 接口提供了对 Plainmark 分析引擎 的封装。

它允许查询 Plainmark 数据库中测试的应用程序，并请求分析一个应用程序。

SDK 包含结果解释器 - 它允许将原始分析数据转换为人类可读的格式：应用程序的五点评分及其解释（注释）。

安装

如果使用 Composer，将我们的包添加到您的 composer.json 中，然后运行 composer update。

"require": {
	"plainmark/sdk-php": "dev-master"
}

否则，您可以将 plainmark.php 文件简单地包含到您的源代码中。

使用库

您可以在 tests 文件夹中找到如何使用库的示例。典型用法是

序言

<?php

// when using Composer's autoload feature
require_once 'vendor/autoload.php';

// otherwise
require_once 'plainmark.php';

use Plainmark\Plainmark;
use Plainmark\App;

初始化

$plainmark = new Plainmark('your_login', 'your_password');

搜索应用程序

$id = $plainmark->find('com.android.example.package');

提交应用程序进行分析

提交 APK 文件

$id = $plainmark->submit('en-US', 'App Title', 'App description',
	'App Vendor', '/path/to/package.apk');

提交 AppDF 文件

$id = $plainmark->submitAppDF('App Vendor', '/path/to/description.appdf');

检索应用程序分析详细信息

$app = $plainmark->getApp($id);

下载 APK

下载被分析应用程序的 APK 文件

$content = $plainmark->download($id);

打印应用程序的评分和注释

$score = $plainmark->getScore($app);

echo "Rating: {$score['stars']} stars ({$score['score']}/{$score['max_score']}) points\n";

echo "Annotation:\n";
foreach ($plainmark->getAnnotations($app) as $item)
	echo "  * {$item}\n";

错误处理

库在出现错误时使用异常 - 当需要时使用 try-catch。

调整参数

您可以使用 config.csv 定制应用程序分析的解释。使用 config.csv 修改分析描述及其评分。

config.csv 是一个制表符分隔的电子表格文件。该文件包含一系列条件，每个条件占一行。每行定义一个字符串，它位于分析描述中，如果给定行的条件得到满足，则将其添加到评分计算中。

请务必不要更改字段一、二和三。这些列仅用于内部用途。

其余的字段包括

• 字段 4。用于评分计算的得分。
• 字段 5。规则类别。它用于定义在调用具有 $category 参数的 getAnnotations 函数时是否使用描述性字符串。
• 字段 6。注释字符串。在满足条件的行中的所有字符串按从上到下的顺序添加到分析描述中。可以通过规则类别和注释使用进行过滤。
• 字段 7。注释使用。定义在构建分析描述时是否使用此字符串。