API Documentation

Captcha/Image.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Captcha
subpackage
Adapter
version
$Id: Image.php 22590 2010-07-16 20:53:40Z mikaelkael $
Classes
Zend_Captcha_Image

Description

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.

Zend_Captcha_Image
jump to top

Extends from
Zend_Captcha_Word
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Captcha
subpackage
Adapter
Properties
$_imgDir
$_imgUrl
$_imgAlt
$_suffix
$_width
$_height
$_fsize
$_font
$_startImage
$_gcFreq
$_expiration
$_dotNoiseLevel
$_lineNoiseLevel
Methods
getImgAlt
getStartImage
getDotNoiseLevel
getLineNoiseLevel
getExpiration
getGcFreq
getFont
getFontSize
getHeight
getImgDir
getImgUrl
getSuffix
getWidth
setStartImage
setDotNoiseLevel
setLineNoiseLevel
setExpiration
setGcFreq
setFont
setFontSize
setHeight
setImgDir
setImgUrl
setImgAlt
setSuffix
setWidth
_randomFreq
_randomPhase
_randomSize
generate
_generateImage
_gc
render

Description

Image-based captcha element

Generates image displaying random word

Properties

$_dotNoiseLevel
jump to class

int $_dotNoiseLevel = '100'

Number of noise dots on image Used twice - before and after transform

Details

$_dotNoiseLevel
int
visibility
protected
default
100
final
false
static
false

$_expiration
jump to class

int $_expiration = '600'

How long to keep generated images

Details

$_expiration
int
visibility
protected
default
600
final
false
static
false

$_font
jump to class

string $_font = ''

Image font file

Details

$_font
string
visibility
protected
default
final
false
static
false

$_fsize
jump to class

int $_fsize = '24'

Font size

Details

$_fsize
int
visibility
protected
default
24
final
false
static
false

$_gcFreq
jump to class

int $_gcFreq = '10'

How frequently to execute garbage collection

Details

$_gcFreq
int
visibility
protected
default
10
final
false
static
false

$_height
jump to class

int $_height = '50'

Image height

Details

$_height
int
visibility
protected
default
50
final
false
static
false

$_imgAlt
jump to class

string $_imgAlt = ''

Image's alt tag content

Details

$_imgAlt
string
visibility
protected
default
final
false
static
false

$_imgDir
jump to class

string $_imgDir = './images/captcha/'

Directory for generated images

Details

$_imgDir
string
visibility
protected
default
./images/captcha/
final
false
static
false

$_imgUrl
jump to class

string $_imgUrl = '/images/captcha/'

URL for accessing images

Details

$_imgUrl
string
visibility
protected
default
/images/captcha/
final
false
static
false

$_lineNoiseLevel
jump to class

int $_lineNoiseLevel = '5'

Number of noise lines on image Used twice - before and after transform

Details

$_lineNoiseLevel
int
visibility
protected
default
5
final
false
static
false

$_startImage
jump to class

string $_startImage = ''

Image to use as starting point Default is blank image. If provided, should be PNG image.

Details

$_startImage
string
visibility
protected
default
final
false
static
false

$_suffix
jump to class

string $_suffix = '.png'

Image suffix (including dot)

Details

$_suffix
string
visibility
protected
default
.png
final
false
static
false

$_width
jump to class

int $_width = '200'

Image width

Details

$_width
int
visibility
protected
default
200
final
false
static
false

Methods

_gc
jump to class

_gc( ) :

Remove old files from image directory

Details
visibility
protected
final
false
static
false

_generateImage
jump to class

_generateImage( string $id, string $word ) :

Generate image captcha

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

Arguments
$id
string
Captcha ID
$word
string
Captcha word
Details
visibility
protected
final
false
static
false

_randomFreq
jump to class

_randomFreq( ) : float

Generate random frequency

Output
float
Details
visibility
protected
final
false
static
false

_randomPhase
jump to class

_randomPhase( ) : float

Generate random phase

Output
float
Details
visibility
protected
final
false
static
false

_randomSize
jump to class

_randomSize( ) : int

Generate random character size

Output
int
Details
visibility
protected
final
false
static
false

generate
jump to class

generate( ) : string

Generate captcha

Output
string
captcha ID
Details
visibility
public
final
false
static
false

getDotNoiseLevel
jump to class

getDotNoiseLevel( ) : int

Output
int
Details
visibility
public
final
false
static
false

getExpiration
jump to class

