Docs For Class Zend_Service_ReCaptcha

Zend_Service_ReCaptcha_Response

Description

Zend_Service_ReCaptcha_Response

version: $Id: Response.php 20096 2010-01-06 02:05:09Z bkarwin $
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Service/ReCaptcha/Response.php (line 32)

Variable Summary

string $_errorCode

boolean $_status

Method Summary

Zend_Service_ReCaptcha_Response __construct ([string $status = null], [string $errorCode = null], [ $httpResponse = null])

string getErrorCode ()

boolean getStatus ()

boolean isValid ()

Zend_Service_ReCaptcha_Response setErrorCode (string $errorCode)

Zend_Service_ReCaptcha_Response setFromHttpResponse ( $response)

Zend_Service_ReCaptcha_Response setStatus (string $status)

Variables

string $_errorCode = null (line 51)

Error code

The error code if the status is false. The different error codes can be found in the recaptcha API docs.

access: protected

boolean $_status = null (line 41)

Status

true if the response is valid or false otherwise

access: protected

Methods

Constructor __construct (line 60)

Class constructor used to construct a response

access: public

Zend_Service_ReCaptcha_Response __construct ([string $status = null], [string $errorCode = null], [ $httpResponse = null])

string $status
string $errorCode
Zend_Http_Response $httpResponse: If this is set the content will override $status and $errorCode

getErrorCode (line 130)

Get the error code

access: public

string getErrorCode ()

getStatus (line 97)

Get the status

access: public

boolean getStatus ()

isValid (line 107)

Alias for getStatus()

access: public

boolean isValid ()

setErrorCode (line 118)

Set the error code

access: public

Zend_Service_ReCaptcha_Response setErrorCode (string $errorCode)

string $errorCode

setFromHttpResponse (line 141)

Populate this instance based on a Zend_Http_Response object

access: public

Zend_Service_ReCaptcha_Response setFromHttpResponse ( $response)

Zend_Http_Response $response

setStatus (line 81)

Set the status

access: public

Zend_Service_ReCaptcha_Response setStatus (string $status)

string $status

Documentation generated on Mon, 21 Jun 2010 15:42:26 -0400 by phpDocumentor 1.4.3