Service/ReCaptcha/MailHide.php

Show:

inherited

Classes
- \Zend_Service_ReCaptcha_MailHide

Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: ReCaptcha

\Zend_Service_ReCaptcha_MailHide
jump to top

Package: Zend\Service\ReCaptcha

Zend_Service_ReCaptcha_MailHide

Parent(s): \Zend_Service_ReCaptcha < \Zend_Service_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id: MailHide.php 24593 2012-01-05 20:35:02Z matthew $

Constants

 
                ENCRYPTION_MODE
                = MCRYPT_MODE_CBC

 
                ENCRYPTION_CIPHER
                = MCRYPT_RIJNDAEL_128

 
                ENCRYPTION_BLOCK_SIZE
                = 16

 
                ENCRYPTION_IV
                = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"

string 
                MAILHIDE_SERVER
                = 'http://mailhide.recaptcha.net/d'

Url to the mailhide server

: string

string 
                API_SERVER
                = 'http://www.google.com/recaptcha/api'

inherited

URI to the regular API

Inherited from: \Zend_Service_ReCaptcha::API_SERVER

Inherited_from: \Zend_Service_ReCaptcha::API_SERVER
: string

string 
                API_SECURE_SERVER
                = 'https://www.google.com/recaptcha/api'

inherited

URI to the secure API

Inherited from: \Zend_Service_ReCaptcha::API_SECURE_SERVER

Inherited_from: \Zend_Service_ReCaptcha::API_SECURE_SERVER
: string

string 
                VERIFY_SERVER
                = 'http://www.google.com/recaptcha/api/verify'

inherited

URI to the verify server

Inherited from: \Zend_Service_ReCaptcha::VERIFY_SERVER

Inherited_from: \Zend_Service_ReCaptcha::VERIFY_SERVER
: string

Properties

string $_email = null

The email address to protect

Default valuenullDetails

Type: string

string $_emailDomainPart = null

The domain part of the email

Default valuenullDetails

Type: string

string $_emailLocalPart = null

The local part of the email

Default valuenullDetails

Type: string

\Zend_Validate_Interface $_emailValidator

Details

Type: \Zend_Validate_Interface

\Zend_Http_Client $_httpClient = null

staticinherited

HTTP Client used to query all web services

Inherited from: \Zend_Service_Abstract::$$_httpClient \Zend_Service_ReCaptcha::$$_httpClient

Default valuenullDetails

Type: \Zend_Http_Client
Inherited_from: \Zend_Service_Abstract::$$_httpClient
Inherited_from: \Zend_Service_ReCaptcha::$$_httpClient

string $_ip = null

inherited

Ip address used when verifying user input

Inherited from: \Zend_Service_ReCaptcha::$$_ip

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_ReCaptcha::$$_ip

array $_options = array('theme' => 'red', 'lang' => 'en')

inherited

Options for tailoring reCaptcha

Inherited from: \Zend_Service_ReCaptcha::$$_options

See the different options on http://recaptcha.net/apidocs/captcha/client.html

Default valuearray('theme' => 'red', 'lang' => 'en')Details

Type: array
Inherited_from: \Zend_Service_ReCaptcha::$$_options

array $_params = array('ssl' => false, 'error' => null, 'xhtml' => false)

inherited

Parameters for the object

Inherited from: \Zend_Service_ReCaptcha::$$_params

Default valuearray('ssl' => false, 'error' => null, 'xhtml' => false)Details

Type: array
Inherited_from: \Zend_Service_ReCaptcha::$$_params

string $_privateKey = null

inherited

Private key used when verifying user input

Inherited from: \Zend_Service_ReCaptcha::$$_privateKey

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_ReCaptcha::$$_privateKey

string $_privateKeyPacked = null

Binary representation of the private key

Default valuenullDetails

Type: string

string $_publicKey = null

inherited

Public key used when displaying the captcha

Inherited from: \Zend_Service_ReCaptcha::$$_publicKey

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_ReCaptcha::$$_publicKey

\Zend_Service_ReCaptcha_Response $_response = null

inherited

Response from the verify server

Inherited from: \Zend_Service_ReCaptcha::$$_response

Default valuenullDetails

Type: \Zend_Service_ReCaptcha_Response
Inherited_from: \Zend_Service_ReCaptcha::$$_response

Methods

__construct(string $publicKey = null, string $privateKey = null, string $email = null, array | \Zend_Config $options = null) : void

Local constructor

Parameters

Name	Type	Description
$publicKey	string
$privateKey	string
$email	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.

Returns

Type	Description
string

_getUrl() : string

Get the url used on the "hidden" part of the email address

Returns

Type	Description
string

_post(string $challengeField, string $responseField) : \Zend_Http_Response

inherited

Post a solution to the verify server

Inherited from: \Zend_Service_ReCaptcha::_post()

Parameters

Name	Type	Description
$challengeField	string
$responseField	string

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Service_ReCaptcha_Exception

_requireMcrypt() : void

See if the mcrypt extension is available

Throws