getExpiration( ) : int

Get captcha expiration

Output
int
Details
visibility
public
final
false
static
false

getFont
jump to class

getFont( ) : string

Get font to use when generating captcha

Output
string
Details
visibility
public
final
false
static
false

getFontSize
jump to class

getFontSize( ) : int

Get font size

Output
int
Details
visibility
public
final
false
static
false

getGcFreq
jump to class

getGcFreq( ) : int

Get garbage collection frequency

Output
int
Details
visibility
public
final
false
static
false

getHeight
jump to class

getHeight( ) : int

Get captcha image height

Output
int
Details
visibility
public
final
false
static
false

getImgAlt
jump to class

getImgAlt( ) : string

Output
string
Details
visibility
public
final
false
static
false

getImgDir
jump to class

getImgDir( ) : string

Get captcha image directory

Output
string
Details
visibility
public
final
false
static
false

getImgUrl
jump to class

getImgUrl( ) : string

Get captcha image base URL

Output
string
Details
visibility
public
final
false
static
false

getLineNoiseLevel
jump to class

getLineNoiseLevel( ) : int

Output
int
Details
visibility
public
final
false
static
false

getStartImage
jump to class

getStartImage( ) : string

Output
string
Details
visibility
public
final
false
static
false

getSuffix
jump to class

getSuffix( ) : string

Get captcha image file suffix

Output
string
Details
visibility
public
final
false
static
false

getWidth
jump to class

getWidth( ) : int

Get captcha image width

Output
int
Details
visibility
public
final
false
static
false

render
jump to class

render( Zend_View_Interface $view = null, mixed $element = null ) : string

Display the captcha

Arguments
$view
Zend_View_Interface
$element
mixed
Output
string
Details
visibility
public
final
false
static
false

setDotNoiseLevel
jump to class

setDotNoiseLevel( int $dotNoiseLevel ) :

Arguments
$dotNoiseLevel
int
Details
visibility
public
final
false
static
false

setExpiration
jump to class

setExpiration( int $expiration ) : Zend_Captcha_Image

Set captcha expiration

Arguments
$expiration
int
Output
Zend_Captcha_Image
Details
visibility
public
final
false
static
false

setFont
jump to class

setFont( string $font ) : Zend_Captcha_Image

Set captcha font

Arguments
$font
string
Output
Zend_Captcha_Image
Details
visibility
public
final
false
static
false

setFontSize
jump to class

setFontSize( int $fsize ) : Zend_Captcha_Image

Set captcha font size

Arguments
$fsize
int
Output
Zend_Captcha_Image
Details
visibility
public
final
false
static
false

setGcFreq
jump to class

setGcFreq( int $gcFreq ) : Zend_Captcha_Image

Set garbage collection frequency

Arguments
$gcFreq
int
Output
Zend_Captcha_Image
Details
visibility
public
final
false
static
false

setHeight
jump to class

setHeight( int $height ) : Zend_Captcha_Image

Set captcha image height

Arguments
$height
int
Output
Zend_Captcha_Image
Details
visibility
public
final
false
static
false

setImgAlt
jump to class

setImgAlt( string $imgAlt ) :

Arguments
$imgAlt
string
Details
visibility
public
final
false
static
false

setImgDir
jump to class

setImgDir( string $imgDir ) : Zend_Captcha_Image

Set captcha image storage directory

Arguments
$imgDir
string
Output
Zend_Captcha_Image
Details
visibility
public
final
false
static
false

setImgUrl
jump to class

setImgUrl( string $imgUrl ) : Zend_Captcha_Image

Set captcha image base URL

Arguments
$imgUrl
string
Output
Zend_Captcha_Image
Details
visibility
public
final
false
static
false

setLineNoiseLevel
jump to class

setLineNoiseLevel( int $lineNoiseLevel ) :

Arguments
$lineNoiseLevel
int
Details
visibility
public
final
false
static
false

setStartImage
jump to class

setStartImage( string $startImage ) :

Arguments
$startImage
string
Details
visibility
public
final
false
static
false

setSuffix
jump to class

setSuffix( string $suffix ) : Zend_Captcha_Image

Set captch image filename suffix

Arguments
$suffix
string
Output
Zend_Captcha_Image
Details
visibility
public
final
false
static
false

setWidth
jump to class

setWidth( int $width ) : Zend_Captcha_Image

Set captcha image width

Arguments
$width
int
Output
Zend_Captcha_Image
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.