API Documentation

Service/ReCaptcha/Response.php

Classes 
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_Response

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_Response
jump to top

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: Response.php 20096 2010-01-06 02:05:09Z bkarwin $
Properties
$_status
$_errorCode
Methods
__construct
setStatus
getStatus
isValid
setErrorCode
getErrorCode
setFromHttpResponse

Description

Zend_Service_ReCaptcha_Response

Properties

$_errorCode
jump to class

string $_errorCode = 'null'

Error code

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

Details

$_errorCode
string
visibility
protected
default
null
final
false
static
false

$_status
jump to class

boolean $_status = 'null'

Status

true if the response is valid or false otherwise

Details

$_status
boolean
visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( string $status = null, string $errorCode = null, Zend_Http_Response $httpResponse = null ) :

Class constructor used to construct a response

Arguments
$status
string
$errorCode
string
$httpResponse
Zend_Http_Response
If this is set the content will override $status and $errorCode
Details
visibility
public
final
false
static
false

getErrorCode
jump to class

getErrorCode( ) : string

Get the error code

Output
string
Details
visibility
public
final
false
static
false

getStatus
jump to class

getStatus( ) : boolean

Get the status

Output
boolean
Details
visibility
public
final
false
static
false

isValid
jump to class

isValid( ) : boolean

Alias for getStatus()

Output
boolean
Details
visibility
public
final
false
static
false

setErrorCode
jump to class

setErrorCode( string $errorCode ) : Zend_Service_ReCaptcha_Response

Set the error code

Arguments
$errorCode
string
Output
Zend_Service_ReCaptcha_Response
Details
visibility
public
final
false
static
false

setFromHttpResponse
jump to class

setFromHttpResponse( Zend_Http_Response $response ) : Zend_Service_ReCaptcha_Response

Populate this instance based on a Zend_Http_Response object

Arguments
$response
Zend_Http_Response
Output
Zend_Service_ReCaptcha_Response
Details
visibility
public
final
false
static
false

setStatus
jump to class

setStatus( string $status ) : Zend_Service_ReCaptcha_Response

Set the status

Arguments
$status
string
Output
Zend_Service_ReCaptcha_Response
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.