Download the PHP package anura/anura-sdk-php without Composer
On this page you can find all versions of the php package anura/anura-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package anura-sdk-php
Anura SDK for PHP
The Anura SDK for PHP makes it easy for developers to access Anura Direct within their PHP code, and begin analyzing their traffic. You can get started in minutes by installing the SDK with Composer, or by downloading a single zip or phar file from our latest release.
Getting Started
- Have an open active account with Anura - You can see more about Anura's offerings here.
- Minimum Requirements - To use the SDK, you will need PHP >=7.4.
- If you're looking to install the SDK without Composer, see the Alternative Installation Methods section below.
-
Install the SDK - Using Composer is the easiest and recommended way to install it. The SDK is available on Packagist. If Composer is installed globally on your system, you can run the following command in the base directory of your project to add the SDK as a dependency:
- Using the SDK - The best way to start getting familiar with the SDK is to have a look at our Quick Examples section which covers the most common use-cases for it.
Alternative Installation Methods
Installing via PHAR
- Download the PHAR from our latest release, and place it within your project.
- Require or include the
anura-sdk-php.pharfile within your project. - You're good to go!
Installing via ZIP Archive
- Download
anura-sdk-php.zipfrom our latest release, extract it, and placeanura-sdk-php/within your project. - Require or include our autoloader at
anura-sdk-php/autoload.php - You're good to go!
Quick Examples
Create the Anura Direct client
Set additional data for Anura Direct
Updating elements of additional data
Removing an element of additional data
Create a DirectRequest object for AnuraDirect client
Get a result from Anura Direct
API Reference
AnuraDirect
Can get results from Anura Direct. These results are fetched using Direct's /direct.json API endpoint.
Methods
getResult(DirectRequest $request): DirectResult
- Gets a result from Anura Direct.
- Exceptions thrown:
AnuraClientException: If a 4XX response is returned from Anura Direct.AnuraServerException: If a 5XX response is returned from Anura Direct.AnuraException: Base exception for the Anura SDK. Used for any unexpected exceptions caused when using the Anura SDK. Can also be used as a general catch-all exception for simpler error handling.
getInstance(): string
- Returns the instance you have set within the
AnuraDirectclient.
setInstance(string $instance): void
- Sets the instance of the
AnuraDirectclient to the$instancevalue passed.
AdditionalData
A class representing Additional Data for Anura Direct.
addElement(int $key, string $value): void
- Adds an element of data to your additional data.
- If you call
addElement()multiple times with the same$key, the element at$keywill simply be updated with the new$value.
removeElement(int $key): void
- Removes the element of additional data located at
$key. - Nothing will occur if you do not have a value stored at
$key.
size(): int
- Returns the number of elements currently set within your additional data.
__toString(): string
- Returns your additional data as a JSON string.
DirectRequestBuilder
A builder class for creating a DirectRequest.
build(): DirectRequest
- Builds and returns the
DirectRequestas configured.
setSource(string $source): DirectRequestBuilder
- Sets the source for the
DirectRequestto be built.
setCampaign(string $campaign): DirectRequestBuilder
- Sets the campaign for the
DirectRequestto be built.
setIpAddress(string $ipAddress): DirectRequestBuilder
- Sets the IP address for the
DirectRequestto be built. Both IPv4 and IPv6 addresses are supported.
setUserAgent(string $userAgent): DirectRequestBuilder
- Sets the user agent for the
DirectRequestto be built.
setApp(string $app): DirectRequestBuilder
- Sets the application package identifier for the
DirectRequestto be built.
setDevice(string $device): DirectRequestBuilder
- Sets the device identifier for the
DirectRequestto be built.
setAdditionalData(AdditionalData $additionalData): DirectRequestBuilder
- Sets the additional data for the
DirectRequestto be built.
DirectRequest
An object that represents an Anura Direct API request.
getSource(): ?string
- Returns the source set within the
DirectRequestinstance.
setSource(string $source): void
- Sets the source of the
DirectRequestinstance to the$sourcevalue passed.
getCampaign(): ?string
- Returns the campaign set within the
DirectRequestinstance.
setCampaign(string $campaign): void
- Sets the campaign of the
DirectRequestinstance to the$campaignvalue passed.
getIpAddress(): string
- Returns the IP address set within the
DirectRequestinstance.
setIpAddress(string $ipAddress): void
- Sets the campaign of the
DirectRequestinstance to the$ipAddressvalue passed.
getUserAgent(): ?string
- Returns the user agent set within the
DirectRequestinstance.
setUserAgent(string $userAgent): void
- Sets the user agent of the
DirectRequestinstance to the$userAgentvalue passed.
getApp(): ?string
- Returns the application package identifier set within the
DirectRequestinstance.
setApp(string $app): void
- Sets the application package identifier of the
DirectRequestinstance to the$appvalue passed.
getDevice(): ?string
- Returns the device identifier set within the
DirectRequestinstance.
setDevice(string $device): void
- Sets the device identifier of the
DirectRequestinstance to the$devicevalue passed.
getAdditionalData(): ?AdditionalData
- Returns the additional data set within the
DirectRequestinstance.
setAdditionalData(AdditionalData $additionalData): void
- Sets the additional data of the
DirectRequestinstance to the$additionalDatapassed.
DirectResult
The result upon a successful call to getResult() from the AnuraDirect client. It contains not only the result from Anura Direct, but some other methods to help you use the result.
Methods
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()orisNonSuspect()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 access 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.