Captcha/ReCaptcha.php

Show:

inherited

Classes
- \Zend_Captcha_ReCaptcha

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Captcha
Subpackage: Adapter

\Zend_Captcha_ReCaptcha
jump to top

Package: Zend_Captcha\Adapter

ReCaptcha adapter

Allows to insert captchas driven by ReCaptcha service

Parent(s): \Zend_Captcha_Base < \Zend_Validate_Abstract
See
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id$

Constants

 
                MISSING_VALUE
                = 'missingValue'

 
                ERR_CAPTCHA
                = 'errCaptcha'

 
                BAD_CAPTCHA
                = 'badCaptcha'

Properties

$_CHALLENGE = 'recaptcha_challenge_field'

Default value'recaptcha_challenge_field'Details

Type: n/a

$_RESPONSE = 'recaptcha_response_field'

Default value'recaptcha_response_field'Details

Type: n/a

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

Error messages

Default value

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

Details

Type: array

\Zend_Service_Recaptcha $_service

Recaptcha service object

Details

Type: \Zend_Service_Recaptcha

array $_serviceOptions = array()

Options defined by the service

Default valuearray()Details

Type: array

array $_serviceParams = array()

Parameters defined by the service

Default valuearray()Details

Type: array

Methods

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

Constructor

Parameters

Name	Type	Description
$options	array \| \Zend_Config

generate() : string

Generate captcha

Returns

Type	Description
string

Details

See

getDecorator() : string

Get captcha decorator

Returns

Type	Description
string

getPrivkey() : string

Retrieve ReCaptcha Private key

Returns

Type	Description
string

getPubkey() : string

Retrieve ReCaptcha Public key

Returns

Type	Description
string

getService() : \Zend_Service_ReCaptcha

Retrieve ReCaptcha service object

Returns

Type	Description
\Zend_Service_ReCaptcha

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

Validate captcha

Parameters

Name	Type	Description
$value	mixed
$context

Returns

Type	Description
boolean

Details

See

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

Render captcha

Parameters

Name	Type	Description
$view	\Zend_View_Interface
$element	mixed

Returns

Type	Description
string

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)

Parameters

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\Zend_Captcha_ReCaptcha

setPrivkey(string $privkey) : \Zend_Captcha_ReCaptcha

Set ReCaptcha Private key

Parameters

Name	Type	Description
$privkey	string

Returns

Type	Description
\Zend_Captcha_ReCaptcha

setPubkey(string $pubkey) : \Zend_Captcha_ReCaptcha

Set ReCaptcha public key

Parameters

Name	Type	Description
$pubkey	string

Returns

Type	Description
\Zend_Captcha_ReCaptcha

setService(\Zend_Service_ReCaptcha $service) : \Zend_Captcha_ReCaptcha

Set service object

Parameters

Name	Type	Description
$service	\Zend_Service_ReCaptcha

Returns

Type	Description
\Zend_Captcha_ReCaptcha

Captcha/ReCaptcha.php

\Zend_Captcha_ReCaptchajump to top

Constants

Properties

Methods

\Zend_Captcha_ReCaptcha
jump to top