Docs For Class Services_ReCaptcha

$apiPrivateKey =

[line 67]

reCAPTCHA/reCAPTCHA Mailhide API private key.

Access: protected

Type:

string

[ Top ]

$apiPublicKey =

[line 60]

reCAPTCHA/reCAPTCHA Mailhide API public key.

Access: protected

Type:

string

[ Top ]

$apiURL =

[line 53]

reCAPTCHA/reCAPTCHA Mailhide API URL.

Access: public

Type:

string

[ Top ]

$options = array()

[line 74]

Array of options.

Access: protected

Type:

array

[ Top ]

__construct (Constructor) [line 89]

void __construct(
string
$pubKey, string
$privKey, [array
$options = array()])

Constructor, you must pass a valid public and private API key, and optionnaly an array of options.

Access: public

Overridden in child classes as:

Services_ReCaptcha::__construct(): Constructor, you must pass a valid public and private API key.

Services_ReCaptcha_MailHide::__construct(): Constructor, you must pass a valid public and private API key.

Parameters:

string	`$pubKey`	—	The public API key (mandatory)
string	`$privKey`	—	The private API key (mandatory)
array	`$options`	—	An array of options (optional)

[ Top ]

getHTML [line 125]

string getHTML(
)

Returns the corresponding HTML code.

Abstract:
Access: public

Overridden in child classes as:

Services_ReCaptcha::getHTML(): Returns the HTML code to insert into your form.

Services_ReCaptcha_MailHide::getHTML(): Returns the HTML code snippet that will hide your email.

[ Top ]

getOption [line 137]

mixed getOption(
string
$option)

Returns an option from Services_ReCaptcha::$options.

Return: The value of the option
Access: public

Parameters:

string $option — Name of option

[ Top ]

getOptions [line 172]

array getOptions(
)

Returns the Services_ReCaptcha::$options array.

Return: The options array
Access: public

[ Top ]

setOption [line 156]

Services_ReCaptcha_Base setOption(
string
$option, mixed
$value)

Sets an option in Services_ReCaptcha::$options and returns the current Services_ReCaptcha_Base instance.

Access: public

Parameters:

string	`$option`	—	Name of option
mixed	`$value`	—	Value of option

[ Top ]

setOptions [line 189]

Services_ReCaptcha_Base setOptions(
array
$options)

Sets a number of options at once in Services_ReCaptcha::$options and returns the current Services_ReCaptcha_Base instance.

See: Services_ReCaptcha::setOption()
Access: public

Parameters:

array $options — Associative array of options name/value

[ Top ]

__toString [line 108]

string __toString(
)

Returns the corresponding HTML code, this is a "magic" shortcut to the getHTML() method.

Return: The html code
See: Services_ReCaptcha_Base::getHTML()
Access: public

[ Top ]

Class: Services_ReCaptcha_Base

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$apiPrivateKey =

$apiPublicKey =

$apiURL =

$options = array()

Method Detail

__construct (Constructor) [line 89]

Parameters:

getHTML [line 125]

getOption [line 137]

Parameters:

getOptions [line 172]

setOption [line 156]

Parameters:

setOptions [line 189]

Parameters:

__toString [line 108]