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.
Word-based captcha adapter
Generates random word which user should recognise

boolean
$_keepSession= 'false'
Should generate() keep session or create a new one?
false
Details
string
$_sessionClass= 'Zend_Session_Namespace'
Class name for sessions
Zend_Session_Namespace
Details
boolean
$_useNumbers= 'true'
Should the numbers be used or only letters
true
Details
__construct(
array|\Zend_Config $options
=
null
)
:
void
Constructor
Inherited from: \Zend_Captcha_Base::__construct()Name | Type | Description |
---|---|---|
$options | array|\Zend_Config |

__get(
string $property
)
:
mixed
Magic function returns the value of the requested property, if and only if it is the value or a message variable.
Inherited from: \Zend_Validate_Abstract::__get()Name | Type | Description |
---|---|---|
$property | string |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\Zend_Validate_Exception |

_createMessage(
string $messageKey, string $value
)
:
string
Constructs and returns a validation failure message with the given message key and value.
Inherited from: \Zend_Validate_Abstract::_createMessage()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.
Name | Type | Description |
---|---|---|
$messageKey | string | |
$value | string |
Type | Description |
---|---|
string |

_error(
string $messageKey, string $value
=
null
)
:
void
Name | Type | Description |
---|---|---|
$messageKey | string | |
$value | string | OPTIONAL |

_setId(
string $id
)
:
void
Set captcha identifier
Name | Type | Description |
---|---|---|
$id | string | return Zend_Captcha_Word |

_setValue(
mixed $value
)
:
void
Sets the value to be validated and clears the messages and errors arrays
Inherited from: \Zend_Validate_Abstract::_setValue()Name | Type | Description |
---|---|---|
$value | mixed |

getDecorator(
)
:
string
Get captcha decorator
By default, return null, indicating no extra decorator needed.
Type | Description |
---|---|
string |

getDefaultTranslator(
)
:
\Zend_Translate_Adapter|null
Get default translation object for all validate objects
Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()Type | Description |
---|---|
\Zend_Translate_Adapternull |

getErrors(
)
:
array
Returns array of validation failure message codes
Inherited from: \Zend_Validate_Abstract::getErrors()Type | Description |
---|---|
array |

getMessageLength(
)
:
integer
Returns the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::getMessageLength()Type | Description |
---|---|
integer |

getMessageTemplates(
)
:
array
Returns the message templates from the validator
Inherited from: \Zend_Validate_Abstract::getMessageTemplates()Type | Description |
---|---|
array |

getMessageVariables(
)
:
array
Returns an array of the names of variables that are used in constructing validation failure messages
Inherited from: \Zend_Validate_Abstract::getMessageVariables()Type | Description |
---|---|
array |

getMessages(
)
:
array
Returns array of validation failure messages
Inherited from: \Zend_Validate_Abstract::getMessages()If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.
Type | Description |
---|---|
array |

getName(
)
:
string
Get name
Inherited from: \Zend_Captcha_Base::getName()Type | Description |
---|---|
string |

getObscureValue(
)
:
bool
Retrieve flag indicating whether or not value should be obfuscated in messages
Inherited from: \Zend_Validate_Abstract::getObscureValue()Type | Description |
---|---|
bool |

getOptions(
)
:
array
Retrieve options representing object state
Inherited from: \Zend_Captcha_Base::getOptions()Type | Description |
---|---|
array |

getSession(
)
:
\Zend_Session_Namespace
Get session object
Type | Description |
---|---|
\Zend_Session_Namespace |

getTranslator(
)
:
\Zend_Translate_Adapter|null
Return translation object
Inherited from: \Zend_Validate_Abstract::getTranslator()Type | Description |
---|---|
\Zend_Translate_Adapternull |

getWordlen(
)
:
integer
Retrieve word length to use when genrating captcha
Type | Description |
---|---|
integer |

hasDefaultTranslator(
)
:
boolean
Is there a default translation object set?
Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()Type | Description |
---|---|
boolean |

hasTranslator(
)
:
bool
Does this validator have its own specific translator?
Inherited from: \Zend_Validate_Abstract::hasTranslator()Type | Description |
---|---|
bool |

isValid(
mixed $value, $context
=
null
)
:
boolean
Validate the word
If $value fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.
Name | Type | Description |
---|---|---|
$value | mixed | |
$context |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Validate_Exception | If validation of $value is impossible |

render(
\Zend_View_Interface $view
=
null, mixed $element
=
null
)
:
string
Display the captcha
Inherited from: \Zend_Captcha_Adapter::render()Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface | |
$element | mixed |
Type | Description |
---|---|
string |

setConfig(
\Zend_Config $config
)
:
\Zend_Captcha_Base
Set object state from config object
Inherited from: \Zend_Captcha_Base::setConfig()
setDefaultTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator
=
null
)
:
void
Set default translation object for all validate objects
Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |

setDisableTranslator(
bool $flag
)
:
\Zend_Validate_Abstract
Indicate whether or not translation should be disabled
Inherited from: \Zend_Validate_Abstract::setDisableTranslator()
setKeepSession(
bool $keepSession
)
:
\Zend_Captcha_Word
Sets if session should be preserved on generate()
Name | Type | Description |
---|---|---|
$keepSession | bool | Should session be kept on generate()? |
Type | Description |
---|---|
\Zend_Captcha_Word |

setMessage(
string $messageString, string $messageKey
=
null
)
:
\Zend_Validate_Abstract
Sets the validation failure message template for a particular key
Inherited from: \Zend_Validate_Abstract::setMessage()Name | Type | Description |
---|---|---|
$messageString | string | |
$messageKey | string | OPTIONAL |
Type | Description |
---|---|
\Zend_Validate_Abstract | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Validate_Exception |

setMessageLength(
integer $length
)
:
void
Sets the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::setMessageLength()Name | Type | Description |
---|---|---|
$length | integer |

setMessages(
array $messages
)
:
\Zend_Validate_Abstract
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.
Inherited from: \Zend_Validate_Abstract::setMessages()
setName(
string $name
)
:
\Zend_Captcha_Adapter
Set name
Inherited from: \Zend_Captcha_Base::setName()
setObscureValue(
bool $flag
)
:
\Zend_Validate_Abstract
Set flag indicating whether or not value should be obfuscated in messages
Inherited from: \Zend_Validate_Abstract::setObscureValue()
setOption(
string $key, string $value
)
:
\Zend_Form_Element
Set single option for the object
Inherited from: \Zend_Captcha_Base::setOption()Name | Type | Description |
---|---|---|
$key | string | |
$value | string |
Type | Description |
---|---|
\Zend_Form_Element |

setOptions(
array $options
=
null
)
:
\Zend_Form_Element
Set object state from options array
Inherited from: \Zend_Captcha_Base::setOptions()
setSession(
\Zend_Session_Namespace $session
)
:
\Zend_Captcha_Word
Set session namespace object
Name | Type | Description |
---|---|---|
$session | \Zend_Session_Namespace |
Type | Description |
---|---|
\Zend_Captcha_Word |

setTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator
=
null
)
:
\Zend_Validate_Abstract
Set translation object
Inherited from: \Zend_Validate_Abstract::setTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |
Type | Description |
---|---|
\Zend_Validate_Abstract |

setUseNumbers(
bool $_useNumbers
)
:
\Zend_Captcha_Word
Set if numbers should be included in the pattern
Name | Type | Description |
---|---|---|
$_useNumbers | bool | numbers should be included in the pattern? |
Type | Description |
---|---|
\Zend_Captcha_Word |

translatorIsDisabled(
)
:
bool
Is translation disabled?
Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()Type | Description |
---|---|
bool |