Image-based captcha element

Generates image displaying random word

• version: $Id: Word.php 20096 2010-01-06 02:05:09Z bkarwin $
• copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
• license: New BSD License

Located in /Captcha/Image.php (line 37)

Zend_Validate_Abstract
   |
   --Zend_Captcha_Base
      |
      --Zend_Captcha_Word
         |
         --Zend_Captcha_Image

int $_dotNoiseLevel = 100 (line 122)

Number of noise dots on image Used twice - before and after transform

• access: protected

int $_expiration = 600 (line 114)

How long to keep generated images

• access: protected

string $_font (line 93)

Image font file

• access: protected

int $_fsize = 24 (line 86)

Font size

• access: protected

int $_gcFreq = 10 (line 107)

How frequently to execute garbage collection

• access: protected

int $_height = 50 (line 79)

Image height

• access: protected

string $_imgAlt = "" (line 58)

Image's alt tag content

• access: protected

string $_imgDir = "./images/captcha/" (line 44)

Directory for generated images

• access: protected

string $_imgUrl = "/images/captcha/" (line 51)

URL for accessing images

• access: protected

int $_lineNoiseLevel = 5 (line 129)

Number of noise lines on image Used twice - before and after transform

• access: protected

string $_startImage (line 101)

Image to use as starting point Default is blank image. If provided, should be PNG image.

• access: protected

string $_suffix = ".png" (line 65)

Image suffix (including dot)

• access: protected

int $_width = 200 (line 72)

Image width

• access: protected

Inherited Variables

Inherited from Zend_Captcha_Word

Zend_Captcha_Word::$C
Zend_Captcha_Word::$CN
Zend_Captcha_Word::$V
Zend_Captcha_Word::$VN
Zend_Captcha_Word::$_id
Zend_Captcha_Word::$_keepSession
Zend_Captcha_Word::$_messageTemplates
Zend_Captcha_Word::$_session
Zend_Captcha_Word::$_sessionClass
Zend_Captcha_Word::$_timeout
Zend_Captcha_Word::$_useNumbers
Zend_Captcha_Word::$_word
Zend_Captcha_Word::$_wordlen

Inherited from Zend_Captcha_Base

Zend_Captcha_Base::$_name
Zend_Captcha_Base::$_options
Zend_Captcha_Base::$_skipOptions

Inherited from Zend_Validate_Abstract

Zend_Validate_Abstract::$_defaultTranslator
Zend_Validate_Abstract::$_errors
Zend_Validate_Abstract::$_messageLength
Zend_Validate_Abstract::$_messages
Zend_Validate_Abstract::$_messageVariables
Zend_Validate_Abstract::$_obscureValue
Zend_Validate_Abstract::$_translator
Zend_Validate_Abstract::$_translatorDisabled
Zend_Validate_Abstract::$_value

generate (line 420)

Generate captcha

• return: captcha ID
• access: public

string generate ()

---

Redefinition of:

Zend_Captcha_Word::generate()

Generate new session ID and new word

getDotNoiseLevel (line 147)

• access: public

int getDotNoiseLevel ()

getExpiration (line 163)

Get captcha expiration

• access: public

int getExpiration ()

getFont (line 182)

Get font to use when generating captcha

• access: public

string getFont ()

getFontSize (line 192)

Get font size

• access: public

int getFontSize ()

getGcFreq (line 173)

Get garbage collection frequency

• access: public

int getGcFreq ()

getHeight (line 202)

Get captcha image height

• access: public

int getHeight ()

getImgAlt (line 133)

• access: public

string getImgAlt ()

getImgDir (line 212)

Get captcha image directory

• access: public

string getImgDir ()

getImgUrl (line 221)

Get captcha image base URL

• access: public

string getImgUrl ()

getLineNoiseLevel (line 154)

• access: public

int getLineNoiseLevel ()

getStartImage (line 140)

• access: public

string getStartImage ()

getSuffix (line 230)

Get captcha image file suffix

• access: public

string getSuffix ()

getWidth (line 239)

Get captcha image width

• access: public

int getWidth ()

render (line 596)

Display the captcha

• access: public

string render ([ $view = null], [mixed $element = null])

• Zend_View_Interface $view
• mixed $element

setDotNoiseLevel (line 254)

• access: public

void setDotNoiseLevel (int $dotNoiseLevel)

• int $dotNoiseLevel

setExpiration (line 274)

Set captcha expiration

• access: public

Zend_Captcha_Image setExpiration (int $expiration)

• int $expiration

setFont (line 298)

Set captcha font

• access: public

Zend_Captcha_Image setFont (string $font)

• string $font

setFontSize (line 310)

