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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Captcha
Subpackage: Adapter
Version: $Id: Image.php 24821 2012-05-29 14:54:50Z adamlundrigan $

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id: Word.php 24593 2012-01-05 20:35:02Z matthew $

Constants

 
                MISSING_VALUE
                = 'missingValue'

inheritedInherited from: \Zend_Captcha_Word::MISSING_VALUE

Inherited_from: \Zend_Captcha_Word::MISSING_VALUE

 
                MISSING_ID
                = 'missingID'

inheritedInherited from: \Zend_Captcha_Word::MISSING_ID

Inherited_from: \Zend_Captcha_Word::MISSING_ID

 
                BAD_CAPTCHA
                = 'badCaptcha'

inheritedInherited from: \Zend_Captcha_Word::BAD_CAPTCHA

Inherited_from: \Zend_Captcha_Word::BAD_CAPTCHA

Properties

$C = array("b", "c", "d", "f", "g", "h", "j", "k", "m", "n", "p", "q", "r", "s", "t", "u", "v", "w", "x", "z")

staticinheritedInherited from: \Zend_Captcha_Word::$$C

Default valuearray("b", "c", "d", "f", "g", "h", "j", "k", "m", "n", "p", "q", "r", "s", "t", "u", "v", "w", "x", "z")Details

Type: n/a
Inherited_from: \Zend_Captcha_Word::$$C

$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")

staticinheritedInherited from: \Zend_Captcha_Word::$$CN

Default value

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")

Details

Type: n/a
Inherited_from: \Zend_Captcha_Word::$$CN

$V = array("a", "e", "i", "o", "u", "y")

staticinheritedInherited from: \Zend_Captcha_Word::$$V

Default valuearray("a", "e", "i", "o", "u", "y")Details

Type: n/a
Inherited_from: \Zend_Captcha_Word::$$V

$VN = array("a", "e", "i", "o", "u", "y", "2", "3", "4", "5", "6", "7", "8", "9")

staticinheritedInherited from: \Zend_Captcha_Word::$$VN

Default valuearray("a", "e", "i", "o", "u", "y", "2", "3", "4", "5", "6", "7", "8", "9")Details

Type: n/a
Inherited_from: \Zend_Captcha_Word::$$VN

\Zend_Translate $_defaultTranslator =

staticinherited

Default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::$$_defaultTranslator \Zend_Captcha_Base::$$_defaultTranslator \Zend_Captcha_Word::$$_defaultTranslator

Details

Type: \Zend_Translate
Inherited_from: \Zend_Validate_Abstract::$$_defaultTranslator
Inherited_from: \Zend_Captcha_Base::$$_defaultTranslator
Inherited_from: \Zend_Captcha_Word::$$_defaultTranslator

int $_dotNoiseLevel = 100

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

Default value100Details

Type: int

array $_errors = array()

inherited

Array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::$$_errors \Zend_Captcha_Base::$$_errors \Zend_Captcha_Word::$$_errors

Default valuearray()Details

Type: array
Inherited_from: \Zend_Validate_Abstract::$$_errors
Inherited_from: \Zend_Captcha_Base::$$_errors
Inherited_from: \Zend_Captcha_Word::$$_errors

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 $_id =

inherited

Random session ID

Inherited from: \Zend_Captcha_Word::$$_id

Details

Type: string
Inherited_from: \Zend_Captcha_Word::$$_id

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

boolean $_keepSession = false

inherited

Should generate() keep session or create a new one?

Inherited from: \Zend_Captcha_Word::$$_keepSession

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Captcha_Word::$$_keepSession

int $_lineNoiseLevel = 5

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

Default value5Details

Type: int

Integer $_messageLength = -1

staticinherited

Limits the maximum returned length of a error message

Inherited from: \Zend_Validate_Abstract::$$_messageLength \Zend_Captcha_Base::$$_messageLength \Zend_Captcha_Word::$$_messageLength

Default value-1Details

Type: Integer
Inherited_from: \Zend_Validate_Abstract::$$_messageLength
Inherited_from: \Zend_Captcha_Base::$$_messageLength
Inherited_from: \Zend_Captcha_Word::$$_messageLength

array $_messageTemplates = array(self::MISSING_VALUE => 'Empty captcha value', self::MISSING_ID => 'Captcha ID field is missing', self::BAD_CAPTCHA => 'Captcha value is wrong')

inherited

Error messages

Inherited from: \Zend_Captcha_Word::$$_messageTemplates

Default value

array(self::MISSING_VALUE => 'Empty captcha value', self::MISSING_ID => 'Captcha ID field is missing', self::BAD_CAPTCHA => 'Captcha value is wrong')

