Service/ReCaptcha.php

Show:

inherited

Classes
- \Zend_Service_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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: ReCaptcha

\Zend_Service_ReCaptcha
jump to top

Package: Zend\Service\ReCaptcha

Zend_Service_ReCaptcha

Parent(s): \Zend_Service_Abstract
Children: \Zend_Service_ReCaptcha_MailHide
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id: ReCaptcha.php 25153 2012-11-28 11:56:23Z cogo $

Constants

string 
                API_SERVER
                = 'http://www.google.com/recaptcha/api'

URI to the regular API

: string

string 
                API_SECURE_SERVER
                = 'https://www.google.com/recaptcha/api'

URI to the secure API

: string

string 
                VERIFY_SERVER
                = 'http://www.google.com/recaptcha/api/verify'

URI to the verify server

: string

Properties

\Zend_Http_Client $_httpClient = null

staticinherited

HTTP Client used to query all web services

Inherited from: \Zend_Service_Abstract::$$_httpClient

Default valuenullDetails

Type: \Zend_Http_Client
Inherited_from: \Zend_Service_Abstract::$$_httpClient

string $_ip = null

Ip address used when verifying user input

Default valuenullDetails

Type: string

array $_options = array('theme' => 'red', 'lang' => 'en')

Options for tailoring reCaptcha

See the different options on http://recaptcha.net/apidocs/captcha/client.html

Default valuearray('theme' => 'red', 'lang' => 'en')Details

Type: array

array $_params = array('ssl' => false, 'error' => null, 'xhtml' => false)

Parameters for the object

Default valuearray('ssl' => false, 'error' => null, 'xhtml' => false)Details

Type: array

string $_privateKey = null

Private key used when verifying user input

Default valuenullDetails

Type: string

string $_publicKey = null

Public key used when displaying the captcha

Default valuenullDetails

Type: string

\Zend_Service_ReCaptcha_Response $_response = null

Response from the verify server

Default valuenullDetails

Type: \Zend_Service_ReCaptcha_Response

Methods

__construct(string $publicKey = null, string $privateKey = null, array | array | \Zend_Config $params = null, array $options = null, string $ip = null) : void

Class constructor

Parameters

Name	Type	Description
$publicKey	string
$privateKey	string
$params	array \| array \| \Zend_Config
$options	array
$ip	string

__toString() : string

Serialize as string

When the instance is used as a string it will display the recaptcha. Since we can't throw exceptions within this method we will trigger a user warning instead.

Returns

Type	Description
string

_post(string $challengeField, string $responseField) : \Zend_Http_Response

Post a solution to the verify server

Parameters

Name	Type	Description
$challengeField	string
$responseField	string

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Service_ReCaptcha_Exception

getHtml(null | string $name = null) : string

Get the HTML code for the captcha

This method uses the public key to fetch a recaptcha form.

Parameters

Name	Type	Description
$name	null \| string	Base name for recaptcha form elements

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Service_ReCaptcha_Exception

getHttpClient() : \Zend_Http_Client

staticfinalinherited

Gets the HTTP client object.

Inherited from: \Zend_Service_Abstract::getHttpClient()

Returns

Type	Description
\Zend_Http_Client

getIp() : string

Get the ip property

Returns

Type	Description
string

getOption(string $key) : mixed

Get a single option

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getOptions() : array

Get the options array

Returns

Type	Description
array

getParam(string $key) : mixed

Get a single parameter

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getParams() : array

Get the parameter array

Returns

Type	Description
array

getPrivateKey() : string

Get the private key

Returns

Type	Description
string

getPublicKey() : string

Get the public key

Returns

Type	Description
string

setHttpClient(\Zend_Http_Client $httpClient) : void

staticfinalinherited

Sets the HTTP client object to use for retrieving the feeds.

Inherited from: \Zend_Service_Abstract::setHttpClient()

If none is set, the default Zend_Http_Client will be used.

Parameters

Name	Type	Description
$httpClient	\Zend_Http_Client

setIp(string $ip) : \Zend_Service_ReCaptcha

Set the ip property

Parameters

Name	Type	Description
$ip	string

Returns

Type	Description
\Zend_Service_ReCaptcha

setOption(string $key, string $value) : \Zend_Service_ReCaptcha

Set a single option

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
\Zend_Service_ReCaptcha

setOptions(array | \Zend_Config $options) : \Zend_Service_ReCaptcha

Set options

Parameters

Name	Type	Description
$options	array \| \Zend_Config

Returns

Type	Description
\Zend_Service_ReCaptcha

Throws

Exception	Description
\Zend_Service_ReCaptcha_Exception

setParam(string $key, string $value) : \Zend_Service_ReCaptcha

Set a single parameter

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
\Zend_Service_ReCaptcha

setParams(array | \Zend_Config $params) : \Zend_Service_ReCaptcha

Set parameters

Parameters

Name	Type	Description
$params	array \| \Zend_Config

Returns

Type	Description
\Zend_Service_ReCaptcha

Throws

Exception	Description
\Zend_Service_ReCaptcha_Exception

setPrivateKey(string $privateKey) : \Zend_Service_ReCaptcha

Set the private key

Parameters

Name	Type	Description
$privateKey	string

Returns

Type	Description
\Zend_Service_ReCaptcha

setPublicKey(string $publicKey) : \Zend_Service_ReCaptcha

Set the public key

Parameters

Name	Type	Description
$publicKey	string

Returns

Type	Description
\Zend_Service_ReCaptcha

verify(string $challengeField, string $responseField) : \Zend_Service_ReCaptcha_Response

Verify the user input

This method calls up the post method and returns a Zend_Service_ReCaptcha_Response object.

Parameters

Name	Type	Description
$challengeField	string
$responseField	string

Returns

Type	Description
\Zend_Service_ReCaptcha_Response

Service/ReCaptcha.php

\Zend_Service_ReCaptchajump to top

Constants

Properties

Methods

\Zend_Service_ReCaptcha
jump to top