API Documentation

Service/ReCaptcha/MailHide.php

Includes 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_MailHide

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

Extends from
Zend_Service_ReCaptcha
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: MailHide.php 20108 2010-01-06 22:05:31Z matthew $
Constants
ENCRYPTION_MODE
ENCRYPTION_CIPHER
ENCRYPTION_BLOCK_SIZE
ENCRYPTION_IV
MAILHIDE_SERVER
Properties
$_email
$_emailValidator
$_privateKeyPacked
$_emailLocalPart
$_emailDomainPart
Methods
__construct
getEmailValidator
setEmailValidator
_requireMcrypt
__toString
getDefaultOptions
setPrivateKey
setEmail
getEmail
getEmailLocalPart
getEmailDomainPart
getHtml
_getUrl

Description

Zend_Service_ReCaptcha_MailHide

Constants

ENCRYPTION_MODE
jump to class

 ENCRYPTION_MODE = 'MCRYPT_MODE_CBC'

Details

value
MCRYPT_MODE_CBC

ENCRYPTION_CIPHER
jump to class

 ENCRYPTION_CIPHER = 'MCRYPT_RIJNDAEL_128'

Details

value
MCRYPT_RIJNDAEL_128

ENCRYPTION_BLOCK_SIZE
jump to class

 ENCRYPTION_BLOCK_SIZE = '16'

Details

value
16

ENCRYPTION_IV
jump to class

 ENCRYPTION_IV = '\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0'

Details

value
\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0

MAILHIDE_SERVER
jump to class

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

Url to the mailhide server

Details

value
http://mailhide.recaptcha.net/d
MAILHIDE_SERVER
string

Properties

$_email
jump to class

string $_email = 'null'

The email address to protect

Details

$_email
string
visibility
protected
default
null
final
false
static
false

$_emailDomainPart
jump to class

string $_emailDomainPart = 'null'

The domain part of the email

Details

$_emailDomainPart
string
visibility
protected
default
null
final
false
static
false

$_emailLocalPart
jump to class

string $_emailLocalPart = 'null'

The local part of the email

Details

$_emailLocalPart
string
visibility
protected
default
null
final
false
static
false

$_emailValidator
jump to class

Zend_Validate_Interface $_emailValidator = ''

Details

$_emailValidator
Zend_Validate_Interface
visibility
protected
default
final
false
static
false

$_privateKeyPacked
jump to class

string $_privateKeyPacked = 'null'

Binary representation of the private key

Details

$_privateKeyPacked
string
visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

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

Local constructor

Arguments
$publicKey
string
$privateKey
string
$email
string
$options
arrayZend_Config
Details
visibility
public
final
false
static
false

__toString
jump to class

__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.

Output
string
Details
visibility
public
final
false
static
false

_getUrl
jump to class

_getUrl( ) : string

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

Output
string
Details
visibility
protected
final
false
static
false

_requireMcrypt
jump to class

_requireMcrypt( ) :

See if the mcrypt extension is available

Details
visibility
protected
final
false
static
false
throws

getDefaultOptions
jump to class

getDefaultOptions( ) : array

Get the default set of parameters

Output
array
Details
visibility
public
final
false
static
false

getEmail
jump to class

getEmail( ) : string

Get the email property

Output
string
Details
visibility
public
final
false
static
false

getEmailDomainPart
jump to class

getEmailDomainPart( ) : string

Get the domain part of the email address

Output
string
Details
visibility
public
final
false
static
false

getEmailLocalPart
jump to class

getEmailLocalPart( ) : string

Get the local part of the email address

Output
string
Details
visibility
public
final
false
static
false

getEmailValidator
jump to class

getEmailValidator( ) : Zend_Validate_Interface

Get emailValidator

Output
Zend_Validate_Interface
Details
visibility
public
final
false
static
false

getHtml
jump to class

getHtml( string $email = null ) : string

Get the HTML code needed for the mail hide

Arguments
$email
string
Output
string
Details
visibility
public
final
false
static
false
throws

setEmail
jump to class

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

Arguments
$email
string
Output
Zend_Service_ReCaptcha_MailHide
Details
visibility
public
final
false
static
false

setEmailValidator
jump to class

setEmailValidator( Zend_Validate_Interface $validator ) : Zend_Service_ReCaptcha_MailHide

Set email validator

Arguments
$validator
Zend_Validate_Interface
Output
Zend_Service_ReCaptcha_MailHide
Details
visibility
public
final
false
static
false

setPrivateKey
jump to class

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.

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