phpDocumentor » \Captcha\Captcha

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the FreeBSD Project.

Proper library for reCaptcha service

author	Aleksey Korzun
`\Captcha\Exception`
package	library

Methods

Checks and validates user's response

check(string $captcha_challenge, string $captcha_response) : \Captcha\Response

Parameters

$captcha_challenge

string

Optional challenge string. If empty, value from $_POST will be used

$captcha_response

string

Optional response string. If empty, value from $_POST will be used

Exceptions

`\Captcha\Exception`

Returns

\Captcha\Response

Retrieve currently set error

getError() : string

Returns

string

Retrieve currently set private key

getPrivateKey() : string

Returns

string

Retrieve currently set public key

getPublicKey() : string

Returns

string

Generates reCaptcha form to output to your end user

html() : string

Exceptions

`\Captcha\Exception`

Returns

string

Set public key

setError(string $error) : \Captcha\reCaptcha

Parameters

$error

string

Returns

\Captcha\reCaptcha

Set private key

setPrivateKey(string $key) : \Captcha\reCaptcha

Parameters

$key

string

Returns

\Captcha\reCaptcha

Set public key

setPublicKey(string $key) : \Captcha\reCaptcha

Parameters

$key

string

Returns

\Captcha\reCaptcha

Construct encoded URI string from an array

encode(array $parameters) : string

Parameters

$parameters

array

Returns

string

Make a signed validation request to reCaptcha's servers

process(array $parameters) : string

Parameters

$parameters

array

Exceptions

`\Captcha\Exception`

Returns

string

Properties

$error : string

$privateKey : string

$publicKey : string

Constants

reCaptcha's API server

SERVER : string

reCaptcha's verify server

VERIFY_SERVER : string