Details

Type: array
Inherited_from: \Zend_Captcha_Word::$$_messageTemplates

array $_messageVariables = array()

inherited

Additional variables available for validation failure messages

Inherited from: \Zend_Validate_Abstract::$$_messageVariables \Zend_Captcha_Base::$$_messageVariables \Zend_Captcha_Word::$$_messageVariables

Default valuearray()Details

Type: array
Inherited_from: \Zend_Validate_Abstract::$$_messageVariables
Inherited_from: \Zend_Captcha_Base::$$_messageVariables
Inherited_from: \Zend_Captcha_Word::$$_messageVariables

array $_messages = array()

inherited

Array of validation failure messages

Inherited from: \Zend_Validate_Abstract::$$_messages \Zend_Captcha_Base::$$_messages \Zend_Captcha_Word::$$_messages

Default valuearray()Details

Type: array
Inherited_from: \Zend_Validate_Abstract::$$_messages
Inherited_from: \Zend_Captcha_Base::$$_messages
Inherited_from: \Zend_Captcha_Word::$$_messages

string $_name =

inherited

Element name

Inherited from: \Zend_Captcha_Base::$$_name \Zend_Captcha_Word::$$_name

Useful to generate/check form fields

Details

Type: string
Inherited_from: \Zend_Captcha_Base::$$_name
Inherited_from: \Zend_Captcha_Word::$$_name

bool $_obscureValue = false

inherited

Flag indidcating whether or not value should be obfuscated in error messages

Inherited from: \Zend_Validate_Abstract::$$_obscureValue \Zend_Captcha_Base::$$_obscureValue \Zend_Captcha_Word::$$_obscureValue

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Validate_Abstract::$$_obscureValue
Inherited_from: \Zend_Captcha_Base::$$_obscureValue
Inherited_from: \Zend_Captcha_Word::$$_obscureValue

array $_options = array()

inherited

Captcha options

Inherited from: \Zend_Captcha_Base::$$_options \Zend_Captcha_Word::$$_options

Default valuearray()Details

Type: array
Inherited_from: \Zend_Captcha_Base::$$_options
Inherited_from: \Zend_Captcha_Word::$$_options

\Zend_Session_Namespace $_session =

inherited

Session

Inherited from: \Zend_Captcha_Word::$$_session

Details

Type: \Zend_Session_Namespace
Inherited_from: \Zend_Captcha_Word::$$_session

string $_sessionClass = 'Zend_Session_Namespace'

inherited

Class name for sessions

Inherited from: \Zend_Captcha_Word::$$_sessionClass

Default value'Zend_Session_Namespace'Details

Type: string
Inherited_from: \Zend_Captcha_Word::$$_sessionClass

array $_skipOptions = array('options', 'config')

inherited

Options to skip when processing options

Inherited from: \Zend_Captcha_Base::$$_skipOptions \Zend_Captcha_Word::$$_skipOptions

Default valuearray('options', 'config')Details

Type: array
Inherited_from: \Zend_Captcha_Base::$$_skipOptions
Inherited_from: \Zend_Captcha_Word::$$_skipOptions

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

integer $_timeout = 300

inherited

Session lifetime for the captcha data

Inherited from: \Zend_Captcha_Word::$$_timeout

Default value300Details

Type: integer
Inherited_from: \Zend_Captcha_Word::$$_timeout

\Zend_Translate $_translator =

inherited

Translation object

Inherited from: \Zend_Validate_Abstract::$$_translator \Zend_Captcha_Base::$$_translator \Zend_Captcha_Word::$$_translator

Details

Type: \Zend_Translate
Inherited_from: \Zend_Validate_Abstract::$$_translator
Inherited_from: \Zend_Captcha_Base::$$_translator
Inherited_from: \Zend_Captcha_Word::$$_translator

Boolean $_translatorDisabled = false

inherited

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::$$_translatorDisabled \Zend_Captcha_Base::$$_translatorDisabled \Zend_Captcha_Word::$$_translatorDisabled

Default valuefalseDetails

Type: Boolean
Inherited_from: \Zend_Validate_Abstract::$$_translatorDisabled
Inherited_from: \Zend_Captcha_Base::$$_translatorDisabled
Inherited_from: \Zend_Captcha_Word::$$_translatorDisabled

boolean $_useNumbers = true

inherited

Should the numbers be used or only letters

Inherited from: \Zend_Captcha_Word::$$_useNumbers

Default valuetrueDetails

Type: boolean
Inherited_from: \Zend_Captcha_Word::$$_useNumbers

mixed $_value =

inherited

The value to be validated

