Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Captcha_Image Class Reference

Public Member Functions

 getImgAlt ()
 
 getStartImage ()
 
 getDotNoiseLevel ()
 
 getLineNoiseLevel ()
 
 getExpiration ()
 Get captcha expiration.
 
 getGcFreq ()
 Get garbage collection frequency.
 
 getFont ()
 Get font to use when generating captcha.
 
 getFontSize ()
 Get font size.
 
 getHeight ()
 Get captcha image height.
 
 getImgDir ()
 Get captcha image directory.
 
 getImgUrl ()
 Get captcha image base URL.
 
 getSuffix ()
 Get captcha image file suffix.
 
 getWidth ()
 Get captcha image width.
 
 setStartImage ($startImage)
 
 setDotNoiseLevel ($dotNoiseLevel)
 
 setLineNoiseLevel ($lineNoiseLevel)
 
 setExpiration ($expiration)
 Set captcha expiration.
 
 setGcFreq ($gcFreq)
 Set garbage collection frequency.
 
 setFont ($font)
 Set captcha font.
 
 setFontSize ($fsize)
 Set captcha font size.
 
 setHeight ($height)
 Set captcha image height.
 
 setImgDir ($imgDir)
 Set captcha image storage directory.
 
 setImgUrl ($imgUrl)
 Set captcha image base URL.
 
 setImgAlt ($imgAlt)
 
 setSuffix ($suffix)
 Set captch image filename suffix.
 
 setWidth ($width)
 Set captcha image width.
 
 generate ()
 Generate captcha.
 
 render (Zend_View_Interface $view=null, $element=null)
 Display the captcha.
 
- Public Member Functions inherited from Zend_Captcha_Word
 getSessionClass ()
 Retrieve session class to utilize.
 
 setSessionClass ($_sessionClass)
 Set session class for persistence.
 
 getWordlen ()
 Retrieve word length to use when genrating 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 (Zend_Session_Namespace $session)
 Set session namespace object.
 
 getWord ()
 Get captcha word.
 
 generate ()
 Generate new session ID and new word.
 
 isValid ($value, $context=null)
 Validate the word.
 
 getDecorator ()
 Get captcha decorator.
 
- Public Member Functions inherited from Zend_Captcha_Base
 getName ()
 Get name.
 
 setName ($name)
 Set name.
 
 __construct ($options=null)
 Constructor.
 
 setOption ($key, $value)
 Set single option for the object.
 
 setOptions ($options=null)
 Set object state from options array.
 
 getOptions ()
 Retrieve options representing object state.
 
 setConfig (Zend_Config $config)
 Set object state from config object.
 
 getDecorator ()
 Get optional decorator.
 
- Public Member Functions inherited from Zend_Validate_Abstract
 getMessages ()
 Returns array of validation failure messages.
 
 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.
 
 getErrors ()
 Returns array of validation failure message codes.
 
 setObscureValue ($flag)
 Set flag indicating whether or not value should be obfuscated in messages.
 
 getObscureValue ()
 Retrieve flag indicating whether or not value should be obfuscated in messages.
 
 setTranslator ($translator=null)
 Set translation object.
 
 getTranslator ()
 Return translation object.
 
 hasTranslator ()
 Does this validator have its own specific translator?
 
 setDisableTranslator ($flag)
 Indicate whether or not translation should be disabled.
 
 translatorIsDisabled ()
 Is translation disabled?
 
- Public Member Functions inherited from Zend_Validate_Interface
 isValid ($value)
 Returns true if and only if $value meets the validation requirements.
 

Protected Member Functions

 _randomFreq ()
 Generate random frequency.
 
 _randomPhase ()
 Generate random phase.
 
 _randomSize ()
 Generate random character size.
 
 _generateImage ($id, $word)
 Generate image captcha.
 
 _gc ()
 Remove old files from image directory.
 
- Protected Member Functions inherited from Zend_Captcha_Word
 _setId ($id)
 Set captcha identifier.
 
 _setWord ($word)
 Set captcha word.
 
 _generateWord ()
 Generate new random word.
 
 _generateRandomId ()
 

Protected Attributes

 $_imgDir = "./images/captcha/"
 
 $_imgUrl = "/images/captcha/"
 
 $_imgAlt = ""
 
 $_suffix = ".png"
 
 $_width = 200
 
 $_height = 50
 
 $_fsize = 24
 
 $_font
 
 $_startImage
 
 $_gcFreq = 10
 
 $_expiration = 600
 
 $_dotNoiseLevel = 100
 
 $_lineNoiseLevel = 5
 
- Protected Attributes inherited from Zend_Captcha_Word
 $_id
 
 $_word
 
 $_session
 
 $_sessionClass = 'Zend_Session_Namespace'
 
 $_useNumbers = true
 
 $_timeout = 300
 
 $_keepSession = false
 
 $_messageTemplates
 
 $_wordlen = 8
 
