Text_CAPTCHA
[ class tree: Text_CAPTCHA ] [ index: Text_CAPTCHA ] [ all elements ]

Class: Text_CAPTCHA_Driver_Figlet

Source Location: /pear/Text/CAPTCHA/Driver/Figlet.php

Class Overview

Text_CAPTCHA
   |
   --Text_CAPTCHA_Driver_Figlet

Text_CAPTCHA_Driver_Figlet - Text_CAPTCHA driver Figlet based CAPTCHAs


Author(s):

Variables

Methods


Inherited Methods

Class: Text_CAPTCHA

Text_CAPTCHA::factory()
Create a new Text_CAPTCHA object
Text_CAPTCHA::getPhrase()
Return secret CAPTCHA phrase
Text_CAPTCHA::setPhrase()
Sets secret CAPTCHA phrase

Class Details

[line 19]
Text_CAPTCHA_Driver_Figlet - Text_CAPTCHA driver Figlet based CAPTCHAs



Tags:

author:  Aaron Wormus <wormus@php.net>
author:  Christian Wenz <wenz@php.net>
todo:  define an obfuscation algorithm
license:  PHP


[ Top ]


Class Variables

$_error =  null

[line 83]

Last error



Tags:

access:  protected

Type:   PEAR_Error


[ Top ]



Class Methods


method getCAPTCHA [line 183]

mixed getCAPTCHA( )

Return CAPTCHA in the specified format

This method returns the CAPTCHA depending on the output format




Tags:

return:  Formatted captcha or PEAR error
access:  public


[ Top ]

method getCAPTCHAAsHTML [line 211]

mixed getCAPTCHAAsHTML( )

Return CAPTCHA as HTML

This method returns the CAPTCHA as HTML




Tags:

return:  HTML Figlet image or PEAR error
access:  public


[ Top ]

method getCAPTCHAAsJavascript [line 247]

mixed getCAPTCHAAsJavascript( )

Return CAPTCHA as Javascript version of HTML

This method returns the CAPTCHA as a Javascript string I'm not exactly sure what the point of doing this would be.




Tags:

return:  javascript string or PEAR error
access:  public


[ Top ]

method init [line 94]

mixed init( [array $options = array()])

init function

Initializes the new Text_CAPTCHA_Driver_Figlet object and creates a GD image




Tags:

return:  true upon success, PEAR error otherwise
access:  public


Parameters:

array   $options   CAPTCHA options

[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:51:47 +0100 by phpDocumentor 1.4.3