Inherited from: \Zend_Validate_Abstract::$$_value \Zend_Captcha_Base::$$_value \Zend_Captcha_Word::$$_value

Details

Type: mixed
Inherited_from: \Zend_Validate_Abstract::$$_value
Inherited_from: \Zend_Captcha_Base::$$_value
Inherited_from: \Zend_Captcha_Word::$$_value

int $_width = 200

Image width

Default value200Details

Type: int

string $_word =

inherited

Generated word

Inherited from: \Zend_Captcha_Word::$$_word

Details

Type: string
Inherited_from: \Zend_Captcha_Word::$$_word

integer $_wordlen = 8

inherited

Length of the word to generate

Inherited from: \Zend_Captcha_Word::$$_wordlen

Default value8Details

Type: integer
Inherited_from: \Zend_Captcha_Word::$$_wordlen

Methods

__construct(array | \Zend_Config $options = null) : void

inherited

Constructor

Inherited from: \Zend_Captcha_Base::__construct()\Zend_Captcha_Word::__construct()

Parameters

Name	Type	Description
$options	array \| \Zend_Config

__get(string $property) : mixed

inherited

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

Inherited from: \Zend_Validate_Abstract::__get()\Zend_Captcha_Base::__get()\Zend_Captcha_Word::__get()

Parameters

Name	Type	Description
$property	string

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Validate_Exception

_createMessage(string $messageKey, string $value) : string

inherited

Constructs and returns a validation failure message with the given message key and value.

Inherited from: \Zend_Validate_Abstract::_createMessage()\Zend_Captcha_Base::_createMessage()\Zend_Captcha_Word::_createMessage()

Returns null if and only if $messageKey does not correspond to an existing template.

If a translator is available and a translation exists for $messageKey, the translation will be used.

Parameters

Name	Type	Description
$messageKey	string
$value	string

Returns

Type	Description
string

_error(string $messageKey, string $value = null) : void

inherited

Inherited from: \Zend_Validate_Abstract::_error()\Zend_Captcha_Base::_error()\Zend_Captcha_Word::_error()

Parameters

Name	Type	Description
$messageKey	string
$value	string	OPTIONAL

_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

_generateRandomId() : void

inherited

Inherited from: \Zend_Captcha_Word::_generateRandomId()

_generateWord() : string

inherited

Generate new random word

Inherited from: \Zend_Captcha_Word::_generateWord()

Returns

Type	Description
string

_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

_setId(string $id) : void

inherited

Set captcha identifier

Inherited from: \Zend_Captcha_Word::_setId()

Parameters

Name	Type	Description
$id	string	return Zend_Captcha_Word

_setValue(mixed $value) : void

inherited

Sets the value to be validated and clears the messages and errors arrays

Inherited from: \Zend_Validate_Abstract::_setValue()\Zend_Captcha_Base::_setValue()\Zend_Captcha_Word::_setValue()

Parameters

Name	Type	Description
$value	mixed

_setWord(string $word) : \Zend_Captcha_Word

inherited

Set captcha word

Inherited from: \Zend_Captcha_Word::_setWord()

Parameters

Name	Type	Description
$word	string

Returns

Type	Description
\Zend_Captcha_Word

generate() : string

Generate captcha

Returns

Type	Description
string	captcha ID

getDecorator() : string

inherited

Get captcha decorator

Inherited from: \Zend_Captcha_Word::getDecorator()

By default, return null, indicating no extra decorator needed.

Returns

Type	Description
string

getDefaultTranslator() : \Zend_Translate_Adapter | null

staticinherited

Get default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()\Zend_Captcha_Base::getDefaultTranslator()\Zend_Captcha_Word::getDefaultTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

getDotNoiseLevel() : int

Returns

Type	Description
int

getErrors() : array

inherited

Returns array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::getErrors()\Zend_Captcha_Base::getErrors()\Zend_Captcha_Word::getErrors()

Returns

Type	Description
array

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

getId() : string

inherited

Retrieve captcha ID

Inherited from: \Zend_Captcha_Word::getId()

Returns

Type	Description
string

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

getMessageLength() : integer

staticinherited

Returns the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::getMessageLength()\Zend_Captcha_Base::getMessageLength()\Zend_Captcha_Word::getMessageLength()

Returns

Type	Description
integer

getMessageTemplates() : array

inherited

Returns the message templates from the validator

Inherited from: \Zend_Validate_Abstract::getMessageTemplates()\Zend_Captcha_Base::getMessageTemplates()\Zend_Captcha_Word::getMessageTemplates()

Returns

Type	Description
array

getMessageVariables() : array

inherited

