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

AbstractWord-based captcha adapter. More...

Public Member Functions

 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.
 

Public Attributes

const MISSING_VALUE = 'missingValue'
 #@+ Error codes
 
const MISSING_ID = 'missingID'
 
const BAD_CAPTCHA = 'badCaptcha'
 

Static Public Attributes

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

 setId ($id)
 Set captcha identifier.
 
 setWord ($word)
 Set captcha word.
 
 generateWord ()
 Generate new random word.
 
 generateRandomId ()
 Generate a random identifier.
 

Protected Attributes

 $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.
 
- Static Protected Attributes inherited from AbstractValidator
static $defaultTranslator
 
static $defaultTranslatorTextDomain = 'default'
 
static $messageLength = -1
 

Detailed Description

AbstractWord-based captcha adapter.

Generates random word which user should recognise

Member Function Documentation

generate ( )

Generate new session ID and new word.

Returns
string session ID

Implements AdapterInterface.

generateRandomId ( )
protected

Generate a random identifier.

Returns
string
generateWord ( )
protected

Generate new random word.

Returns
string
getHelperName ( )

Get helper name used to render captcha.

Returns
string

Implements AdapterInterface.

getId ( )

Retrieve captcha ID.

Returns
string
getSession ( )

Get session object.

Exceptions
Exception\InvalidArgumentException
Returns
Container
getSessionClass ( )

Retrieve session class to utilize.

Returns
string
getTimeout ( )

Get session token timeout.

Returns
int
getUseNumbers ( )

Numbers should be included in the pattern?

Returns
bool
getWord ( )

Get captcha word.

Returns
string
getWordlen ( )

Retrieve word length to use when generating captcha.

Returns
int
isValid (   $value,
  $context = null 
)

Validate the word.

See Also
Zend::isValid()
Parameters
mixed$value
mixed$context
Returns
bool
setId (   $id)
protected

Set captcha identifier.

Parameters
string$id
Returns
AbstractWord
setKeepSession (   $keepSession)

Sets if session should be preserved on generate()

Parameters
bool$keepSessionShould session be kept on generate()?
Returns
AbstractWord
setSession ( Container  $session)

Set session namespace object.

Parameters
Container$session
Returns
AbstractWord
setSessionClass (   $sessionClass)

Set session class for persistence.

Parameters
string$sessionClass
Returns
AbstractWord
setTimeout (   $ttl)

Set timeout for session token.

Parameters
int$ttl
Returns
AbstractWord
setUseNumbers (   $useNumbers)

Set if numbers should be included in the pattern.

Parameters
bool$useNumbersnumbers should be included in the pattern?
Returns
AbstractWord
setWord (   $word)
protected

Set captcha word.

Parameters
string$word
Returns
AbstractWord
setWordlen (   $wordlen)

Set word length of captcha.

Parameters
int$wordlen
Returns
AbstractWord

Member Data Documentation

$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"]
static
$id
protected
$keepSession = false
protected
$messageTemplates
protected
Initial value:
= [
self::MISSING_VALUE => 'Empty captcha value'
$session
protected
$sessionClass = 'Zend\Session\Container'
protected
$timeout = 300
protected
$useNumbers = true
protected
$V = ["a", "e", "i", "o", "u", "y"]
static
$VN = ["a", "e", "i", "o", "u", "y", "2", "3", "4", "5", "6", "7", "8", "9"]
static
$word
protected
$wordlen = 8
protected
const BAD_CAPTCHA = 'badCaptcha'
const MISSING_ID = 'missingID'
const MISSING_VALUE = 'missingValue'

#@+ Error codes

Generated by   doxygen 1.8.3