Zend_Captcha_ReCaptcha Class Reference

Public Member Functions
	getPrivkey ()
	Retrieve ReCaptcha Private key.
	getPubkey ()
	Retrieve ReCaptcha Public key.
	setPrivkey ($privkey)
	Set ReCaptcha Private key.
	setPubkey ($pubkey)
	Set ReCaptcha public key.
	__construct ($options=null)
	Constructor.
	setService (Zend_Service_ReCaptcha $service)
	Set service object.
	getService ()
	Retrieve ReCaptcha service object.
	setOption ($key, $value)
	Set option.
	generate ()
	Generate captcha.
	isValid ($value, $context=null)
	Validate captcha.
	render (Zend_View_Interface $view=null, $element=null)
	Render captcha.
	getDecorator ()
	Get captcha decorator.
Public Member Functions inherited from Zend_Captcha_Base
	getName ()
	Get name.
	setName ($name)
	Set name.
	__construct ($options=null)
	Constructor.
	setOption ($key, $value)
	Set single option for the object.
	setOptions ($options=null)
	Set object state from options array.
	getOptions ()
	Retrieve options representing object state.
	setConfig (Zend_Config $config)
	Set object state from config object.
	getDecorator ()
	Get optional decorator.
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	Returns array of validation failure messages.
	getMessageVariables ()
	Returns an array of the names of variables that are used in constructing validation failure messages.
	getMessageTemplates ()
	Returns the message templates from the validator.
	setMessage ($messageString, $messageKey=null)
	Sets the validation failure message template for a particular key.
	setMessages (array $messages)
	Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.
	__get ($property)
	Magic function returns the value of the requested property, if and only if it is the value or a message variable.
	getErrors ()
	Returns array of validation failure message codes.
	setObscureValue ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	getObscureValue ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator ($translator=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setDisableTranslator ($flag)
	Indicate whether or not translation should be disabled.
	translatorIsDisabled ()
	Is translation disabled?
Public Member Functions inherited from Zend_Validate_Interface
	isValid ($value)
	Returns true if and only if $value meets the validation requirements.

Public Attributes
const	MISSING_VALUE = 'missingValue'
	#@+ Error codes
const	ERR_CAPTCHA = 'errCaptcha'
const	BAD_CAPTCHA = 'badCaptcha'

Protected Attributes
	$_CHALLENGE = 'recaptcha_challenge_field'
	$_RESPONSE = 'recaptcha_response_field'
	$_service
	$_serviceParams = array()
	$_serviceOptions = array()
	$_messageTemplates
Protected Attributes inherited from Zend_Captcha_Base
	$_name
	$_options = array()
	$_skipOptions
Protected Attributes inherited from Zend_Validate_Abstract
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)
	Set default translation object for all validate objects.
static	getDefaultTranslator ()
	Get default translation object for all validate objects.
static	hasDefaultTranslator ()
	Is there a default translation object set?
static	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	_error ($messageKey, $value=null)
	_setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Constructor & Destructor Documentation

__construct

(

$options = null

)

Constructor.

Parameters

array | Zend_Config

$options

Returns

void

Member Function Documentation

generate

(

)

Generate captcha.

See Also

Zend_Form_Captcha_Adapter::generate()

Returns

string

Implements Zend_Captcha_Adapter.

getDecorator

(

)

Get captcha decorator.

Returns

string

Implements Zend_Captcha_Adapter.

getPrivkey

(

)

Retrieve ReCaptcha Private key.

Returns

string

getPubkey

(

)

Retrieve ReCaptcha Public key.

Returns

string

getService

(

)

Retrieve ReCaptcha service object.

Returns

Zend_Service_ReCaptcha

isValid	(		$value,
			$context = null
	)

Validate captcha.

See Also

Zend_Validate_Interface::isValid()

Parameters

mixed

$value

Returns

boolean

render	(	Zend_View_Interface	$view = null,
			$element = null
	)

Render captcha.

Parameters

Zend_View_Interface	$view
mixed	$element

Returns

string

Implements Zend_Captcha_Adapter.

setOption	(		$key,
			$value
	)

Set option.

If option is a service parameter, proxies to the service. The same goes for any service options (distinct from service params)

Parameters

string	$key
mixed	$value

Returns

Zend_Captcha_ReCaptcha

setPrivkey

(

$privkey

)

Set ReCaptcha Private key.

Parameters

string

$privkey

Returns

Zend_Captcha_ReCaptcha

setPubkey

(

$pubkey

)

Set ReCaptcha public key.

Parameters

string

$pubkey

Returns

Zend_Captcha_ReCaptcha

setService

(

Zend_Service_ReCaptcha

$service

)

Set service object.

Parameters

Zend_Service_ReCaptcha

$service

Returns

Zend_Captcha_ReCaptcha

Member Data Documentation

$_CHALLENGE = 'recaptcha_challenge_field'

protected

$_messageTemplates

protected

Initial value:

= array(
        self::MISSING_VALUE => 'Missing captcha fields',
        self::ERR_CAPTCHA   => 'Failed to validate captcha',
        self::BAD_CAPTCHA   => 'Captcha value is wrong: %value%',
    )

$_RESPONSE = 'recaptcha_response_field'

protected

$_service

protected

$_serviceOptions = array()

protected

$_serviceParams = array()

protected

const BAD_CAPTCHA = 'badCaptcha'

const ERR_CAPTCHA = 'errCaptcha'

const MISSING_VALUE = 'missingValue'

#@+ Error codes