Class Zend_Captcha_ReCaptcha

Description

ReCaptcha adapter

Allows to insert captchas driven by ReCaptcha service

Located in /Captcha/ReCaptcha.php (line 42)

Zend_Validate_Abstract
   |
   --Zend_Captcha_Base
      |
      --Zend_Captcha_ReCaptcha
Class Constant Summary
 BAD_CAPTCHA = 'badCaptcha'
 ERR_CAPTCHA = 'errCaptcha'
 MISSING_VALUE = 'missingValue'
Variable Summary
 string $_CHALLENGE
 mixed $_RESPONSE
 Zend_Service_Recaptcha $_service
Method Summary
 void __construct ([array|Zend_Config $options = null])
 string generate ()
 string getPrivkey ()
 string getPubkey ()
 boolean isValid (mixed $value, [ $context = null])
 string render ([ $view = null], [mixed $element = null])
 Zend_Captcha_ReCaptcha setOption (string $key, mixed $value)
 Zend_Captcha_ReCaptcha setPrivkey (string $privkey)
 Zend_Captcha_ReCaptcha setPubkey (string $pubkey)
Variables
string $_CHALLENGE = 'recaptcha_challenge_field' (line 48)
  • access: protected
array $_messageTemplates = array(
self::MISSING_VALUE => 'Missing captcha fields',
self::ERR_CAPTCHA => 'Failed to validate captcha',
self::BAD_CAPTCHA => 'Captcha value is wrong: %value%',
)
(line 85)

Error messages

  • access: protected

Redefinition of:
Zend_Validate_Abstract::$_messageTemplates
Validation failure message template definitions
mixed $_RESPONSE = 'recaptcha_response_field' (line 49)
  • access: protected
Zend_Service_Recaptcha $_service (line 57)

Recaptcha service object

  • access: protected
array $_serviceOptions = array() (line 71)

Options defined by the service

  • access: protected
array $_serviceParams = array() (line 64)

Parameters defined by the service

  • access: protected

Inherited Variables

Inherited from Zend_Captcha_Base

Zend_Captcha_Base::$_name
Zend_Captcha_Base::$_options
Zend_Captcha_Base::$_skipOptions

Inherited from Zend_Validate_Abstract

Zend_Validate_Abstract::$_defaultTranslator
Zend_Validate_Abstract::$_errors
Zend_Validate_Abstract::$_messageLength
Zend_Validate_Abstract::$_messages
Zend_Validate_Abstract::$_messageVariables
Zend_Validate_Abstract::$_obscureValue
Zend_Validate_Abstract::$_translator
Zend_Validate_Abstract::$_translatorDisabled
Zend_Validate_Abstract::$_value
Methods
Constructor __construct (line 141)

Constructor

  • access: public
void __construct ([array|Zend_Config $options = null])

Redefinition of:
Zend_Captcha_Base::__construct()
Constructor
generate (line 209)

Generate captcha

  • see: Zend_Form_Captcha_Adapter::generate()
  • access: public
string generate ()
getPrivkey (line 96)

Retrieve ReCaptcha Private key

  • access: public
string getPrivkey ()
getPubkey (line 106)

Retrieve ReCaptcha Public key

  • access: public
string getPubkey ()
getService (line 174)

Retrieve ReCaptcha service object

  • access: public
Zend_Service_ReCaptcha getService ()
isValid (line 221)

Validate captcha

boolean isValid (mixed $value, [ $context = null])
  • mixed $value
  • $context
render (line 262)

Render captcha

  • access: public
string render ([ $view = null], [mixed $element = null])
setOption (line 189)

Set option

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

  • access: public
Zend_Captcha_ReCaptcha setOption (string $key, mixed $value)
  • string $key
  • mixed $value

Redefinition of:
Zend_Captcha_Base::setOption()
Set single option for the object
setPrivkey (line 117)

Set ReCaptcha Private key

  • access: public
Zend_Captcha_ReCaptcha setPrivkey (string $privkey)
  • string $privkey
setPubkey (line 129)

Set ReCaptcha public key

  • access: public
Zend_Captcha_ReCaptcha setPubkey (string $pubkey)
  • string $pubkey
setService (line 163)

Set service object

  • access: public
Zend_Captcha_ReCaptcha setService ( $service)

Inherited Methods

Inherited From Zend_Captcha_Base

 Zend_Captcha_Base::__construct()
 Zend_Captcha_Base::getDecorator()
 Zend_Captcha_Base::getName()
 Zend_Captcha_Base::getOptions()
 Zend_Captcha_Base::setConfig()
 Zend_Captcha_Base::setName()
 Zend_Captcha_Base::setOption()
 Zend_Captcha_Base::setOptions()

Inherited From Zend_Validate_Abstract

 Zend_Validate_Abstract::getDefaultTranslator()
 Zend_Validate_Abstract::getErrors()
 Zend_Validate_Abstract::getMessageLength()
 Zend_Validate_Abstract::getMessages()
 Zend_Validate_Abstract::getMessageTemplates()
 Zend_Validate_Abstract::getMessageVariables()
 Zend_Validate_Abstract::getObscureValue()
 Zend_Validate_Abstract::getTranslator()
 Zend_Validate_Abstract::hasDefaultTranslator()
 Zend_Validate_Abstract::hasTranslator()
 Zend_Validate_Abstract::setDefaultTranslator()
 Zend_Validate_Abstract::setDisableTranslator()
 Zend_Validate_Abstract::setMessage()
 Zend_Validate_Abstract::setMessageLength()
 Zend_Validate_Abstract::setMessages()
 Zend_Validate_Abstract::setObscureValue()
 Zend_Validate_Abstract::setTranslator()
 Zend_Validate_Abstract::translatorIsDisabled()
 Zend_Validate_Abstract::_createMessage()
 Zend_Validate_Abstract::_error()
 Zend_Validate_Abstract::_setValue()
 Zend_Validate_Abstract::__get()
Class Constants
BAD_CAPTCHA = 'badCaptcha' (line 78)

Error codes

ERR_CAPTCHA = 'errCaptcha' (line 77)

Error codes

MISSING_VALUE = 'missingValue' (line 76)

Error codes

Documentation generated on Mon, 21 Jun 2010 15:41:23 -0400 by phpDocumentor 1.4.3