Word-based captcha adapter

Generates random word which user should recognise

category Zend
package Zend_Captcha
subpackage Adapter
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
version $Id$
inherited_from \Zend_Captcha_Base

 Methods

Constructor

__construct(array|\Zend_Config $options = null
Inherited

Parameters

$options

array\Zend_Config

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

__get(string $property) : mixed
Inherited

Parameters

$property

string

Exceptions

\Zend_Validate_Exception

Returns

mixed

Generate new session ID and new word

generate() : string

Returns

stringsession ID

Get captcha decorator

getDecorator() : string

By default, return null, indicating no extra decorator needed.

inherited_from \Zend_Captcha_Base::getDecorator()

Returns

string

Get optional decorator

getDecorator() : null
Inherited

By default, return null, indicating no extra decorator needed.

inherited_from \Zend_Captcha_Adapter::getDecorator()

Returns

null

Get default translation object for all validate objects

getDefaultTranslator() : \Zend_Translate_Adapter | null
InheritedStatic

Returns

\Zend_Translate_Adapternull

Returns array of validation failure message codes

getErrors() : array
Inherited
deprecated Since 1.5.0

Returns

array

Retrieve captcha ID

getId() : string

Returns

string

Returns the maximum allowed message length

getMessageLength() : integer
InheritedStatic

Returns

integer

Returns the message templates from the validator

getMessageTemplates() : array
Inherited

Returns

array

Returns an array of the names of variables that are used in constructing validation failure messages

getMessageVariables() : array
Inherited

Returns

array

Returns array of validation failure messages

getMessages() : array
Inherited

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

inherited_from \Zend_Validate_Interface::getMessages()

Returns

array

Get name

getName() : string
Inherited
inherited_from \Zend_Captcha_Adapter::getName()

Returns

string

Retrieve flag indicating whether or not value should be obfuscated in messages

getObscureValue() : boolean
Inherited

Returns

boolean

Retrieve options representing object state

getOptions() : array
Inherited

Returns

array

Get session object

getSession() : \Zend_Session_Namespace

Returns

\Zend_Session_Namespace

Retrieve session class to utilize

getSessionClass() : string

Returns

string

Get session token timeout

getTimeout() : integer

Returns

integer

Return translation object

getTranslator() : \Zend_Translate_Adapter | null
Inherited

Returns

\Zend_Translate_Adapternull

Numbers should be included in the pattern?

getUseNumbers() : boolean

Returns

boolean

Get captcha word

getWord() : string

Returns

string

Retrieve word length to use when genrating captcha

getWordlen() : integer

Returns

integer

Is there a default translation object set?

hasDefaultTranslator() : boolean
InheritedStatic

Returns

boolean

Does this validator have its own specific translator?

hasTranslator() : boolean
Inherited

Returns

boolean

Validate the word

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

Parameters

$value

mixed

$context

arraynull

Returns

boolean

Set object state from config object

setConfig(\Zend_Config $config) : \Zend_Captcha_Base
Inherited

Parameters

$config

\Zend_Config

Returns

\Zend_Captcha_Base

Set default translation object for all validate objects

setDefaultTranslator(\Zend_Translate|\Zend_Translate_Adapter|null $translator = null
InheritedStatic

Parameters

$translator

\Zend_Translate\Zend_Translate_Adapternull

Exceptions

\Zend_Validate_Exception

Indicate whether or not translation should be disabled

setDisableTranslator(boolean $flag) : \Zend_Validate_Abstract
Inherited

Parameters

$flag

boolean

Returns

\Zend_Validate_Abstract

Sets if session should be preserved on generate()

setKeepSession(boolean $keepSession) : \Zend_Captcha_Word

Parameters

$keepSession

boolean

Should session be kept on generate()?

Returns

\Zend_Captcha_Word

Sets the validation failure message template for a particular key

setMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract
Inherited

Parameters

$messageString

string

$messageKey

string

OPTIONAL

Exceptions

\Zend_Validate_Exception

Returns

\Zend_Validate_AbstractProvides a fluent interface

Sets the maximum allowed message length

setMessageLength(integer $length = -1
InheritedStatic

Parameters

$length

integer

Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.

setMessages(array $messages) : \Zend_Validate_Abstract
Inherited

Parameters

$messages

array

Returns

\Zend_Validate_Abstract

Set name

setName(string $name) : \Zend_Captcha_Adapter
Inherited
inherited_from \Zend_Captcha_Adapter::setName()

Parameters

$name

string

Returns

\Zend_Captcha_Adapter

Set flag indicating whether or not value should be obfuscated in messages

setObscureValue(boolean $flag) : \Zend_Validate_Abstract
Inherited

Parameters

$flag

boolean

Returns

\Zend_Validate_Abstract

Set single option for the object

setOption(string $key, string $value) : \Zend_Form_Element
Inherited

Parameters

$key

string

$value

string

Returns

\Zend_Form_Element

Set object state from options array

setOptions(array $options = null) : \Zend_Form_Element
Inherited

Parameters

$options

array

Returns

\Zend_Form_Element

Set session namespace object

setSession(\Zend_Session_Namespace $session) : \Zend_Captcha_Word

Parameters

$session

\Zend_Session_Namespace

Returns

\Zend_Captcha_Word

Set session class for persistence

setSessionClass(string $_sessionClass) : \Zend_Captcha_Word

Parameters

$_sessionClass

string

Returns

\Zend_Captcha_Word

Set timeout for session token

setTimeout(integer $ttl) : \Zend_Captcha_Word

Parameters

$ttl

integer

Returns

\Zend_Captcha_Word

Set translation object

setTranslator(\Zend_Translate|\Zend_Translate_Adapter|null $translator = null) : \Zend_Validate_Abstract
Inherited

Parameters

$translator

\Zend_Translate\Zend_Translate_Adapternull

Exceptions

\Zend_Validate_Exception

Returns

\Zend_Validate_Abstract

Set if numbers should be included in the pattern

setUseNumbers(boolean $_useNumbers) : \Zend_Captcha_Word

Parameters

$_useNumbers

boolean

numbers should be included in the pattern?

Returns

\Zend_Captcha_Word

Set word length of captcha

setWordlen(integer $wordlen) : \Zend_Captcha_Word

Parameters

$wordlen

integer

Returns

\Zend_Captcha_Word

Is translation disabled?

translatorIsDisabled() : boolean
Inherited

Returns

boolean

Constructs and returns a validation failure message with the given message key and value.

_createMessage(string $messageKey, string $value) : string
Inherited

Returns null if and only if $messageKey does not correspond to an existing template.

If a translator is available and a translation exists for $messageKey, the translation will be used.

Parameters

$messageKey

string

$value

string

Returns

string

_error()

_error(string $messageKey, string $value = null) : void
Inherited

Parameters

$messageKey

string

$value

string

OPTIONAL

_generateRandomId()

_generateRandomId() 

Generate new random word

_generateWord() : string

Returns

string

Joins elements of a multidimensional array

_implodeRecursive(array $pieces) : string
Inherited

Parameters

$pieces

array

Returns

string

Set captcha identifier

_setId(string $id) : \Zend_Captcha_Word

Parameters

$id

string

Returns

\Zend_Captcha_Word

Sets the value to be validated and clears the messages and errors arrays

_setValue(mixed $value) : void
Inherited

Parameters

$value

mixed

Set captcha word

_setWord(string $word) : \Zend_Captcha_Word

Parameters

$word

string

Returns

\Zend_Captcha_Word

 Properties

 

$C

$C 

Default

array("b", "c", "d", "f", "g", "h", "j", "k", "m", "n", "p", "q", "r", "s", "t", "u", "v", "w", "x", "z")
Static
 

$CN

$CN 

Default

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")
Static
 

$V

$V 

Default

array("a", "e", "i", "o", "u", "y")
Static
 

$VN

$VN 

Default

array("a", "e", "i", "o", "u", "y", "2", "3", "4", "5", "6", "7", "8", "9")
Static
 

Default translation object for all validate objects

$_defaultTranslator : \Zend_Translate

Default

Static
 

Array of validation failure message codes

$_errors : array

Default

array()
deprecated Since 1.5.0
 

Random session ID

$_id : string

Default

 

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

$_keepSession : boolean

Default

false
 

Limits the maximum returned length of a error message

$_messageLength : Integer

Default

-1
Static
 

Error messages

$_messageTemplates : array

Default

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

Validation failure message template definitions

$_messageTemplates : array

Default

array()
 

Additional variables available for validation failure messages

$_messageVariables : array

Default

array()
 

Array of validation failure messages

$_messages : array

Default

array()
 

Element name

$_name : string

Default

Useful to generate/check form fields

 

Flag indidcating whether or not value should be obfuscated in error messages

$_obscureValue : boolean

Default

false
 

Captcha options

$_options : array

Default

array()
 

Session

$_session : \Zend_Session_Namespace

Default

 

Class name for sessions

$_sessionClass : string

Default

'Zend_Session_Namespace'
 

Options to skip when processing options

$_skipOptions : array

Default

array('options', 'config')
 

Session lifetime for the captcha data

$_timeout : integer

Default

300
 

Translation object

$_translator : \Zend_Translate

Default

 

Is translation disabled?

$_translatorDisabled : Boolean

Default

false
 

Should the numbers be used or only letters

$_useNumbers : boolean

Default

true
 

The value to be validated

$_value : mixed

Default

 

Generated word

$_word : string

Default

 

Length of the word to generate

$_wordlen : integer

Default

8

 Constants

 

BAD_CAPTCHA

BAD_CAPTCHA = 'badCaptcha' 
 

MISSING_ID

MISSING_ID = 'missingID' 
 

MISSING_VALUE

MISSING_VALUE = 'missingValue'