Captcha/Word.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Captcha
subpackage: Adapter
Classes: Zend_Captcha_Word

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Captcha_Word
jump to top

Extends from: Zend_Captcha_Base
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Captcha
subpackage: Adapter
version: $Id: Word.php 20096 2010-01-06 02:05:09Z bkarwin $
Constants: MISSING_VALUE; MISSING_ID; BAD_CAPTCHA
Properties: $V; $VN; $C; $CN; $_id; $_word; $_session; $_sessionClass; $_useNumbers; $_timeout; $_keepSession; $_messageTemplates; $_wordlen
Methods: getSessionClass; setSessionClass; getWordlen; setWordlen; getId; _setId; setTimeout; getTimeout; setKeepSession; getSession; setSession; getWord; _setWord; _generateWord; generate; _generateRandomId; isValid; getDecorator

Description

Word-based captcha adapter

Generates random word which user should recognise

Constants

MISSING_VALUE
jump to class

 MISSING_VALUE = 'missingValue'

Details

value: missingValue

MISSING_ID
jump to class

 MISSING_ID = 'missingID'

Details

value: missingID

BAD_CAPTCHA
jump to class

 BAD_CAPTCHA = 'badCaptcha'

Details

value: badCaptcha

Properties

$C
jump to class

$C = 'array'

Details

visibility: public
default: array
final: false
static: true

$CN
jump to class

$CN = 'array'

Details

visibility: public
default: array
final: false
static: true

$V
jump to class

$V = 'array'

Details

visibility: public
default: array
final: false
static: true

$VN
jump to class

$VN = 'array'

Details

visibility: public
default: array
final: false
static: true

$_id
jump to class

string $_id = ''

Random session ID

Details

$_id: string
visibility: protected
default
final: false
static: false

$_keepSession
jump to class

boolean $_keepSession = 'false'

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

Details

$_keepSession: boolean
visibility: protected
default: false
final: false
static: false

$_messageTemplates
jump to class

array $_messageTemplates = 'array'

Error messages

Details

$_messageTemplates: array
visibility: protected
default: array
final: false
static: false

$_session
jump to class

Zend_Session_Namespace $_session = ''

Session

Details

$_session: Zend_Session_Namespace
visibility: protected
default
final: false
static: false

$_sessionClass
jump to class

string $_sessionClass = 'Zend_Session_Namespace'

Class name for sessions

Details

$_sessionClass: string
visibility: protected
default: Zend_Session_Namespace
final: false
static: false

$_timeout
jump to class

integer $_timeout = '300'

Session lifetime for the captcha data

Details

$_timeout: integer
visibility: protected
default: 300
final: false
static: false

$_useNumbers
jump to class

boolean $_useNumbers = 'true'

Should the numbers be used or only letters

Details

$_useNumbers: boolean
visibility: protected
default: true
final: false
static: false

$_word
jump to class

string $_word = ''

Generated word

Details

$_word: string
visibility: protected
default
final: false
static: false

$_wordlen
jump to class

integer $_wordlen = '8'

Length of the word to generate

Details

$_wordlen: integer
visibility: protected
default: 8
final: false
static: false

Methods

_generateRandomId
jump to class

_generateRandomId(
          
          )
        
        :

Details

visibility: protected
final: false
static: false

_generateWord
jump to class

_generateWord(
          
          )
        
        :
        string

Generate new random word

Output

string

Details

visibility: protected
final: false
static: false

_setId
jump to class

_setId(
          string $id
          )
        
        :

Set captcha identifier

Arguments

$id: string
return Zend_Captcha_Word

Details

visibility: protected
final: false
static: false

_setWord
jump to class

_setWord(
          string $word
          )
        
        :
        Zend_Captcha_Word

Set captcha word

Arguments

$word: string

Output

Zend_Captcha_Word

Details

visibility: protected
final: false
static: false

generate
jump to class

generate(
          
          )
        
        :
        string

Generate new session ID and new word

Output

string: session ID

Details

visibility: public
final: false
static: false

getDecorator
jump to class

getDecorator(
          
          )
        
        :
        string

Get captcha decorator

Output

string

Details

visibility: public
final: false
static: false

getId
jump to class

getId(
          
          )
        
        :
        string

Retrieve captcha ID

Output

string

Details

visibility: public
final: false
static: false

getSession
jump to class

getSession(
          
          )
        
        :
        Zend_Session_Namespace

Get session object

Output

