oxCaptcha Class Reference

Inheritance diagram for oxCaptcha:

Inheritance graph
[legend]
Collaboration diagram for oxCaptcha:

Collaboration graph
[legend]

List of all members.


Detailed Description

Class handling CAPTCHA image This class requires utility file utils/verificationimg.php as image generator

Definition at line 8 of file oxcaptcha.php.


Public Member Functions

 getText ()
 getHash ($sText=null)
 getImageUrl ()
 isImageVisible ()
 pass ($sMac, $sMacHash)

Protected Attributes

 $_dMacLength = 5
 $_sText = null

Private Attributes

 $_sMacChars = 'abcdefghijkmnpqrstuvwxyz23456789'

Member Function Documentation

oxCaptcha.getText (  ) 

Returns text

Returns:
string

Definition at line 36 of file oxcaptcha.php.

oxCaptcha.getHash ( sText = null  ) 

Returns text hash

Parameters:
string $sText User supplie text
Returns:
string

Definition at line 55 of file oxcaptcha.php.

oxCaptcha.getImageUrl (  ) 

Returns url to CAPTCHA image generator.

Returns:
string

Definition at line 71 of file oxcaptcha.php.

oxCaptcha.isImageVisible (  ) 

Checks if image could be generated

Returns:
bool

Definition at line 84 of file oxcaptcha.php.

oxCaptcha.pass ( sMac,
sMacHash 
)

Verifies captcha input vs supplied hash. Returns true on success.

Parameters:
string $sMac User supplie text
string $sMacHash Generated hash
Returns:
bool

Definition at line 97 of file oxcaptcha.php.


Member Data Documentation

oxCaptcha.$_dMacLength = 5 [protected]

Definition at line 15 of file oxcaptcha.php.

oxCaptcha.$_sText = null [protected]

Definition at line 22 of file oxcaptcha.php.

oxCaptcha.$_sMacChars = 'abcdefghijkmnpqrstuvwxyz23456789' [private]

Definition at line 29 of file oxcaptcha.php.


The documentation for this class was generated from the following file:

Generated on Wed Apr 22 12:30:16 2009 for OXID eShop CE by  doxygen 1.5.5