Service/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_Service
subpackage: ReCaptcha
Classes: Zend_Service_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_Service_ReCaptcha
jump to top

Extends from: Zend_Service_Abstract
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_Service
subpackage: ReCaptcha
version: $Id: ReCaptcha.php 20096 2010-01-06 02:05:09Z bkarwin $
Constants: API_SERVER; API_SECURE_SERVER; VERIFY_SERVER
Properties: $_publicKey; $_privateKey; $_ip; $_params; $_options; $_response
Methods: __construct; __toString; setIp; getIp; setParam; setParams; getParams; getParam; setOption; setOptions; getOptions; getOption; getPublicKey; setPublicKey; getPrivateKey; setPrivateKey; getHtml; _post; verify

Description

Zend_Service_ReCaptcha

Constants

API_SERVER
jump to class

string API_SERVER = 'http://api.recaptcha.net'

URI to the regular API

Details

value: http://api.recaptcha.net
API_SERVER: string

API_SECURE_SERVER
jump to class

string API_SECURE_SERVER = 'https://api-secure.recaptcha.net'

URI to the secure API

Details

value: https://api-secure.recaptcha.net
API_SECURE_SERVER: string

VERIFY_SERVER
jump to class

string VERIFY_SERVER = 'http://api-verify.recaptcha.net/verify'

URI to the verify server

Details

value: http://api-verify.recaptcha.net/verify
VERIFY_SERVER: string

Properties

$_ip
jump to class

string $_ip = 'null'

Ip address used when verifying user input

Details

$_ip: string
visibility: protected
default: null
final: false
static: false

$_options
jump to class

array $_options = 'array'

Options for tailoring reCaptcha

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

Details

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

$_params
jump to class

array $_params = 'array'

Parameters for the object

Details

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

$_privateKey
jump to class

string $_privateKey = 'null'

Private key used when verifying user input

Details

$_privateKey: string
visibility: protected
default: null
final: false
static: false

$_publicKey
jump to class

string $_publicKey = 'null'

Public key used when displaying the captcha

Details

$_publicKey: string
visibility: protected
default: null
final: false
static: false

$_response
jump to class

Zend_Service_ReCaptcha_Response $_response = 'null'

Response from the verify server

Details

$_response: Zend_Service_ReCaptcha_Response
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

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

Class constructor

Arguments

$publicKey: string
$privateKey: string
$params: arrayarrayZend_Config
$options: array
$ip: string

Details

visibility: public
final: false
static: false

__toString
jump to class

__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.

Output

string

Details

visibility: public
final: false
static: false

_post
jump to class

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

Post a solution to the verify server

Arguments

$challengeField: string
$responseField: string

Output

Zend_Http_Response

Details

visibility: protected
final: false
static: false
throws

getHtml
jump to class

getHtml(
          
          )
        
        :
        string

Get the HTML code for the captcha

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

Output

string

Details

visibility: public
final: false
static: false
throws

getIp
jump to class

getIp(
          
          )
        
        :
        string

Get the ip property

Output

string

Details

visibility: public
final: false
static: false

getOption
jump to class

getOption(
          string $key
          )
        
        :
        mixed

Get a single option

Arguments

$key: string

Output

mixed

Details

visibility: public
final: false
static: false

getOptions
jump to class

getOptions(
          
          )
        
        :
        array

Get the options array

Output

array

Details

visibility: public
final: false
static: false

getParam
jump to class

getParam(
          string $key
          )
        
        :
        mixed

Get a single parameter

Arguments

$key: string

Output

mixed

Details

visibility: public
final: false
static: false

getParams
jump to class

getParams(
          
          )
        
        :
        array

Get the parameter array

Output

array

Details

visibility: public
final: false
static: false

getPrivateKey
jump to class

getPrivateKey(
          
          )
        
        :
        string

Get the private key

Output

string

Details

visibility: public
final: false
static: false

getPublicKey
jump to class

getPublicKey(
          
          )
        
        :
        string

Get the public key

Output

string

Details

visibility: public
final: false
static: false

setIp
jump to class

setIp(
          string $ip
          )
        
        :
        Zend_Service_ReCaptcha

Set the ip property

Arguments

$ip: string

Output

Zend_Service_ReCaptcha

Details

visibility: public
final: false
static: false

setOption
jump to class

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

Set a single option

Arguments

$key: string
$value: string

Output

Zend_Service_ReCaptcha

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array|Zend_Config $options
          )
        
        :
        Zend_Service_ReCaptcha

Set options

Arguments

$options: arrayZend_Config

Output

Zend_Service_ReCaptcha

Details

visibility: public
final: false
static: false
throws

setParam
jump to class

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

Set a single parameter

Arguments

$key: string
$value: string

Output

Zend_Service_ReCaptcha

Details

visibility: public
final: false
static: false

setParams
jump to class

setParams(
          array|Zend_Config $params
          )
        
        :
        Zend_Service_ReCaptcha

Set parameters

Arguments

$params: arrayZend_Config

Output

Zend_Service_ReCaptcha

Details

visibility: public
final: false
static: false
throws

setPrivateKey
jump to class

setPrivateKey(
          string $privateKey
          )
        
        :
        Zend_Service_ReCaptcha

Set the private key

Arguments

$privateKey: string

Output

Zend_Service_ReCaptcha

Details

visibility: public
final: false
static: false

setPublicKey
jump to class

setPublicKey(
          string $publicKey
          )
        
        :
        Zend_Service_ReCaptcha

Set the public key

Arguments

$publicKey: string

Output

Zend_Service_ReCaptcha

Details

visibility: public
final: false
static: false

verify
jump to class

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.

Arguments

$challengeField: string
$responseField: string

Output

Zend_Service_ReCaptcha_Response

Details

visibility: public
final: false
static: false

API Documentation

Service/ReCaptcha.php

Description

Zend_Service_ReCaptchajump to top

Description

Constants

API_SERVERjump to class

Details

API_SECURE_SERVERjump to class

Details

VERIFY_SERVERjump to class

Details

Properties

$_ipjump to class

Details

$_optionsjump to class

Details

$_paramsjump to class

Details

$_privateKeyjump to class

Details

$_publicKeyjump to class

Details

$_responsejump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_postjump to class

Arguments

Output

Details

getHtmljump to class

Output

Details

getIpjump to class

Output

Details

getOptionjump to class

Arguments

Output

Details

getOptionsjump to class

Output

Details

getParamjump to class

Arguments

Output

Details

getParamsjump to class

Output

Details

getPrivateKeyjump to class

Output

Details

getPublicKeyjump to class

Output

Details

setIpjump to class

Arguments

Output

Details

setOptionjump to class

Arguments

Output

Details

setOptionsjump to class

Arguments

Output

Details

setParamjump to class

Arguments

Output

Details

setParamsjump to class

Arguments

Zend_Service_ReCaptcha
jump to top

API_SERVER
jump to class

API_SECURE_SERVER
jump to class

VERIFY_SERVER
jump to class

$_ip
jump to class

$_options
jump to class

$_params
jump to class

$_privateKey
jump to class

$_publicKey
jump to class

$_response
jump to class

__construct
jump to class

__toString
jump to class

_post
jump to class

getHtml
jump to class

getIp
jump to class

getOption
jump to class

getOptions
jump to class

getParam
jump to class

getParams
jump to class

getPrivateKey
jump to class

getPublicKey
jump to class

setIp
jump to class

setOption
jump to class

setOptions
jump to class

setParam
jump to class

setParams
jump to class

setPrivateKey
jump to class

setPublicKey
jump to class

verify
jump to class