Returns an array of the names of variables that are used in constructing validation failure messages

Inherited from: \Zend_Validate_Abstract::getMessageVariables()\Zend_Captcha_Base::getMessageVariables()\Zend_Captcha_Word::getMessageVariables()

Returns

Type	Description
array

getMessages() : array

inherited

Returns array of validation failure messages

Inherited from: \Zend_Validate_Abstract::getMessages()\Zend_Captcha_Base::getMessages()\Zend_Captcha_Word::getMessages()

The array keys are validation failure message identifiers, and the array values are the corresponding human-readable message strings.

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

Returns

Type	Description
array

getName() : string

inherited

Get name

Inherited from: \Zend_Captcha_Base::getName()\Zend_Captcha_Word::getName()

Returns

Type	Description
string

getObscureValue() : bool

inherited

Retrieve flag indicating whether or not value should be obfuscated in messages

Inherited from: \Zend_Validate_Abstract::getObscureValue()\Zend_Captcha_Base::getObscureValue()\Zend_Captcha_Word::getObscureValue()

Returns

Type	Description
bool

getOptions() : array

inherited

Retrieve options representing object state

Inherited from: \Zend_Captcha_Base::getOptions()\Zend_Captcha_Word::getOptions()

Returns

Type	Description
array

getSession() : \Zend_Session_Namespace

inherited

Get session object

Inherited from: \Zend_Captcha_Word::getSession()

Returns

Type	Description
\Zend_Session_Namespace

getSessionClass() : string

inherited

Retrieve session class to utilize

Inherited from: \Zend_Captcha_Word::getSessionClass()

Returns

Type	Description
string

getStartImage() : string

Returns

Type	Description
string

getSuffix() : string

Get captcha image file suffix

Returns

Type	Description
string

getTimeout() : int

inherited

Get session token timeout

Inherited from: \Zend_Captcha_Word::getTimeout()

Returns

Type	Description
int

getTranslator() : \Zend_Translate_Adapter | null

inherited

Return translation object

Inherited from: \Zend_Validate_Abstract::getTranslator()\Zend_Captcha_Base::getTranslator()\Zend_Captcha_Word::getTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

getUseNumbers() : bool

inherited

Numbers should be included in the pattern?

Inherited from: \Zend_Captcha_Word::getUseNumbers()

Returns

Type	Description
bool

getWidth() : int

Get captcha image width

Returns

Type	Description
int

getWord() : string

inherited

Get captcha word

Inherited from: \Zend_Captcha_Word::getWord()

Returns

Type	Description
string

getWordlen() : integer

inherited

Retrieve word length to use when genrating captcha

Inherited from: \Zend_Captcha_Word::getWordlen()

Returns

Type	Description
integer

hasDefaultTranslator() : boolean

staticinherited

Is there a default translation object set?

Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()\Zend_Captcha_Base::hasDefaultTranslator()\Zend_Captcha_Word::hasDefaultTranslator()

Returns

Type	Description
boolean

hasTranslator() : bool

inherited

Does this validator have its own specific translator?

Inherited from: \Zend_Validate_Abstract::hasTranslator()\Zend_Captcha_Base::hasTranslator()\Zend_Captcha_Word::hasTranslator()

Returns

Type	Description
bool

isValid(mixed $value, $context = null) : boolean

inherited

Validate the word

Inherited from: \Zend_Captcha_Word::isValid()

If $value fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.

Parameters

Name	Type	Description
$value	mixed
$context

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Validate_Exception	If validation of $value is impossible

Details

See: \global\Zend_Validate_Interface::isValid()

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

setConfig(\Zend_Config $config) : \Zend_Captcha_Base

inherited

Set object state from config object

Inherited from: \Zend_Captcha_Base::setConfig()\Zend_Captcha_Word::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Captcha_Base

setDefaultTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : void

staticinherited

Set default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()\Zend_Captcha_Base::setDefaultTranslator()\Zend_Captcha_Word::setDefaultTranslator()

Parameters

Name	Type	Description
$translator	\Zend_Translate \| \Zend_Translate_Adapter \| null

setDisableTranslator(bool $flag) : \Zend_Validate_Abstract

inherited

Indicate whether or not translation should be disabled

Inherited from: \Zend_Validate_Abstract::setDisableTranslator()\Zend_Captcha_Base::setDisableTranslator()\Zend_Captcha_Word::setDisableTranslator()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Validate_Abstract

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

setKeepSession(bool $keepSession) : \Zend_Captcha_Word

inherited

Sets if session should be preserved on generate()

Inherited from: \Zend_Captcha_Word::setKeepSession()

Parameters

