Word-based captcha adapter

Generates random word which user should recognise

• 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)
• abstract:
• license: New BSD License

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

Zend_Validate_Abstract
   |
   --Zend_Captcha_Base
      |
      --Zend_Captcha_Word

static array $C = array("b","c","d","f","g","h","j","k","m","n","p","q","r","s","t","u","v","w","x","z") (line 44)

• var: Character sets

static array $CN = array("b","c","d","f","g","h","j","k","m","n","p","q","r","s","t","u","v","w","x","z","2","3","4","5","6","7","8","9") (line 45)

• var: Character sets

static array $V = array("a", "e", "i", "o", "u", "y") (line 42)

• var: Character sets

static array $VN = array("a", "e", "i", "o", "u", "y","2","3","4","5","6","7","8","9") (line 43)

• var: Character sets

string $_id (line 53)

Random session ID

• access: protected

boolean $_keepSession = false (line 102)

Should generate() keep session or create a new one?

• access: protected

array $_messageTemplates = array(
self::MISSING_VALUE => 'Empty captcha value',
self::MISSING_ID => 'Captcha ID field is missing',
self::BAD_CAPTCHA => 'Captcha value is wrong',
) (line 116)

Error messages

• access: protected

---

Redefinition of:

Zend_Validate_Abstract::$_messageTemplates

Validation failure message template definitions

Zend_Session_Namespace $_session (line 67)

Session

• access: protected

string $_sessionClass = 'Zend_Session_Namespace' (line 74)

Class name for sessions

• access: protected

integer $_timeout = 300 (line 95)

Session lifetime for the captcha data

• access: protected

boolean $_useNumbers = true (line 81)

Should the numbers be used or only letters

• access: protected

string $_word (line 60)

Generated word

• access: protected

integer $_wordlen = 8 (line 127)

Length of the word to generate

• access: protected

Inherited Variables

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 326)

Generate new session ID and new word

• return: session ID
• access: public

string generate ()

---

Redefined in descendants as:

• Zend_Captcha_Image::generate() : Generate captcha
• Zend_Captcha_Figlet::generate() : Generate new captcha

getDecorator (line 392)

Get captcha decorator

• access: public

string getDecorator ()

---

Redefinition of:

Zend_Captcha_Base::getDecorator()

Get optional decorator

getId (line 178)

Retrieve captcha ID

• access: public

string getId ()

getSession (line 237)

Get session object

• access: public

Zend_Session_Namespace getSession ()

getSessionClass (line 134)

Retrieve session class to utilize

• access: public

string getSessionClass ()

getTimeout (line 215)

Get session token timeout

• access: public

int getTimeout ()

getWord (line 272)

Get captcha word

• access: public

string getWord ()

getWordlen (line 156)

Retrieve word length to use when genrating captcha

• access: public

integer getWordlen ()

isValid (line 350)

Validate the word

• see: Zend_Validate_Interface::isValid()
• access: public

boolean isValid (mixed $value, [ $context = null])

• mixed $value
• $context

setKeepSession (line 226)

Sets if session should be preserved on generate()

• access: public

Zend_Captcha_Word setKeepSession ($keepSession $keepSession)

• $keepSession $keepSession: Should session be kept on generate()?

setSession (line 258)

Set session namespace object

• access: public

Zend_Captcha_Word setSession ( $session)

• Zend_Session_Namespace $session

setSessionClass (line 145)

Set session class for persistence

• access: public

Zend_Captcha_Word setSessionClass (string $_sessionClass)

• string $_sessionClass

setTimeout (line 204)

Set timeout for session token

• access: public

Zend_Captcha_Word setTimeout (int $ttl)

• int $ttl

setWordlen (line 167)

Set word length of captcha

• access: public

Zend_Captcha_Word setWordlen (integer $wordlen)

• integer $wordlen

_generateRandomId (line 338)

• access: protected

void _generateRandomId ()

_generateWord (line 300)

Generate new random word

• access: protected

string _generateWord ()

_setId (line 192)

Set captcha identifier

• access: protected

void _setId (string $id)

• string $id: return Zend_Captcha_Word

_setWord (line 287)

Set captcha word

• access: protected

Zend_Captcha_Word _setWord (string $word)

• string $word

Inherited Methods

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()