API Documentation
\
BotGuard

\BotGuardBotGuard

The class implements the BotGuard API 2.1.

Summary

Methods
Properties
Constants
instance()
check()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

instance()

instance(array  $params = null) : \BotGuard\BotGuard

Initializes the BotGuard class instance.

When calling first time, the parameters are required, next time they can be omitted.

Parameters

array $params

Associative array of configuration parameters: ["primary_server" => "xxx.botguard.net", "secondary_server" => "yyy.botguard.net"]. Check your BotGuard account to obtain actual servers addresses.

Returns

\BotGuard\BotGuard —

The BotGuard class instance.

check()

check() : \BotGuard\Profile

Makes the request to BotGuard Cloud API 2.1 to check the http request.

$_SERVER global variables should be defined.

Returns

\BotGuard\Profile —

The Profile class instance.