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_MailHide

__construct(
string $publicKey
=
null, string $privateKey
=
null, string $email
=
null, array|\Zend_Config $options
=
null
)
:
void
Local constructor
Name | Type | Description |
---|---|---|
$publicKey | string | |
$privateKey | string | |
string | ||
$options | array|\Zend_Config |

__toString(
)
:
string
Serialize as string
When the instance is used as a string it will display the email address. Since we can't throw exceptions within this method we will trigger a user warning instead.
Type | Description |
---|---|
string |

_getUrl(
)
:
string
Get the url used on the "hidden" part of the email address
Type | Description |
---|---|
string |

_post(
string $challengeField, string $responseField
)
:
\Zend_Http_Response
Post a solution to the verify server
Inherited from: \Zend_Service_ReCaptcha::_post()Name | Type | Description |
---|---|---|
$challengeField | string | |
$responseField | string |
Type | Description |
---|---|
\Zend_Http_Response |
Exception | Description |
---|---|
\Zend_Service_ReCaptcha_Exception |

_requireMcrypt(
)
:
void
See if the mcrypt extension is available
Exception | Description |
---|---|
\Zend_Service_ReCaptcha_MailHide_Exception |

getEmailDomainPart(
)
:
string
Get the domain part of the email address
Type | Description |
---|---|
string |

getEmailLocalPart(
)
:
string
Get the local part of the email address
Type | Description |
---|---|
string |

getEmailValidator(
)
:
\Zend_Validate_Interface
Get emailValidator
Type | Description |
---|---|
\Zend_Validate_Interface |

getHtml(
string $email
=
null
)
:
string
Get the HTML code needed for the mail hide
This method uses the public key to fetch a recaptcha form.
Name | Type | Description |
---|---|---|
string |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Service_ReCaptcha_MailHide_Exception |

getIp(
)
:
string
Get the ip property
Inherited from: \Zend_Service_ReCaptcha::getIp()Type | Description |
---|---|
string |

getOption(
string $key
)
:
mixed
Get a single option
Inherited from: \Zend_Service_ReCaptcha::getOption()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

getOptions(
)
:
array
Get the options array
Inherited from: \Zend_Service_ReCaptcha::getOptions()Type | Description |
---|---|
array |

getParam(
string $key
)
:
mixed
Get a single parameter
Inherited from: \Zend_Service_ReCaptcha::getParam()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

getParams(
)
:
array
Get the parameter array
Inherited from: \Zend_Service_ReCaptcha::getParams()Type | Description |
---|---|
array |

getPrivateKey(
)
:
string
Get the private key
Inherited from: \Zend_Service_ReCaptcha::getPrivateKey()Type | Description |
---|---|
string |

getPublicKey(
)
:
string
Get the public key
Inherited from: \Zend_Service_ReCaptcha::getPublicKey()Type | Description |
---|---|
string |

setEmail(
string $email
)
:
\Zend_Service_ReCaptcha_MailHide
Set the email property
This method will set the email property along with the local and domain parts
Name | Type | Description |
---|---|---|
string |
Type | Description |
---|---|
\Zend_Service_ReCaptcha_MailHide |

setEmailValidator(
\Zend_Validate_Interface $validator
)
:
\Zend_Service_ReCaptcha_MailHide
Set email validator
Name | Type | Description |
---|---|---|
$validator | \Zend_Validate_Interface |
Type | Description |
---|---|
\Zend_Service_ReCaptcha_MailHide |

setHttpClient(
\Zend_Http_Client $httpClient
)
:
void
Sets the HTTP client object to use for retrieving the feeds. If none is set, the default Zend_Http_Client will be used.
Inherited from: \Zend_Service_Abstract::setHttpClient()Name | Type | Description |
---|---|---|
$httpClient | \Zend_Http_Client |

setIp(
string $ip
)
:
\Zend_Service_ReCaptcha
Set the ip property
Inherited from: \Zend_Service_ReCaptcha::setIp()
setOption(
string $key, string $value
)
:
\Zend_Service_ReCaptcha
Set a single option
Inherited from: \Zend_Service_ReCaptcha::setOption()Name | Type | Description |
---|---|---|
$key | string | |
$value | string |
Type | Description |
---|---|
\Zend_Service_ReCaptcha |

setOptions(
array|\Zend_Config $options
)
:
\Zend_Service_ReCaptcha
Set options
Inherited from: \Zend_Service_ReCaptcha::setOptions()Name | Type | Description |
---|---|---|
$options | array|\Zend_Config |
Type | Description |
---|---|
\Zend_Service_ReCaptcha |
Exception | Description |
---|---|
\Zend_Service_ReCaptcha_Exception |

setParam(
string $key, string $value
)
:
\Zend_Service_ReCaptcha
Set a single parameter
Inherited from: \Zend_Service_ReCaptcha::setParam()Name | Type | Description |
---|---|---|
$key | string | |
$value | string |
Type | Description |
---|---|
\Zend_Service_ReCaptcha |

setParams(
array|\Zend_Config $params
)
:
\Zend_Service_ReCaptcha
Set parameters
Inherited from: \Zend_Service_ReCaptcha::setParams()Name | Type | Description |
---|---|---|
$params | array|\Zend_Config |
Type | Description |
---|---|
\Zend_Service_ReCaptcha |
Exception | Description |
---|---|
\Zend_Service_ReCaptcha_Exception |

setPrivateKey(
string $privateKey
)
:
\Zend_Service_ReCaptcha_MailHide
Override the setPrivateKey method
Override the parent method to store a binary representation of the private key as well.
Name | Type | Description |
---|---|---|
$privateKey | string |
Type | Description |
---|---|
\Zend_Service_ReCaptcha_MailHide |

setPublicKey(
string $publicKey
)
:
\Zend_Service_ReCaptcha
Set the public key
Inherited from: \Zend_Service_ReCaptcha::setPublicKey()
verify(
string $challengeField, string $responseField
)
:
\Zend_Service_ReCaptcha_Response
Verify the user input
Inherited from: \Zend_Service_ReCaptcha::verify()This method calls up the post method and returns a Zend_Service_ReCaptcha_Response object.
Name | Type | Description |
---|---|---|
$challengeField | string | |
$responseField | string |
Type | Description |
---|---|
\Zend_Service_ReCaptcha_Response |