API Documentation
Back to top  

Captcha

Copyright (c) 2015, Aleksey Korzun <aleksey@webfoundation.net> All rights reserved.

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

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. 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 aleksey@webfoundation.net
see
throws
package

library

Methods

Set public key

setPublicKey(string $key) : \Captcha\reCaptcha

Arguments

$key

string

Response

\Captcha\reCaptcha

Retrieve currently set public key

getPublicKey() : string

Response

string

Set private key

setPrivateKey(string $key) : \Captcha\reCaptcha

Arguments

$key

string

Response

\Captcha\reCaptcha

Retrieve currently set private key

getPrivateKey() : string

Response

string

Set remote IP

setRemoteIp(string $ip) : \Captcha\reCaptcha

Arguments

$ip

string

Response

\Captcha\reCaptcha

Get remote IP

getRemoteIp() : string

Response

string

Set error string

setError(string $error) : \Captcha\reCaptcha

Arguments

$error

string

Response

\Captcha\reCaptcha

Retrieve currently set error

getError() : string

Response

string

Generates reCaptcha form to output to your end user

html() : string
throws

Response

string

Checks and validates user's response

check(bool|string $captchaResponse = false) : \Captcha\Response
throws

Arguments

$captchaResponse

bool|string

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

Response

\Captcha\Response

Make a signed validation request to reCaptcha's servers

process(array $parameters) : string
throws

Arguments

$parameters

array

Response

string

Returns a boolean indicating if a theme name is valid

isValidTheme(string $theme) : bool
static

Arguments

$theme

string

Response

bool

Returns a boolean indicating if a widget size is valid

isValidSize(string $size) : bool
static

Arguments

$size

string

Response

bool

Returns a boolean indicating if a widget type is valid

isValidType(string $type) : bool
static

Arguments

$type

string

Response

bool

Set widget theme

setTheme(string $theme) : \Captcha\Captcha
throws
see

Arguments

$theme

string

Response

\Captcha\Captcha

Set widget size

setSize(string $size) : \Captcha\Captcha
throws
see

Arguments

$size

string

Response

\Captcha\Captcha

Set widget type

setType(string $type) : \Captcha\Captcha
throws
see

Arguments

$type

string

Response

\Captcha\Captcha

Set widgets tab index

setTabIndex(int $tabIndex) : \Captcha\Captcha
throws
see

Arguments

$tabIndex

int

Response

\Captcha\Captcha

Constants

reCaptcha's API server

SERVER
var

reCaptcha's verify server

VERIFY_SERVER
var

Properties

The Remote IP Address

remoteIp
var

Private key

privateKey
var

Public key

publicKey
var

Custom error message to return

error
var

The theme we use. The default theme is light, but you can change it using setTheme()

theme
var
see

Type of widget to display. The default type is image.

type
var
see

Size of widget to display. The default type is normal.

size
var
see

Optional tab index for input elements within the widget.

tabIndex
var
see

An array of supported themes.

themes
static
var
see

An array of supported data types.

types
static
var
see

An array of supported data sizes.

sizes
static
var
see