Zend_Session_Namespace

Details

visibility: public
final: false
static: false

getSessionClass
jump to class

getSessionClass(
          
          )
        
        :
        string

Retrieve session class to utilize

Output

string

Details

visibility: public
final: false
static: false

getTimeout
jump to class

getTimeout(
          
          )
        
        :
        int

Get session token timeout

Output

int

Details

visibility: public
final: false
static: false

getWord
jump to class

getWord(
          
          )
        
        :
        string

Get captcha word

Output

string

Details

visibility: public
final: false
static: false

getWordlen
jump to class

getWordlen(
          
          )
        
        :
        integer

Retrieve word length to use when genrating captcha

Output

integer

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          mixed $value,  $context
              =
              null
          )
        
        :
        boolean

Validate the word

Arguments

$value: mixed
$context

Output

boolean

Details

visibility: public
final: false
static: false
see: Zend_Validate_Interface::isValid()

setKeepSession
jump to class

setKeepSession(
          $keepSession $keepSession
          )
        
        :
        Zend_Captcha_Word

Sets if session should be preserved on generate()

Arguments

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

Output

Zend_Captcha_Word

Details

visibility: public
final: false
static: false

setSession
jump to class

setSession(
          Zend_Session_Namespace $session
          )
        
        :
        Zend_Captcha_Word

Set session namespace object

Arguments

$session: Zend_Session_Namespace

Output

Zend_Captcha_Word

Details

visibility: public
final: false
static: false

setSessionClass
jump to class

setSessionClass(
          string $_sessionClass
          )
        
        :
        Zend_Captcha_Word

Set session class for persistence

Arguments

$_sessionClass: string

Output

Zend_Captcha_Word

Details

visibility: public
final: false
static: false

setTimeout
jump to class

setTimeout(
          int $ttl
          )
        
        :
        Zend_Captcha_Word

Set timeout for session token

Arguments

$ttl: int

Output

Zend_Captcha_Word

Details

visibility: public
final: false
static: false

setWordlen
jump to class

setWordlen(
          integer $wordlen
          )
        
        :
        Zend_Captcha_Word

Set word length of captcha

Arguments

$wordlen: integer

Output

Zend_Captcha_Word

Details

visibility: public
final: false
static: false

API Documentation

Captcha/Word.php

Description

Zend_Captcha_Wordjump to top

Description

Constants

MISSING_VALUEjump to class

Details

MISSING_IDjump to class

Details

BAD_CAPTCHAjump to class

Details

Properties

$Cjump to class

Details

$CNjump to class

Details

$Vjump to class

Details

$VNjump to class

Details

$_idjump to class

Details

$_keepSessionjump to class

Details

$_messageTemplatesjump to class

Details

$_sessionjump to class

Details

$_sessionClassjump to class

Details

$_timeoutjump to class

Details

$_useNumbersjump to class

Details

$_wordjump to class

Details

$_wordlenjump to class

Details

Methods

_generateRandomIdjump to class

Details

_generateWordjump to class

Output

Details

_setIdjump to class

Arguments

Details

_setWordjump to class

Arguments

Output

Details

generatejump to class

Output

Details

getDecoratorjump to class

Output

Details

getIdjump to class

Output

Details

getSessionjump to class

Output

Details

getSessionClassjump to class

Output

Details

getTimeoutjump to class

Output

Details

getWordjump to class

Output

Details

getWordlenjump to class

Output

Details

isValidjump to class

Arguments

Output

Details

Zend_Captcha_Word
jump to top

MISSING_VALUE
jump to class

MISSING_ID
jump to class

BAD_CAPTCHA
jump to class

$C
jump to class

$CN
jump to class

$V
jump to class

$VN
jump to class

$_id
jump to class

$_keepSession
jump to class

$_messageTemplates
jump to class

$_session
jump to class

$_sessionClass
jump to class

$_timeout
jump to class

$_useNumbers
jump to class

$_word
jump to class

$_wordlen
jump to class

_generateRandomId
jump to class

_generateWord
jump to class

_setId
jump to class

_setWord
jump to class

generate
jump to class

getDecorator
jump to class

getId
jump to class

getSession
jump to class

getSessionClass
jump to class

getTimeout
jump to class

getWord
jump to class

getWordlen
jump to class

isValid
jump to class

setKeepSession
jump to class

setSession
jump to class

setSessionClass
jump to class

setTimeout
jump to class

setWordlen
jump to class