Anura Docs

<?php

// Make sure you require the Composer autoloader!
require 'vendor/autoload.php';

// Or if you're using the PHAR, require/include that.
require '/path/to/anura-sdk-php.phar';

// Or if you're using the ZIP, require/include its autoloader.
require '/path/to/anura-sdk-php/autoload.php';

use Anura\AnuraDirect;
use Anura\DirectRequestBuilder;
use Anura\DirectRequest;
use Anura\AdditionalData;
use Anura\DirectResult;
use Anura\Exception\AnuraException;
use Anura\Exception\AnuraClientException;
use Anura\Exception\AnuraServerException;

// Creating an Anura Direct Client. Replace 'your-instance-id' with your actual Instance ID.
$direct = new AnuraDirect('your-instance-id');
?>

/**
  * To send additional data to Anura Direct, use the AdditionalData class.
  * We will provide this object when calling $direct->getResult()
  */
$additionalData = new AdditionalData();
$additionalData->addElement(1, 'your-data-value');

// To update an element of additional data, simply add the element again but with a new value.
$indexToUpdate = 1;
$additionalData->addElement($indexToUpdate, 'your-new-data-value');

$indexToRemove = 1;
$additionalData->removeElement($indexToRemove);

$builder = new DirectRequestBuilder();
$request = $builder
                ->setIpAddress('visitors-ip-address')  // required
                ->setSource('your-source-value')       // optional
                ->setCampaign('your-campaign-value')   // optional
                ->setUserAgent('visitors-user-agent')  // optional
                ->setApp('visitors-app-id')            // optional
                ->setDevice('visitors-device-id')      // optional
                ->setAdditionalData($additionalData)   // optional
                ->build();

try {
    $result = $direct->getResult($request);
} catch (AnuraClientException $e) {
    // Handle 4XX responses here.
} catch (AnuraServerException $e) {
    // Handle 5XX responses here.
} catch (AnuraException $e) {
    /**
      * Handle any other exceptions that may occur.
      * Since AnuraClientException & AnuraServerException are children of AnuraException,
      * feel free to remove those catch blocks if your handling logic is the same for both.
      */
}

// We got a result (a DirectResult object)!
// See below for available methods on DirectResult objects.

if ($result->isSuspect()) {
    // Perform some logic only for suspect visitors
}

if ($result->isNonSuspect()) {
    // Perform some logic only for non-suspect visitors
}

if ($result->isMobile()) {
    // Perform some logic only for visitors from mobile devices
}

$ruleSets = $result->getRuleSets();
$isWebCrawler = (!is_null($ruleSets) && in_array("WC", $ruleSets));
if ($isWebCrawler) {
    // Perform some logic only for web crawlers
}

$anuraResult = $result->getResult();
$invalidTrafficType = $result->getInvalidTrafficType();

echo "Visitor Result: $anuraResult\n";
echo "Invalid Traffic Type: $invalidTrafficType\n";

getInstance(): string

• Returns the instance you have set within the AnuraDirect client.

setInstance(string $instance): void

• Sets the instance ID of the AnuraDirect client to the $instance value passed.

addElement(int $key, string $value): void

• Adds an element of additional data to be sent to Anura Direct.
• If you call addElement() multiple times with the same $key, the element at $key will simply be updated with the new $value.

removeElement(int $key): void

• Removes the element of additional data located at $key.

size(): int

• Returns the number of elements set within your AdditionalData instance.

build(): DirectRequest

• Builds and returns the DirectRequest as configured.

setSource(string $source): DirectRequestBuilder

• Sets the source for the DirectRequest to be built.

setCampaign(string $campaign): DirectRequestBuilder

• Sets the campaign for the DirectRequest to be built.

setIpAddress(string $ipAddress): DirectRequestBuilder

• Sets the IP address for the DirectRequest to be built.
• Both IPv4 and IPv6 addresses are supported.

setUserAgent(string $userAgent): DirectRequestBuilder

• Sets the user agent for the DirectRequest to be built.

setApp(string $app): DirectRequestBuilder

• Sets the application package identifier for the DirectRequest to be built.

setDevice(string $device): DirectRequestBuilder

• Sets the device identifier for the DirectRequest to be built.

setAdditionalData(AdditionalData $additionalData): DirectRequestBuilder

• Sets the additional data for the DirectRequest to be built.

getSource(): ?string

• Returns the source you have set within the DirectRequest instance.

setSource(string $source): void

• Sets the source of the AnuraDirect client to the $source value passed.

getCampaign(): ?string

• Returns the campaign you have set within the DirectRequest instance.

setCampaign(string $campaign): void

• Sets the campaign of the AnuraDirect client to the $campaign value passed.

getIpAddress(): string

• Returns the IP address you have set within the DirectRequest instance.

setIpAddress(string $ipAddress): void

• Sets the IP address of the AnuraDirect client to the $ipAddress value passed.

getUserAgent(): ?string

• Returns the user agent you have set within the DirectRequest instance.

setUserAgent(string $userAgent): void

• Sets the user agent of the AnuraDirect client to the $userAgent value passed.

getApp(): ?string

• Returns the application package identifier you have set within the DirectRequest instance.

setApp(string $app): void

• Sets the application package identifier of the AnuraDirect client to the $app value passed.

getDevice(): ?string

• Returns the device identifier you have set within the DirectRequest instance.

setDevice(string $device): void

• Sets the device identifier of the AnuraDirect client to the $device value passed.

getAdditionalData(): AdditionalData

• Returns the additional data you have set within the DirectRequest instance.

setAdditionalData(AdditionalData $additionalData): void

• Sets the additional data of the AnuraDirect client to the $additionalData passed.

isSuspect(): bool

• Returns whether or not the visitor has been determined to be suspect.

isNonSuspect(): bool

• Returns whether or not the visitor has been determined to be non-suspect.

isMobile(): bool

• Returns whether or not the visitor has been determined to be on a mobile device.

getResult(): string

• Besides using our isSuspect() or isNonSuspect() methods, you are also able to access the result value.

getRuleSets(): ?array

• If you have return rule sets enabled, you will be able to see which specific rules were violated upon a suspect result. This value will be null if the visitor is non-suspect, or if you do not have return rule sets enabled.
• You can talk to support about enabling or disabling the return rule sets feature.

getInvalidTrafficType(): ?string

• If you have return invalid traffic type enabled, you will be able to see which type of invalid traffic occurred upon a suspect result.
• You can talk to support about enabling or disabling the return invalid traffic type feature.