[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Service/ -> ReCaptcha.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
File Size: 506 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Service_ReCaptcha:: (19 methods):
  __construct()
  __toString()
  setIp()
  getIp()
  setParam()
  setParams()
  getParams()
  getParam()
  setOption()
  setOptions()
  getOptions()
  getOption()
  getPublicKey()
  setPublicKey()
  getPrivateKey()
  setPrivateKey()
  getHtml()
  _post()
  verify()


Class: Zend_Service_ReCaptcha  - X-Ref

Zend_Service_ReCaptcha

__construct($publicKey = null, $privateKey = null,$params = null, $options = null, $ip = null)   X-Ref
Class constructor

param: string $publicKey
param: string $privateKey
param: array $params
param: array $options
param: string $ip
param: array|Zend_Config $params

__toString()   X-Ref
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.

return: string

setIp($ip)   X-Ref
Set the ip property

param: string $ip
return: Zend_Service_ReCaptcha

getIp()   X-Ref
Get the ip property

return: string

setParam($key, $value)   X-Ref
Set a single parameter

param: string $key
param: string $value
return: Zend_Service_ReCaptcha

setParams($params)   X-Ref
Set parameters

param: array|Zend_Config $params
return: Zend_Service_ReCaptcha

getParams()   X-Ref
Get the parameter array

return: array

getParam($key)   X-Ref
Get a single parameter

param: string $key
return: mixed

setOption($key, $value)   X-Ref
Set a single option

param: string $key
param: string $value
return: Zend_Service_ReCaptcha

setOptions($options)   X-Ref
Set options

param: array|Zend_Config $options
return: Zend_Service_ReCaptcha

getOptions()   X-Ref
Get the options array

return: array

getOption($key)   X-Ref
Get a single option

param: string $key
return: mixed

getPublicKey()   X-Ref
Get the public key

return: string

setPublicKey($publicKey)   X-Ref
Set the public key

param: string $publicKey
return: Zend_Service_ReCaptcha

getPrivateKey()   X-Ref
Get the private key

return: string

setPrivateKey($privateKey)   X-Ref
Set the private key

param: string $privateKey
return: Zend_Service_ReCaptcha

getHtml()   X-Ref
Get the HTML code for the captcha

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

return: string

_post($challengeField, $responseField)   X-Ref
Post a solution to the verify server

param: string $challengeField
param: string $responseField
return: Zend_Http_Response

verify($challengeField, $responseField)   X-Ref
Verify the user input

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

param: string $challengeField
param: string $responseField
return: Zend_Service_ReCaptcha_Response



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1