Fully Qualified Name: | Zend\Captcha\Dumb |
Extends: | AbstractWord |
Example dumb word-based captcha
Note that only rendering is necessary for word-based captcha
Name | Description | Defined By |
---|---|---|
__construct() | Abstract constructor for all validators A validator should accept following parameters: - nothing f.e. Validator() - one or multiple scalar values f.e. Validator($first, $second, $third) - an array f.e. Validator(array($first => 'first', $second => 'second', $third => 'third')) - an instance of Traversable f.e. Validator($config_instance) | AbstractValidator |
__get() | Magic function returns the value of the requested property, if and only if it is the value or a message variable. | AbstractValidator |
__invoke() | Invoke as command | AbstractValidator |
generate() | Generate new session ID and new word | AbstractWord |
getDefaultTranslator() | Get default translation object for all validate objects | AbstractValidator |
getDefaultTranslatorTextDomain() | Get default translation text domain for all validate objects | AbstractValidator |
getHelperName() | Retrieve optional view helper name to use when rendering this captcha | Dumb |
getId() | Retrieve captcha ID | AbstractWord |
getLabel() | Retrieve the label for the CAPTCHA | Dumb |
getMessageLength() | Returns the maximum allowed message length | AbstractValidator |
getMessageTemplates() | Returns the message templates from the validator | AbstractValidator |
getMessageVariables() | Returns an array of the names of variables that are used in constructing validation failure messages | AbstractValidator |
getMessages() | Returns array of validation failure messages | AbstractValidator |
getName() | Get name | AbstractAdapter |
getOption() | Returns an option | AbstractValidator |
getOptions() | Returns all available options | AbstractValidator |
getSession() | Get session object | AbstractWord |
getSessionClass() | Retrieve session class to utilize | AbstractWord |
getTimeout() | Get session token timeout | AbstractWord |
getTranslator() | Return translation object | AbstractValidator |
getTranslatorTextDomain() | Return the translation text domain | AbstractValidator |
getUseNumbers() | Numbers should be included in the pattern? | AbstractWord |
getWord() | Get captcha word | AbstractWord |
getWordlen() | Retrieve word length to use when generating captcha | AbstractWord |
hasDefaultTranslator() | Is there a default translation object set? | AbstractValidator |
hasTranslator() | Does this validator have its own specific translator? | AbstractValidator |
isTranslatorEnabled() | Is translation enabled? | AbstractValidator |
isValid() | Validate the word | AbstractWord |
isValueObscured() | Retrieve flag indicating whether or not value should be obfuscated in messages | AbstractValidator |
setDefaultTranslator() | Set default translation object for all validate objects | AbstractValidator |
setDefaultTranslatorTextDomain() | Set default translation text domain for all validate objects | AbstractValidator |
setKeepSession() | Sets if session should be preserved on generate() | AbstractWord |
setLabel() | Set the label for the CAPTCHA | Dumb |
setMessage() | Sets the validation failure message template for a particular key | AbstractValidator |
setMessageLength() | Sets the maximum allowed message length | AbstractValidator |
setMessages() | 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. | AbstractValidator |
setName() | Set name | AbstractAdapter |
setOption() | Set single option for the object | AbstractAdapter |
setOptions() | Sets one or multiple options | AbstractValidator |
setSession() | Set session namespace object | AbstractWord |
setSessionClass() | Set session class for persistence | AbstractWord |
setTimeout() | Set timeout for session token | AbstractWord |
setTranslator() | Set translation object | AbstractValidator |
setTranslatorEnabled() | Indicate whether or not translation should be enabled | AbstractValidator |
setTranslatorTextDomain() | Set translation text domain | AbstractValidator |
setUseNumbers() | Set if numbers should be included in the pattern | AbstractWord |
setValueObscured() | Set flag indicating whether or not value should be obfuscated in messages | AbstractValidator |
setWordlen() | Set word length of captcha | AbstractWord |
Abstract constructor for all validators A validator should accept following parameters: - nothing f.e. Validator() - one or multiple scalar values f.e. Validator($first, $second, $third) - an array f.e. Validator(array($first => 'first', $second => 'second', $third => 'third')) - an instance of Traversable f.e. Validator($config_instance)
Parameter Name | Type | Description |
---|---|---|
$options | array|\Traversable |
Returns:
Magic function returns the value of the requested property, if and only if it is the value or a message variable.
Parameter Name | Type | Description |
---|---|---|
$property | string |
Returns: mixed
Invoke as command
Parameter Name | Type | Description |
---|---|---|
$value | mixed |
Returns: bool
Generate new session ID and new word
Returns: string session ID
Get default translation object for all validate objects
Returns: \Translator\TranslatorInterface|null
Get default translation text domain for all validate objects
Returns: string
Retrieve optional view helper name to use when rendering this captcha
Returns: string
Retrieve captcha ID
Returns: string
Retrieve the label for the CAPTCHA
Returns: string
Returns the maximum allowed message length
Returns: int
Returns the message templates from the validator
Returns: array
Returns an array of the names of variables that are used in constructing validation failure messages
Returns: array
Returns array of validation failure messages
Returns: array
Get name
Returns: string
Returns an option
Parameter Name | Type | Description |
---|---|---|
$option | string | Option |
Returns: mixed Returned option
Returns all available options
Returns: array Array with all available options
Get session object
Returns: \Container
Retrieve session class to utilize
Returns: string
Get session token timeout
Returns: int
Return translation object
Returns: \Translator\TranslatorInterface|null
Return the translation text domain
Returns: string
Numbers should be included in the pattern?
Returns: bool
Get captcha word
Returns: string
Retrieve word length to use when generating captcha
Returns: int
Is there a default translation object set?
Returns: bool
Does this validator have its own specific translator?
Returns: bool
Is translation enabled?
Returns: bool
Validate the word
Parameter Name | Type | Description |
---|---|---|
$value | mixed | |
$context | mixed |
Returns: bool
Retrieve flag indicating whether or not value should be obfuscated in messages
Returns: bool
Set default translation object for all validate objects
Parameter Name | Type | Description |
---|---|---|
$translator | \Translator\TranslatorInterface|null | |
$textDomain | string | (optional) |
Returns: void
Set default translation text domain for all validate objects
Parameter Name | Type | Description |
---|---|---|
$textDomain | string |
Returns: void
Sets if session should be preserved on generate()
Parameter Name | Type | Description |
---|---|---|
$keepSession | bool | Should |
Returns: \AbstractWord Provides a fluent interface
Set the label for the CAPTCHA
Parameter Name | Type | Description |
---|---|---|
$label | string |
Returns:
Sets the validation failure message template for a particular key
Parameter Name | Type | Description |
---|---|---|
$messageString | string | |
$messageKey | string | OPTIONAL |
Returns: \AbstractValidator Provides a fluent interface
Sets the maximum allowed message length
Parameter Name | Type | Description |
---|---|---|
$length | int |
Returns:
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.
Parameter Name | Type | Description |
---|---|---|
$messages | array |
Returns: \AbstractValidator
Set name
Parameter Name | Type | Description |
---|---|---|
$name | string |
Returns: \AbstractAdapter Provides a fluent interface
Set single option for the object
Parameter Name | Type | Description |
---|---|---|
$key | string | |
$value | string |
Returns: \AbstractAdapter Provides a fluent interface
Sets one or multiple options
Parameter Name | Type | Description |
---|---|---|
$options | array|\Traversable | Options |
Returns: \AbstractValidator Provides fluid interface
Set session namespace object
Parameter Name | Type | Description |
---|---|---|
$session | \Container |
Returns: \AbstractWord Provides a fluent interface
Set session class for persistence
Parameter Name | Type | Description |
---|---|---|
$sessionClass | string |
Returns: \AbstractWord Provides a fluent interface
Set timeout for session token
Parameter Name | Type | Description |
---|---|---|
$ttl | int |
Returns: \AbstractWord Provides a fluent interface
Set translation object
Parameter Name | Type | Description |
---|---|---|
$translator | \Translator\TranslatorInterface|null | |
$textDomain | string | (optional) |
Returns: \AbstractValidator
Indicate whether or not translation should be enabled
Parameter Name | Type | Description |
---|---|---|
$flag | bool |
Returns: \AbstractValidator
Set translation text domain
Parameter Name | Type | Description |
---|---|---|
$textDomain | string |
Returns: \AbstractValidator
Set if numbers should be included in the pattern
Parameter Name | Type | Description |
---|---|---|
$useNumbers | bool | numbers |
Returns: \AbstractWord Provides a fluent interface
Set flag indicating whether or not value should be obfuscated in messages
Parameter Name | Type | Description |
---|---|---|
$flag | bool |
Returns: \AbstractValidator
Set word length of captcha
Parameter Name | Type | Description |
---|---|---|
$wordlen | int |
Returns: \AbstractWord Provides a fluent interface