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

Class: Text_CAPTCHA_Driver_Base

Source Location: /Text_CAPTCHA-1.0.2/Text/CAPTCHA/Driver/Base.php

Class Overview


Base class file for all Text_CAPTCHA drivers.


Author(s):

Methods


Child classes:

Text_CAPTCHA_Driver_Figlet
Text_CAPTCHA_Driver_Figlet - Text_CAPTCHA driver Figlet based CAPTCHAs
Text_CAPTCHA_Driver_Image
Text_CAPTCHA_Driver_Image - Text_CAPTCHA driver graphical CAPTCHAs
Text_CAPTCHA_Driver_Word
Require Numbers_Words class for generating the text.
Text_CAPTCHA_Driver_Equation
Equation driver for Text_CAPTCHA.
Text_CAPTCHA_Driver_Numeral
Class used for numeral captchas

Inherited Variables

Inherited Methods


Class Details

[line 23]
Base class file for all Text_CAPTCHA drivers.


[ Top ]


Method Detail

getCAPTCHA   [line 82]

string|object getCAPTCHA( )

Place holder for the real getCAPTCHA() method used by extended classes to return the generated CAPTCHA (as an image resource, as an ASCII text, ...)
  • Access: public

[ Top ]

getPhrase   [line 58]

string getPhrase( )

Return secret CAPTCHA phrase This method returns the CAPTCHA phrase
  • Return: secret phrase
  • Access: public

[ Top ]

resetDriver   [line 92]

void resetDriver( )

Reset the phrase and the CAPTCHA.
  • Access: public

[ Top ]

setCaptcha   [line 70]

void setCaptcha( object|string $captcha)

Sets the generated captcha.
  • Access: protected

Parameters:

object|string   $captcha     the generated captcha

[ Top ]

setPhrase   [line 47]

void setPhrase( string $phrase)

Sets secret CAPTCHA phrase.

This method sets the CAPTCHA phrase (use null for a random phrase)

  • Access: public

Parameters:

string   $phrase     The (new) phrase

[ Top ]


Documentation generated on Fri, 28 Feb 2014 16:00:02 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.