A library for interfacing with WebPurify.
The library is covered by PHPUnit tests using stub mocks and is PSR-0, PSR-1, PSR-2 and PSR-3 compliant.
Add the following to your composer.json.
{
"require": {
"agencyrepublic/webpurify": "dev-master"
}
}
There are two classes which you can use to make requests to Web Purify:
WebPurify\WebPurifyImageWebPurify\WebPurifyText
Most methods listed on the WebPurify documentation can be used as method names
for making API calls. There is exception as return is a reserved keyword in
PHP the method name is returnExpletives.
These methods are available in both classes.
WebPurify class is a PSR-3 compliant LoggerAwareInterface. It outputs all HTTP requests and responses to a logger. You will need a logger (like Monolog).
$logger = new Logger('name');
$logger->pushHandler(new StreamHandler('path/to/your.log'));
$webPurifyImage = new WebPurify\WebPurifyImage($apiKey);
$webPurifyImage->setLogger($logger);
Get whether SSL will be used for requests.
var_dump($webPurifyImage->getUseSSL()); // bool(FALSE)
Set whether SSL will be used for requests. The default is false.
$webPurifyImage->setUseSSL(true); // Use SSL in requests
Instantiate WebPurifyImage by passing through your API key:
$webPurifyImage = new WebPurify\WebPurifyImage($apiKey);
Returns: <imgid>
Documentation: webpurify.live.imgcheck
# string => imgurl
$webPurifyImage->imgCheck("http://.../");
# array => post data
$webPurifyImage->imgCheck(array(
"imgurl" => "http://.../"
// ...
));
Returns:
- true => approved
- false => declined
- null => pending
Documentation: webpurify.live.imgstatus
# string => imgid
$webPurifyImage->imgStatus("0123456789abcdef0123456789abcdef");
# array => post data
$webPurifyImage->imgCheck(array(
"imgid" => "0123456789abcdef0123456789abcdef"
// ...
));
Returns: <remaining>
Documentation: webpurify.live.imgaccount
# No parameters
$webPurifyImage->imgAccount();
# array => post data
$webPurifyImage->imgAccount(array(
// ...
));
Instantiate WebPurifyTexxt by passing through your API key:
$webPurifyText = new WebPurify\WebPurifyText($apiKey);
Returns: boolean <found>
Documentation: webpurify.live.check
# string => text
$webPurifyText->check("the quick brown fox jumps over the lazy dog");
# array => post data
$webPurifyText->check(array(
"text" => "the quick brown fox jumps over the lazy dog"
// ...
));
Returns: boolean <found>
Documentation: webpurify.live.checkcount
# string => text
$webPurifyText->checkCount("the quick brown fox jumps over the lazy dog");
# array => post data
$webPurifyText->check(array(
"text" => "the quick brown fox jumps over the lazy dog"
// ...
));
Returns: string <text>
Documentation: webpurify.live.replace
# string => text
$webPurifyText->checkCount("the quick brown fox jumps over the lazy dog");
# array => post data
$webPurifyText->check(array(
"text" => "the quick brown fox jumps over the lazy dog"
// ...
));
Returns: array <word>
Documentation: webpurify.live.return
# string => text
$webPurifyText->returnExpletives("the quick brown fox jumps over the lazy dog");
# array => post data
$webPurifyText->returnExpletives(array(
"text" => "the quick brown fox jumps over the lazy dog"
// ...
));
Returns: boolean <success>
Documentation: webpurify.live.addtoblacklist
# string => text
$webPurifyText->addToBlackList("scunthorpe");
# array => post data
$webPurifyText->addToBlackList(array(
"word" => "scunthorpe"
// ...
));
Returns: boolean <success>
Documentation: webpurify.live.addtowhitelist
# string => word
$webPurifyText->addToWhiteList("scunthorpe");
# array => post data
$webPurifyText->addToWhiteList(array(
"word" => "scunthorpe"
// ...
));
Returns: boolean <success>
Documentation: webpurify.live.removefromblacklist
# string => word
$webPurifyText->removeFromBlackList("scunthorpe");
# array => post data
$webPurifyText->removeFromBlackList(array(
"word" => "scunthorpe"
// ...
));
Returns: boolean <success>
Documentation: webpurify.live.removefromwhitelist
# string => word
$webPurifyText->removeFromWhiteList("scunthorpe");
# array => post data
$webPurifyText->removeFromWhiteList(array(
"word" => "scunthorpe"
// ...
));
Returns: array <word>
Documentation: webpurify.live.getblacklist
# No parameters
$webPurifyText->getBlackList();
# array => post data
$webPurifyText->getBlackList(array(
// ...
));
Returns: array <word>
Documentation: webpurify.live.getwhitelist
# No parameters
$webPurifyText->getWhiteList();
# array => post data
$webPurifyText->getWhiteList(array(
// ...
));