- Protected Attributes inherited from Zend_Captcha_Base
 $_name
 
 $_options = array()
 
 $_skipOptions
 
- Protected Attributes inherited from Zend_Validate_Abstract
 $_value
 
 $_messageVariables = array()
 
 $_messageTemplates = array()
 
 $_messages = array()
 
 $_obscureValue = false
 
 $_errors = array()
 
 $_translator
 
 $_translatorDisabled = false
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Validate_Abstract
static setDefaultTranslator ($translator=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 getMessageLength ()
 Returns the maximum allowed message length.
 
static setMessageLength ($length=-1)
 Sets the maximum allowed message length.
 
- Public Attributes inherited from Zend_Captcha_Word
const MISSING_VALUE = 'missingValue'
 #@+ Error codes
 
const MISSING_ID = 'missingID'
 
const BAD_CAPTCHA = 'badCaptcha'
 
- Static Public Attributes inherited from Zend_Captcha_Word
static $V = array("a", "e", "i", "o", "u", "y")
 
static $VN = array("a", "e", "i", "o", "u", "y","2","3","4","5","6","7","8","9")
 
static $C = array("b","c","d","f","g","h","j","k","m","n","p","q","r","s","t","u","v","w","x","z")
 
static $CN = 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 Protected Attributes inherited from Zend_Validate_Abstract
static $_defaultTranslator
 
static $_messageLength = -1
 

Member Function Documentation

_gc ( )
protected

Remove old files from image directory.

_generateImage (   $id,
  $word 
)
protected

Generate image captcha.

Override this function if you want different image generator Wave transform from http://www.captcha.ru/captchas/multiwave/

Parameters
string$idCaptcha ID
string$wordCaptcha word
_randomFreq ( )
protected

Generate random frequency.

Returns
float
_randomPhase ( )
protected

Generate random phase.

Returns
float
_randomSize ( )
protected

Generate random character size.

Returns
int
generate ( )

Generate captcha.

Returns
string captcha ID

Implements Zend_Captcha_Adapter.

getDotNoiseLevel ( )
Returns
int
getExpiration ( )

Get captcha expiration.

Returns
int
getFont ( )

Get font to use when generating captcha.

Returns
string
getFontSize ( )

Get font size.

Returns
int
getGcFreq ( )

Get garbage collection frequency.

Returns
int
getHeight ( )

Get captcha image height.

Returns
int
getImgAlt ( )
Returns
string
getImgDir ( )

Get captcha image directory.

Returns
string
getImgUrl ( )

Get captcha image base URL.

Returns
string
getLineNoiseLevel ( )
Returns
int
getStartImage ( )
Returns
string
getSuffix ( )

Get captcha image file suffix.

Returns
string
getWidth ( )

Get captcha image width.

Returns
int
render ( Zend_View_Interface  $view = null,
  $element = null 
)

Display the captcha.

Parameters
Zend_View_Interface$view
mixed$element
Returns
string

Implements Zend_Captcha_Adapter.

setDotNoiseLevel (   $dotNoiseLevel)
Parameters
int$dotNoiseLevel
setExpiration (   $expiration)

Set captcha expiration.

Parameters
int$expiration
Returns
Zend_Captcha_Image
setFont (   $font)

Set captcha font.

Parameters
string$font
Returns
Zend_Captcha_Image
setFontSize (   $fsize)

Set captcha font size.

Parameters
int$fsize
Returns
Zend_Captcha_Image
setGcFreq (   $gcFreq)

Set garbage collection frequency.

Parameters
int$gcFreq
Returns
Zend_Captcha_Image
setHeight (   $height)

Set captcha image height.

Parameters
int$height
Returns
Zend_Captcha_Image
setImgAlt (   $imgAlt)
Parameters
string$imgAlt
setImgDir (   $imgDir)

Set captcha image storage directory.

Parameters
string$imgDir
Returns
Zend_Captcha_Image
setImgUrl (   $imgUrl)

Set captcha image base URL.

Parameters
string$imgUrl
Returns
Zend_Captcha_Image
setLineNoiseLevel (   $lineNoiseLevel)
Parameters
int$lineNoiseLevel
setStartImage (   $startImage)
Parameters
string$startImage
setSuffix (   $suffix)

Set captch image filename suffix.

Parameters
string$suffix
Returns
Zend_Captcha_Image
setWidth (   $width)

Set captcha image width.

Parameters
int$width
Returns
Zend_Captcha_Image

Member Data Documentation

$_dotNoiseLevel = 100
protected
$_expiration = 600
protected
$_font
protected
$_fsize = 24
protected
$_gcFreq = 10
protected
$_height = 50
protected
$_imgAlt = ""
protected
$_imgDir = "./images/captcha/"
protected
$_imgUrl = "/images/captcha/"
protected
$_lineNoiseLevel = 5
protected
$_startImage
protected
$_suffix = ".png"
protected
$_width = 200
protected