Service/ReCaptcha/Response.php
Show:
inherited
inherited
Classes
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Service
- Subpackage
- ReCaptcha
\Zend_Service_ReCaptcha_Response
Package: Zend_Service\ReCaptcha
Zend_Service_ReCaptcha_Response
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id$
Properties
string $_errorCode = nullError code
The error code if the status is false. The different error codes can be found in the
recaptcha API docs.
Default valuenullDetails- Type
- string
boolean $_status = nullStatus
true if the response is valid or false otherwise
Default valuenullDetails- Type
- boolean
Methods
__construct(string $status = null, string $errorCode = null, \Zend_Http_Response $httpResponse = null) : voidClass constructor used to construct a response
Parameters
| Name | Type | Description |
|---|---|---|
| $status | string | |
| $errorCode | string | |
| $httpResponse | \Zend_Http_Response | If this is set the content will override $status and $errorCode |
getErrorCode() : stringGet the error code
Returns
| Type | Description |
|---|---|
| string |
getStatus() : booleanGet the status
Returns
| Type | Description |
|---|---|
| boolean |
isValid() : booleanAlias for getStatus()
Returns
| Type | Description |
|---|---|
| boolean |
setErrorCode(string $errorCode) : \Zend_Service_ReCaptcha_ResponseSet the error code
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $errorCode | string |
| Type | Description |
|---|---|
| \Zend_Service_ReCaptcha_Response |
setFromHttpResponse(\Zend_Http_Response $response) : \Zend_Service_ReCaptcha_ResponsePopulate this instance based on a Zend_Http_Response object
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $response | \Zend_Http_Response |
| Type | Description |
|---|---|
| \Zend_Service_ReCaptcha_Response |
setStatus(string $status) : \Zend_Service_ReCaptcha_ResponseSet the status
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $status | string |
| Type | Description |
|---|---|
| \Zend_Service_ReCaptcha_Response |