Class Zend_Service_ReCaptcha_MailHide

Description

Zend_Service_ReCaptcha_MailHide

  • version: $Id: MailHide.php 20108 2010-01-06 22:05:31Z matthew $
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Service/ReCaptcha/MailHide.php (line 35)

Zend_Service_Abstract
   |
   --Zend_Service_ReCaptcha
      |
      --Zend_Service_ReCaptcha_MailHide
Class Constant Summary
 ENCRYPTION_CIPHER = MCRYPT_RIJNDAEL_128
 ENCRYPTION_IV = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
 ENCRYPTION_MODE = MCRYPT_MODE_CBC
 MAILHIDE_SERVER = 'http://mailhide.recaptcha.net/d'
Variable Summary
Method Summary
 Zend_Service_ReCaptcha_MailHide __construct ([string $publicKey = null], [string $privateKey = null], [string $email = null], [array|Zend_Config $options = null])
 string getEmail ()
 string getEmailDomainPart ()
 string getEmailLocalPart ()
 string getHtml ([string $email = null])
 string _getUrl ()
 void _requireMcrypt ()
 string __toString ()
Variables
string $_email = null (line 58)

The email address to protect

  • access: protected
string $_emailDomainPart = null (line 84)

The domain part of the email

  • access: protected
string $_emailLocalPart = null (line 77)

The local part of the email

  • access: protected
Zend_Validate_Interface $_emailValidator (line 63)
  • access: protected
string $_privateKeyPacked = null (line 70)

Binary representation of the private key

  • access: protected

Inherited Variables

Inherited from Zend_Service_ReCaptcha

Zend_Service_ReCaptcha::$_ip
Zend_Service_ReCaptcha::$_options
Zend_Service_ReCaptcha::$_params
Zend_Service_ReCaptcha::$_privateKey
Zend_Service_ReCaptcha::$_publicKey
Zend_Service_ReCaptcha::$_response

Inherited from Zend_Service_Abstract

Zend_Service_Abstract::$_httpClient
Methods
Constructor __construct (line 94)

Local constructor

  • access: public
Zend_Service_ReCaptcha_MailHide __construct ([string $publicKey = null], [string $privateKey = null], [string $email = null], [array|Zend_Config $options = null])
  • string $publicKey
  • string $privateKey
  • string $email
  • array|Zend_Config $options

Redefinition of:
Zend_Service_ReCaptcha::__construct()
Class constructor
getDefaultOptions (line 186)

Get the default set of parameters

  • access: public
array getDefaultOptions ()
getEmail (line 255)

Get the email property

  • access: public
string getEmail ()
getEmailDomainPart (line 275)

Get the domain part of the email address

  • access: public
string getEmailDomainPart ()
getEmailLocalPart (line 265)

Get the local part of the email address

  • access: public
string getEmailLocalPart ()
getEmailValidator (line 124)

Get emailValidator

  • access: public
Zend_Validate_Interface getEmailValidator ()
getHtml (line 287)

Get the HTML code needed for the mail hide

  • throws: Zend_Service_ReCaptcha_MailHide_Exception
  • access: public
string getHtml ([string $email = null])
  • string $email

Redefinition of:
Zend_Service_ReCaptcha::getHtml()
Get the HTML code for the captcha
setEmail (line 223)

Set the email property

This method will set the email property along with the local and domain parts

  • access: public
Zend_Service_ReCaptcha_MailHide setEmail (string $email)
  • string $email
setEmailValidator (line 139)

Set email validator

  • access: public
Zend_Service_ReCaptcha_MailHide setEmailValidator ( $validator)
setPrivateKey (line 205)

Override the setPrivateKey method

Override the parent method to store a binary representation of the private key as well.

  • access: public
Zend_Service_ReCaptcha_MailHide setPrivateKey (string $privateKey)
  • string $privateKey

Redefinition of:
Zend_Service_ReCaptcha::setPrivateKey()
Set the private key
_getUrl (line 337)

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

  • access: protected
string _getUrl ()
_requireMcrypt (line 151)

See if the mcrypt extension is available

  • throws: Zend_Service_ReCaptcha_MailHide_Exception
  • access: protected
void _requireMcrypt ()
__toString (line 169)

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.

  • access: public
string __toString ()

Redefinition of:
Zend_Service_ReCaptcha::__toString()
Serialize as string

Inherited Methods

Inherited From Zend_Service_ReCaptcha

 Zend_Service_ReCaptcha::__construct()
 Zend_Service_ReCaptcha::getHtml()
 Zend_Service_ReCaptcha::getIp()
 Zend_Service_ReCaptcha::getOption()
 Zend_Service_ReCaptcha::getOptions()
 Zend_Service_ReCaptcha::getParam()
 Zend_Service_ReCaptcha::getParams()
 Zend_Service_ReCaptcha::getPrivateKey()
 Zend_Service_ReCaptcha::getPublicKey()
 Zend_Service_ReCaptcha::setIp()
 Zend_Service_ReCaptcha::setOption()
 Zend_Service_ReCaptcha::setOptions()
 Zend_Service_ReCaptcha::setParam()
 Zend_Service_ReCaptcha::setParams()
 Zend_Service_ReCaptcha::setPrivateKey()
 Zend_Service_ReCaptcha::setPublicKey()
 Zend_Service_ReCaptcha::verify()
 Zend_Service_ReCaptcha::_post()
 Zend_Service_ReCaptcha::__toString()

Inherited From Zend_Service_Abstract

 Zend_Service_Abstract::getHttpClient()
 Zend_Service_Abstract::setHttpClient()
Class Constants
ENCRYPTION_BLOCK_SIZE = 16 (line 42)

Encryption constants

ENCRYPTION_CIPHER = MCRYPT_RIJNDAEL_128 (line 41)

Encryption constants

ENCRYPTION_IV = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0" (line 43)

Encryption constants

ENCRYPTION_MODE = MCRYPT_MODE_CBC (line 40)

Encryption constants

MAILHIDE_SERVER = 'http://mailhide.recaptcha.net/d' (line 51)

Url to the mailhide server

Inherited Constants

Inherited from Zend_Service_ReCaptcha

Zend_Service_ReCaptcha::API_SECURE_SERVER
Zend_Service_ReCaptcha::API_SERVER
Zend_Service_ReCaptcha::VERIFY_SERVER

Documentation generated on Mon, 21 Jun 2010 15:32:22 -0400 by phpDocumentor 1.4.3