Zend_Captcha_Base Class Reference

Public Member Functions
	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.
Public Member Functions inherited from Zend_Captcha_Adapter
	generate ()
	Generate a new captcha.
	render (Zend_View_Interface $view=null, $element=null)
	Display the captcha.

Protected Attributes
	$_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.
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	_error ($messageKey, $value=null)
	_setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Constructor & Destructor Documentation

__construct

(

$options = null

)

Constructor.

Parameters

array | Zend_Config

$options

Returns

void

Member Function Documentation

getDecorator

(

)

Get optional decorator.

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

Returns

null

Implements Zend_Captcha_Adapter.

getName

(

)

Get name.

Returns

string

Implements Zend_Captcha_Adapter.

getOptions

(

)

Retrieve options representing object state.

Returns

array

setConfig

(

Zend_Config

$config

)

Set object state from config object.

Parameters

Zend_Config

$config

Returns

Zend_Captcha_Base

setName

(

$name

)

Set name.

Parameters

string

$name

Implements Zend_Captcha_Adapter.

setOption	(		$key,
			$value
	)

Set single option for the object.

Parameters

string	$key
string	$value

Returns

Zend_Form_Element

setOptions

(

$options = null

)

Set object state from options array.

Parameters

array

$options

Returns

Zend_Form_Element

Member Data Documentation

$_name

protected

$_options = array()

protected

$_skipOptions

protected

Initial value:

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