Captcha/ReCaptcha.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Captcha
subpackage: Adapter
Classes: Zend_Captcha_ReCaptcha

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Captcha_ReCaptcha
jump to top

Extends from: Zend_Captcha_Base
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Captcha
see: http://recaptcha.net/apidocs/captcha/
subpackage: Adapter
version: $Id: ReCaptcha.php 20096 2010-01-06 02:05:09Z bkarwin $
Constants: MISSING_VALUE; ERR_CAPTCHA; BAD_CAPTCHA
Properties: $_CHALLENGE; $_RESPONSE; $_service; $_serviceParams; $_serviceOptions; $_messageTemplates
Methods: getPrivkey; getPubkey; setPrivkey; setPubkey; __construct; setService; getService; setOption; generate; isValid; render

Description

ReCaptcha adapter

Allows to insert captchas driven by ReCaptcha service

Constants

MISSING_VALUE
jump to class

 MISSING_VALUE = 'missingValue'

Details

value: missingValue

ERR_CAPTCHA
jump to class

 ERR_CAPTCHA = 'errCaptcha'

Details

value: errCaptcha

BAD_CAPTCHA
jump to class

 BAD_CAPTCHA = 'badCaptcha'

Details

value: badCaptcha

Properties

$_CHALLENGE
jump to class

$_CHALLENGE = 'recaptcha_challenge_field'

Details

visibility: protected
default: recaptcha_challenge_field
final: false
static: false

$_RESPONSE
jump to class

$_RESPONSE = 'recaptcha_response_field'

Details

visibility: protected
default: recaptcha_response_field
final: false
static: false

$_messageTemplates
jump to class

array $_messageTemplates = 'array'

Error messages

Details

$_messageTemplates: array
visibility: protected
default: array
final: false
static: false

$_service
jump to class

Zend_Service_Recaptcha $_service = ''

Recaptcha service object

Details

$_service: Zend_Service_Recaptcha
visibility: protected
default
final: false
static: false

$_serviceOptions
jump to class

array $_serviceOptions = 'array'

Options defined by the service

Details

$_serviceOptions: array
visibility: protected
default: array
final: false
static: false

$_serviceParams
jump to class

array $_serviceParams = 'array'

Parameters defined by the service

Details

$_serviceParams: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          array|Zend_Config $options
              =
              null
          )
        
        :
        void

Constructor

Arguments

$options: arrayZend_Config

Details

visibility: public
final: false
static: false

generate
jump to class

generate(
          
          )
        
        :
        string

Generate captcha

Output

string

Details

visibility: public
final: false
static: false
see: Zend_Form_Captcha_Adapter::generate()

getPrivkey
jump to class

getPrivkey(
          
          )
        
        :
        string

Retrieve ReCaptcha Private key

Output

string

Details

visibility: public
final: false
static: false

getPubkey
jump to class

getPubkey(
          
          )
        
        :
        string

Retrieve ReCaptcha Public key

Output

string

Details

visibility: public
final: false
static: false

getService
jump to class

getService(
          
          )
        
        :
        Zend_Service_ReCaptcha

Retrieve ReCaptcha service object

Output

Zend_Service_ReCaptcha

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          mixed $value,  $context
              =
              null
          )
        
        :
        boolean

Validate captcha

Arguments

$value: mixed
$context

Output

boolean

Details

visibility: public
final: false
static: false
see: Zend_Validate_Interface::isValid()

render
jump to class

render(
          Zend_View_Interface $view
              =
              null, mixed $element
              =
              null
          )
        
        :
        string

Render captcha

Arguments

$view: Zend_View_Interface
$element: mixed

Output

string

Details

visibility: public
final: false
static: false

setOption
jump to class

setOption(
          string $key, mixed $value
          )
        
        :
        Zend_Captcha_ReCaptcha

Set option

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

Arguments

$key: string
$value: mixed

Output

Zend_Captcha_ReCaptcha

Details

visibility: public
final: false
static: false

setPrivkey
jump to class

setPrivkey(
          string $privkey
          )
        
        :
        Zend_Captcha_ReCaptcha

Set ReCaptcha Private key

Arguments

$privkey: string

Output

Zend_Captcha_ReCaptcha

Details

visibility: public
final: false
static: false

setPubkey
jump to class

setPubkey(
          string $pubkey
          )
        
        :
        Zend_Captcha_ReCaptcha

Set ReCaptcha public key

Arguments

$pubkey: string

Output

Zend_Captcha_ReCaptcha

Details

visibility: public
final: false
static: false

setService
jump to class

setService(
          Zend_Service_ReCaptcha $service
          )
        
        :
        Zend_Captcha_ReCaptcha

Set service object

Arguments

$service: Zend_Service_ReCaptcha

Output

Zend_Captcha_ReCaptcha

Details

visibility: public
final: false
static: false

API Documentation

Captcha/ReCaptcha.php

Description

Zend_Captcha_ReCaptchajump to top

Description

Constants

MISSING_VALUEjump to class

Details

ERR_CAPTCHAjump to class

Details

BAD_CAPTCHAjump to class

Details

Properties

$_CHALLENGEjump to class

Details

$_RESPONSEjump to class

Details

$_messageTemplatesjump to class

Details

$_servicejump to class

Details

$_serviceOptionsjump to class

Details

$_serviceParamsjump to class

Details

Methods

__constructjump to class

Arguments

Details

generatejump to class

Output

Details

getPrivkeyjump to class

Output

Details

getPubkeyjump to class

Output

Details

getServicejump to class

Output

Details

isValidjump to class

Arguments

Output

Details

renderjump to class

Arguments

Output

Details

setOptionjump to class

Arguments

Output

Details

setPrivkeyjump to class

Arguments

Output

Details

setPubkeyjump to class

Arguments

Output

Details

setServicejump to class

Arguments

Output

Details

Zend_Captcha_ReCaptcha
jump to top

MISSING_VALUE
jump to class

ERR_CAPTCHA
jump to class

BAD_CAPTCHA
jump to class

$_CHALLENGE
jump to class

$_RESPONSE
jump to class

$_messageTemplates
jump to class

$_service
jump to class

$_serviceOptions
jump to class

$_serviceParams
jump to class

__construct
jump to class

generate
jump to class

getPrivkey
jump to class

getPubkey
jump to class

getService
jump to class

isValid
jump to class

render
jump to class

setOption
jump to class

setPrivkey
jump to class

setPubkey
jump to class

setService
jump to class