Set captcha font size

• access: public

Zend_Captcha_Image setFontSize (int $fsize)

• int $fsize

setGcFreq (line 286)

Set garbage collection frequency

• access: public

Zend_Captcha_Image setGcFreq (int $gcFreq)

• int $gcFreq

setHeight (line 322)

Set captcha image height

• access: public

Zend_Captcha_Image setHeight (int $height)

• int $height

setImgAlt (line 354)

• access: public

void setImgAlt (string $imgAlt)

• string $imgAlt

setImgDir (line 334)

Set captcha image storage directory

• access: public

Zend_Captcha_Image setImgDir (string $imgDir)

• string $imgDir

setImgUrl (line 346)

Set captcha image base URL

• access: public

Zend_Captcha_Image setImgUrl (string $imgUrl)

• string $imgUrl

setLineNoiseLevel (line 262)

• access: public

void setLineNoiseLevel (int $lineNoiseLevel)

• int $lineNoiseLevel

setStartImage (line 246)

• access: public

void setStartImage (string $startImage)

• string $startImage

setSuffix (line 366)

Set captch image filename suffix

• access: public

Zend_Captcha_Image setSuffix (string $suffix)

• string $suffix

setWidth (line 378)

Set captcha image width

• access: public

Zend_Captcha_Image setWidth (int $width)

• int $width

_gc (line 572)

Remove old files from image directory

• access: protected

void _gc ()

_generateImage (line 446)

Generate image captcha

Override this function if you want different image generator Wave transform from http://www.captcha.ru/captchas/multiwave/

• access: protected

void _generateImage (string $id, string $word)

• string $id: Captcha ID
• string $word: Captcha word

_randomFreq (line 389)

Generate random frequency

• access: protected

float _randomFreq ()

_randomPhase (line 399)

Generate random phase

• access: protected

float _randomPhase ()

_randomSize (line 410)

Generate random character size

• access: protected

int _randomSize ()

Inherited Methods

Inherited From Zend_Captcha_Word

Zend_Captcha_Word::generate()
Zend_Captcha_Word::getDecorator()
Zend_Captcha_Word::getId()
Zend_Captcha_Word::getSession()
Zend_Captcha_Word::getSessionClass()
Zend_Captcha_Word::getTimeout()
Zend_Captcha_Word::getWord()
Zend_Captcha_Word::getWordlen()
Zend_Captcha_Word::isValid()
Zend_Captcha_Word::setKeepSession()
Zend_Captcha_Word::setSession()
Zend_Captcha_Word::setSessionClass()
Zend_Captcha_Word::setTimeout()
Zend_Captcha_Word::setWordlen()
Zend_Captcha_Word::_generateRandomId()
Zend_Captcha_Word::_generateWord()
Zend_Captcha_Word::_setId()
Zend_Captcha_Word::_setWord()

Inherited From Zend_Captcha_Base

Zend_Captcha_Base::__construct()
Zend_Captcha_Base::getDecorator()
Zend_Captcha_Base::getName()
Zend_Captcha_Base::getOptions()
Zend_Captcha_Base::setConfig()
Zend_Captcha_Base::setName()
Zend_Captcha_Base::setOption()
Zend_Captcha_Base::setOptions()

Inherited From Zend_Validate_Abstract

Zend_Validate_Abstract::getDefaultTranslator()
Zend_Validate_Abstract::getErrors()
Zend_Validate_Abstract::getMessageLength()
Zend_Validate_Abstract::getMessages()
Zend_Validate_Abstract::getMessageTemplates()
Zend_Validate_Abstract::getMessageVariables()
Zend_Validate_Abstract::getObscureValue()
Zend_Validate_Abstract::getTranslator()
Zend_Validate_Abstract::hasDefaultTranslator()
Zend_Validate_Abstract::hasTranslator()
Zend_Validate_Abstract::setDefaultTranslator()
Zend_Validate_Abstract::setDisableTranslator()
Zend_Validate_Abstract::setMessage()
Zend_Validate_Abstract::setMessageLength()
Zend_Validate_Abstract::setMessages()
Zend_Validate_Abstract::setObscureValue()
Zend_Validate_Abstract::setTranslator()
Zend_Validate_Abstract::translatorIsDisabled()
Zend_Validate_Abstract::_createMessage()
Zend_Validate_Abstract::_error()
Zend_Validate_Abstract::_setValue()
Zend_Validate_Abstract::__get()

Inherited Constants

Inherited from Zend_Captcha_Word

Zend_Captcha_Word::BAD_CAPTCHA
Zend_Captcha_Word::MISSING_ID
Zend_Captcha_Word::MISSING_VALUE