README

此PHP SDK是我们NullNude API的包装器，NullNude API是一种成人内容检测/审查服务。

使用NullNude API立即审查用户提交的图片中的成人内容。

安装

NullNude PHP SDK可以通过Composer安装。

php composer.phar require dneural/php-nullnude dev-master

或者手动将存储库添加到您的composer.json文件中

{
    "require": {
        "dneural/php-nullnude": "dev-master"
    }
}

然后通过运行以下命令安装SDK

php composer.phar install

检查examples目录以了解如何有效地使用SDK。

认证NullNude API

每个使用NullNude API的应用程序都需要进行认证。因此，您需要在我们这里注册一个账户。这是一个非常简单的流程，可以在以下地址完成：https://nullnude.com/register

记下您的api_key和api_secret，然后即可开始使用。

检查图像中的裸露内容、感兴趣区域

检查图像是否包含裸露内容非常简单。提供您想要检查的图像的URL或本地文件路径到我们API支持的几种方法之一。

<?php
require __DIR__ . '/vendor/autoload.php';
use NullNude\NullNude;

// Information about your API access.
$config = [
    'api_key'    => 'YOUR_API_KEY',
    'api_secret' => 'YOUR_API_SECRET'
];

// Initialize the NullNude client.
$nullNude = new NullNude($config);

// Image can be either a local path or an external url.
$image = "https://nullnude.com/wp-content/uploads/2016/01/vintage_porn_2.jpg";

// Check if the image has nuidty in it.
$nudityResource = $nullNude->checkNudity($image);
if ( $nudityResource->hasNudity() ) {
    // Take action based on your confidence preference.
    echo 'Image nudity confidence: ' . 
         $nudityResource->getNudityConfidence();
}

// Get the array of regions of interest within the image.
$roiResource = $nullNude->getRoi($image);
echo "<pre>";
print_r($roiResource->getRoi());
echo "</pre>";

// Check if the image has been moderated, moderate.json 
// applies the filter only if there was nudity present.
$moderateResource = $nullNude->moderate($image);
if ( $moderateResource->isModerated() ) {
    // Download and save the moderated image.
    echo 'Moderated image url: ' . 
         $moderateResource->getModeratedUrl();
}

请考虑检查examples目录以获取更多实际使用示例。

如何构建文档？

文档基于phpdocumentor。要安装它，请克隆php-nullnude项目

git clone https://github.com/dneural/php-nullnude.git
cd php-nullnude
php composer.phar install

要在./docs/nullnude目录生成文档，请运行

./vendor/bin/phpdoc -d ./src -t ./docs/nullnude

如何运行测试？

测试基于phpunit。要运行它们，请克隆php-nullnude项目

git clone https://github.com/dneural/php-nullnude.git
cd php-nullnude
php composer.phar install

并运行此命令

./vendor/bin/phpunit --coverage-text

许可证

SDK代码以MIT样式许可证发布，这意味着它可以轻松集成到您的应用程序中。
有关更多信息，请参阅LICENSE文件。