Name	Type	Description
$keepSession	bool	Should session be kept on generate()?

Returns

Type	Description
\Zend_Captcha_Word

setLineNoiseLevel(int $lineNoiseLevel) : void

Parameters

Name	Type	Description
$lineNoiseLevel	int

setMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract

inherited

Sets the validation failure message template for a particular key

Inherited from: \Zend_Validate_Abstract::setMessage()\Zend_Captcha_Base::setMessage()\Zend_Captcha_Word::setMessage()

Parameters

Name	Type	Description
$messageString	string
$messageKey	string	OPTIONAL

Returns

Type	Description
\Zend_Validate_Abstract	Provides a fluent interface

Throws

Exception	Description
\Zend_Validate_Exception

setMessageLength(integer $length = -1) : void

staticinherited

Sets the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::setMessageLength()\Zend_Captcha_Base::setMessageLength()\Zend_Captcha_Word::setMessageLength()

Parameters

Name	Type	Description
$length	integer

setMessages(array $messages) : \Zend_Validate_Abstract

inherited

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.

Inherited from: \Zend_Validate_Abstract::setMessages()\Zend_Captcha_Base::setMessages()\Zend_Captcha_Word::setMessages()

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Validate_Abstract

setName(string $name) : \Zend_Captcha_Adapter

inherited

Set name

Inherited from: \Zend_Captcha_Base::setName()\Zend_Captcha_Word::setName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Captcha_Adapter

setObscureValue(bool $flag) : \Zend_Validate_Abstract

inherited

Set flag indicating whether or not value should be obfuscated in messages

Inherited from: \Zend_Validate_Abstract::setObscureValue()\Zend_Captcha_Base::setObscureValue()\Zend_Captcha_Word::setObscureValue()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Validate_Abstract

setOption(string $key, string $value) : \Zend_Form_Element

inherited

Set single option for the object

Inherited from: \Zend_Captcha_Base::setOption()\Zend_Captcha_Word::setOption()

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
\Zend_Form_Element

setOptions(array $options = null) : \Zend_Form_Element

inherited

Set object state from options array

Inherited from: \Zend_Captcha_Base::setOptions()\Zend_Captcha_Word::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Form_Element

setSession(\Zend_Session_Namespace $session) : \Zend_Captcha_Word

inherited

Set session namespace object

Inherited from: \Zend_Captcha_Word::setSession()

Parameters

Name	Type	Description
$session	\Zend_Session_Namespace

Returns

Type	Description
\Zend_Captcha_Word

setSessionClass(string $_sessionClass) : \Zend_Captcha_Word

inherited

Set session class for persistence

Inherited from: \Zend_Captcha_Word::setSessionClass()

Parameters

Name	Type	Description
$_sessionClass	string

Returns

Type	Description
\Zend_Captcha_Word

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

setTimeout(int $ttl) : \Zend_Captcha_Word

inherited

Set timeout for session token

Inherited from: \Zend_Captcha_Word::setTimeout()

Parameters

Name	Type	Description
$ttl	int

Returns

Type	Description
\Zend_Captcha_Word

setTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Validate_Abstract

inherited

Set translation object

Inherited from: \Zend_Validate_Abstract::setTranslator()\Zend_Captcha_Base::setTranslator()\Zend_Captcha_Word::setTranslator()

Parameters

Name	Type	Description
$translator	\Zend_Translate \| \Zend_Translate_Adapter \| null

Returns

Type	Description
\Zend_Validate_Abstract

setUseNumbers(bool $_useNumbers) : \Zend_Captcha_Word

inherited

Set if numbers should be included in the pattern

Inherited from: \Zend_Captcha_Word::setUseNumbers()

Parameters

Name	Type	Description
$_useNumbers	bool	numbers should be included in the pattern?

Returns

Type	Description
\Zend_Captcha_Word

setWidth(int $width) : \Zend_Captcha_Image

Set captcha image width

Parameters

Name	Type	Description
$width	int

Returns

Type	Description
\Zend_Captcha_Image

setWordlen(integer $wordlen) : \Zend_Captcha_Word

inherited

Set word length of captcha

Inherited from: \Zend_Captcha_Word::setWordlen()

Parameters

Name	Type	Description
$wordlen	integer

Returns

Type	Description
\Zend_Captcha_Word

translatorIsDisabled() : bool

inherited

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()\Zend_Captcha_Base::translatorIsDisabled()\Zend_Captcha_Word::translatorIsDisabled()

Returns

Type	Description
bool

Captcha/Image.php

\Zend_Captcha_Imagejump to top

Constants

Properties

Methods

\Zend_Captcha_Image
jump to top