Zend Framework  3.0
Public Member Functions | Protected Attributes | List of all members
Dumb Class Reference

Example dumb word-based captcha. More...

Public Member Functions

 setLabel ($label)
 Set the label for the CAPTCHA.
 
 getLabel ()
 Retrieve the label for the CAPTCHA.
 
 getHelperName ()
 Retrieve optional view helper name to use when rendering this captcha.
 
- Public Member Functions inherited from AbstractWord
 getSessionClass ()
 Retrieve session class to utilize.
 
 setSessionClass ($sessionClass)
 Set session class for persistence.
 
 getWordlen ()
 Retrieve word length to use when generating captcha.
 
 setWordlen ($wordlen)
 Set word length of captcha.
 
 getId ()
 Retrieve captcha ID.
 
 setTimeout ($ttl)
 Set timeout for session token.
 
 getTimeout ()
 Get session token timeout.
 
 setKeepSession ($keepSession)
 Sets if session should be preserved on generate()
 
 getUseNumbers ()
 Numbers should be included in the pattern?
 
 setUseNumbers ($useNumbers)
 Set if numbers should be included in the pattern.
 
 getSession ()
 Get session object.
 
 setSession (Container $session)
 Set session namespace object.
 
 getWord ()
 Get captcha word.
 
 generate ()
 Generate new session ID and new word.
 
 isValid ($value, $context=null)
 Validate the word.
 
 getHelperName ()
 Get helper name used to render captcha.
 
- Public Member Functions inherited from AbstractAdapter
 getName ()
 Get name.
 
 setName ($name)
 Set name.
 
 setOption ($key, $value)
 Set single option for the object.
 
 setOptions ($options=[])
 Set object state from options array.
 
 getOptions ()
 Retrieve options representing object state.
 
 getHelperName ()
 Get helper name used to render captcha.
 
- Public Member Functions inherited from AbstractValidator
 __construct ($options=null)
 Abstract constructor for all validators A validator should accept following parameters:
 
 getOption ($option)
 Returns an option.
 
 getOptions ()
 Returns all available options.
 
 setOptions ($options=[])
 Sets one or multiple options.
 
 getMessages ()
 Returns array of validation failure messages.
 
 __invoke ($value)
 Invoke as command.
 
 getMessageVariables ()
 Returns an array of the names of variables that are used in constructing validation failure messages.
 
 getMessageTemplates ()
 Returns the message templates from the validator.
 
 setMessage ($messageString, $messageKey=null)
 Sets the validation failure message template for a particular key.
 
 setMessages (array $messages)
 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.
 
 __get ($property)
 Magic function returns the value of the requested property, if and only if it is the value or a message variable.
 
 setValueObscured ($flag)
 Set flag indicating whether or not value should be obfuscated in messages.
 
 isValueObscured ()
 Retrieve flag indicating whether or not value should be obfuscated in messages.
 
 setTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
 Set translation object.
 
 getTranslator ()
 Return translation object.
 
 hasTranslator ()
 Does this validator have its own specific translator?
 
 setTranslatorTextDomain ($textDomain= 'default')
 Set translation text domain.
 
 getTranslatorTextDomain ()
 Return the translation text domain.
 
 setTranslatorEnabled ($flag=true)
 Indicate whether or not translation should be enabled.
 
 isTranslatorEnabled ()
 Is translation enabled?
 
- Public Member Functions inherited from TranslatorAwareInterface
 setTranslator (TranslatorInterface $translator=null, $textDomain=null)
 Sets translator to use in helper.
 
- Public Member Functions inherited from ValidatorInterface
 isValid ($value)
 Returns true if and only if $value meets the validation requirements.
 

Protected Attributes

 $label = 'Please type this word backwards'
 CAPTCHA label string.
 
- Protected Attributes inherited from AbstractWord
 $id
 
 $word
 
 $session
 
 $sessionClass = 'Zend\Session\Container'
 
 $useNumbers = true
 
 $timeout = 300
 
 $keepSession = false
 
 $messageTemplates
 
 $wordlen = 8
 
- Protected Attributes inherited from AbstractAdapter
 $name
 
 $options = []
 
 $skipOptions
 
- Protected Attributes inherited from AbstractValidator
 $value
 
 $abstractOptions
 

Additional Inherited Members

- Static Public Member Functions inherited from AbstractValidator
static setDefaultTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
 Set default translation object for all validate objects.
 
static getDefaultTranslator ()
 Get default translation object for all validate objects.
 
static hasDefaultTranslator ()
 Is there a default translation object set?
 
static setDefaultTranslatorTextDomain ($textDomain= 'default')
 Set default translation text domain for all validate objects.
 
static getDefaultTranslatorTextDomain ()
 Get default translation text domain for all validate objects.
 
static getMessageLength ()
 Returns the maximum allowed message length.
 
static setMessageLength ($length=-1)
 Sets the maximum allowed message length.
 
- Public Attributes inherited from AbstractWord
const MISSING_VALUE = 'missingValue'
 #@+ Error codes
 
const MISSING_ID = 'missingID'
 
const BAD_CAPTCHA = 'badCaptcha'
 
- Static Public Attributes inherited from AbstractWord
static $V = ["a", "e", "i", "o", "u", "y"]
 
static $VN = ["a", "e", "i", "o", "u", "y", "2", "3", "4", "5", "6", "7", "8", "9"]
 
static $C = ["b", "c", "d", "f", "g", "h", "j", "k", "m", "n", "p", "q", "r", "s", "t", "u", "v", "w", "x", "z"]
 
static $CN = ["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"]
 
- Protected Member Functions inherited from AbstractWord
 setId ($id)
 Set captcha identifier.
 
 setWord ($word)
 Set captcha word.
 
 generateWord ()
 Generate new random word.
 
 generateRandomId ()
 Generate a random identifier.
 
- Static Protected Attributes inherited from AbstractValidator
static $defaultTranslator
 
static $defaultTranslatorTextDomain = 'default'
 
static $messageLength = -1
 

Detailed Description

Example dumb word-based captcha.

Note that only rendering is necessary for word-based captcha

Todo:
This likely needs its own validation since it expects the word entered to be the strrev of the word stored.

Member Function Documentation

getHelperName ( )

Retrieve optional view helper name to use when rendering this captcha.

Returns
string

Implements AdapterInterface.

getLabel ( )

Retrieve the label for the CAPTCHA.

Returns
string
setLabel (   $label)

Set the label for the CAPTCHA.

Parameters
string$label

Member Data Documentation

$label = 'Please type this word backwards'
protected

CAPTCHA label string.