Captcha/Image.php

Show:

inherited

Classes
- \Zend_Captcha_Image

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Captcha
Subpackage: Adapter
Version: $Id$

\Zend_Captcha_Image
jump to top

Package: Zend_Captcha\Adapter

Image-based captcha element

Generates image displaying random word

Parent(s): \Zend_Captcha_Word < \Zend_Captcha_Base < \Zend_Validate_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

int $_dotNoiseLevel = 100

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

Default value100Details

Type: int

int $_expiration = 600

How long to keep generated images

Default value600Details

Type: int

string $_font

Image font file

Details

Type: string

int $_fsize = 24

Font size

Default value24Details

Type: int

int $_gcFreq = 10

How frequently to execute garbage collection

Default value10Details

Type: int

int $_height = 50

Image height

Default value50Details

Type: int

string $_imgAlt = ""

Image's alt tag content

Default value""Details

Type: string

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

Directory for generated images

Default value"./images/captcha/"Details

Type: string

string $_imgUrl = "/images/captcha/"

URL for accessing images

Default value"/images/captcha/"Details

Type: string

int $_lineNoiseLevel = 5

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

Default value5Details

Type: int

string $_startImage

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

Details

Type: string

string $_suffix = ".png"

Image suffix (including dot)

Default value".png"Details

Type: string

int $_width = 200

Image width

Default value200Details

Type: int

Methods

_gc() : void

Remove old files from image directory

_generateImage(string $id, string $word) : void

Generate image captcha

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

Parameters

Name	Type	Description
$id	string	Captcha ID
$word	string	Captcha word

_randomFreq() : float

Generate random frequency

Returns

Type	Description
float

_randomPhase() : float

Generate random phase

Returns

Type	Description
float

_randomSize() : int

Generate random character size

Returns

Type	Description
int

generate() : string

Generate captcha

Returns

Type	Description
string	captcha ID

getDotNoiseLevel() : int

Returns

Type	Description
int

getExpiration() : int

Get captcha expiration

Returns

Type	Description
int

getFont() : string

Get font to use when generating captcha

Returns

Type	Description
string

getFontSize() : int

Get font size

Returns

Type	Description
int

getGcFreq() : int

Get garbage collection frequency

Returns

Type	Description
int

getHeight() : int

Get captcha image height

Returns

Type	Description
int

getImgAlt() : string

Returns

Type	Description
string

getImgDir() : string

Get captcha image directory

Returns

Type	Description
string

getImgUrl() : string

Get captcha image base URL

Returns

Type	Description
string

getLineNoiseLevel() : int

Returns

Type	Description
int

getStartImage() : string

Returns

Type	Description
string

getSuffix() : string

Get captcha image file suffix

Returns

Type	Description
string

getWidth() : int

Get captcha image width

Returns

Type	Description
int

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

Display the captcha

Parameters

Name	Type	Description
$view	\Zend_View_Interface
$element	mixed

Returns

Type	Description
string

setDotNoiseLevel(int $dotNoiseLevel) : void

Parameters

Name	Type	Description
$dotNoiseLevel	int

setExpiration(int $expiration) : \Zend_Captcha_Image

Set captcha expiration

Parameters

Name	Type	Description
$expiration	int

Returns

Type	Description
\Zend_Captcha_Image

setFont(string $font) : \Zend_Captcha_Image

Set captcha font

Parameters

Name	Type	Description
$font	string

Returns

Type	Description
\Zend_Captcha_Image

setFontSize(int $fsize) : \Zend_Captcha_Image

Set captcha font size

Parameters

Name	Type	Description
$fsize	int

Returns

Type	Description
\Zend_Captcha_Image

setGcFreq(int $gcFreq) : \Zend_Captcha_Image

Set garbage collection frequency

Parameters

Name	Type	Description
$gcFreq	int

Returns

Type	Description
\Zend_Captcha_Image

setHeight(int $height) : \Zend_Captcha_Image

Set captcha image height

Parameters

Name	Type	Description
$height	int

Returns

Type	Description
\Zend_Captcha_Image

setImgAlt(string $imgAlt) : void

Parameters

Name	Type	Description
$imgAlt	string

setImgDir(string $imgDir) : \Zend_Captcha_Image

Set captcha image storage directory

Parameters

Name	Type	Description
$imgDir	string

Returns

Type	Description
\Zend_Captcha_Image

setImgUrl(string $imgUrl) : \Zend_Captcha_Image

Set captcha image base URL

Parameters

Name	Type	Description
$imgUrl	string

Returns

Type	Description
\Zend_Captcha_Image

setLineNoiseLevel(int $lineNoiseLevel) : void

Parameters

Name	Type	Description
$lineNoiseLevel	int

setStartImage(string $startImage) : void

Parameters

Name	Type	Description
$startImage	string

setSuffix(string $suffix) : \Zend_Captcha_Image

Set captch image filename suffix

Parameters

Name	Type	Description
$suffix	string

Returns

Type	Description
\Zend_Captcha_Image

setWidth(int $width) : \Zend_Captcha_Image

Set captcha image width

Parameters

Name	Type	Description
$width	int

Returns

Type	Description
\Zend_Captcha_Image

Captcha/Image.php

\Zend_Captcha_Imagejump to top

Properties

Methods

\Zend_Captcha_Image
jump to top