Exception	Description
\Zend_Service_ReCaptcha_MailHide_Exception

getDefaultOptions() : array

Get the default set of parameters

Returns

Type	Description
array

getEmail() : string

Get the email property

Returns

Type	Description
string

getEmailDomainPart() : string

Get the domain part of the email address

Returns

Type	Description
string

getEmailLocalPart() : string

Get the local part of the email address

Returns

Type	Description
string

getEmailValidator() : \Zend_Validate_Interface

Get emailValidator

Returns

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.

Parameters

Name	Type	Description
$email	string

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Service_ReCaptcha_MailHide_Exception

getHttpClient() : \Zend_Http_Client

staticfinalinherited

Gets the HTTP client object.

Inherited from: \Zend_Service_Abstract::getHttpClient()\Zend_Service_ReCaptcha::getHttpClient()

Returns

Type	Description
\Zend_Http_Client

getIp() : string

inherited

Get the ip property

Inherited from: \Zend_Service_ReCaptcha::getIp()

Returns

Type	Description
string

getOption(string $key) : mixed

inherited

Get a single option

Inherited from: \Zend_Service_ReCaptcha::getOption()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getOptions() : array

inherited

Get the options array

Inherited from: \Zend_Service_ReCaptcha::getOptions()

Returns

Type	Description
array

getParam(string $key) : mixed

inherited

Get a single parameter

Inherited from: \Zend_Service_ReCaptcha::getParam()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getParams() : array

inherited

Get the parameter array

Inherited from: \Zend_Service_ReCaptcha::getParams()

Returns

Type	Description
array

getPrivateKey() : string

inherited

Get the private key

Inherited from: \Zend_Service_ReCaptcha::getPrivateKey()

Returns

Type	Description
string

getPublicKey() : string

inherited

Get the public key

Inherited from: \Zend_Service_ReCaptcha::getPublicKey()

Returns

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

Parameters

Name	Type	Description
$email	string

Returns

Type	Description
\Zend_Service_ReCaptcha_MailHide

setEmailValidator(\Zend_Validate_Interface $validator) : \Zend_Service_ReCaptcha_MailHide

Set email validator

Parameters

Name	Type	Description
$validator	\Zend_Validate_Interface

Returns

Type	Description
\Zend_Service_ReCaptcha_MailHide

setHttpClient(\Zend_Http_Client $httpClient) : void

staticfinalinherited

Sets the HTTP client object to use for retrieving the feeds.

Inherited from: \Zend_Service_Abstract::setHttpClient()\Zend_Service_ReCaptcha::setHttpClient()

If none is set, the default Zend_Http_Client will be used.

Parameters

Name	Type	Description
$httpClient	\Zend_Http_Client

setIp(string $ip) : \Zend_Service_ReCaptcha

inherited

Set the ip property

Inherited from: \Zend_Service_ReCaptcha::setIp()

Parameters

Name	Type	Description
$ip	string

Returns

Type	Description
\Zend_Service_ReCaptcha

setOption(string $key, string $value) : \Zend_Service_ReCaptcha

inherited

Set a single option

Inherited from: \Zend_Service_ReCaptcha::setOption()

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
\Zend_Service_ReCaptcha

setOptions(array | \Zend_Config $options) : \Zend_Service_ReCaptcha

inherited

Set options

Inherited from: \Zend_Service_ReCaptcha::setOptions()

Parameters

Name	Type	Description
$options	array \| \Zend_Config

Returns

Type	Description
\Zend_Service_ReCaptcha

Throws

Exception	Description
\Zend_Service_ReCaptcha_Exception

setParam(string $key, string $value) : \Zend_Service_ReCaptcha

inherited

Set a single parameter

Inherited from: \Zend_Service_ReCaptcha::setParam()

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
\Zend_Service_ReCaptcha

setParams(array | \Zend_Config $params) : \Zend_Service_ReCaptcha

inherited

Set parameters

Inherited from: \Zend_Service_ReCaptcha::setParams()

Parameters

Name	Type	Description
$params	array \| \Zend_Config

Returns

Type	Description
\Zend_Service_ReCaptcha

Throws

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.

Parameters

Name	Type	Description
$privateKey	string

Returns

Type	Description
\Zend_Service_ReCaptcha_MailHide

setPublicKey(string $publicKey) : \Zend_Service_ReCaptcha

inherited

Set the public key

Inherited from: \Zend_Service_ReCaptcha::setPublicKey()

Parameters

Name	Type	Description
$publicKey	string

Returns

Type	Description
\Zend_Service_ReCaptcha

verify(string $challengeField, string $responseField) : \Zend_Service_ReCaptcha_Response

inherited

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.

Parameters

Name	Type	Description
$challengeField	string
$responseField	string

Returns

Type	Description
\Zend_Service_ReCaptcha_Response

Service/ReCaptcha/MailHide.php

\Zend_Service_ReCaptcha_MailHidejump to top

Constants

Properties

Methods

\Zend_Service_ReCaptcha_MailHide
jump to top