Abstract Class Zend_Captcha_Base

Description

Implements interfaces:

Base class for Captcha adapters

Provides some utility functionality to build on

  • version: $Id: Base.php 20096 2010-01-06 02:05:09Z bkarwin $
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • abstract:
  • license: New BSD License

Located in /Captcha/Base.php (line 40)

Zend_Validate_Abstract
   |
   --Zend_Captcha_Base
Direct descendents
Class Description
Abstract class Zend_Captcha_Word Word-based captcha adapter
 class Zend_Captcha_ReCaptcha ReCaptcha adapter
Variable Summary
 string $_name
 array $_options
Method Summary
 void __construct ([array|Zend_Config $options = null])
 null getDecorator ()
 string getName ()
 array getOptions ()
 void setName (string $name)
 Zend_Form_Element setOption (string $key, string $value)
 Zend_Form_Element setOptions ([array $options = null])
Variables
string $_name (line 49)

Element name

Useful to generate/check form fields

  • access: protected
array $_options = array() (line 56)

Captcha options

  • access: protected
array $_skipOptions = array(
'options',
'config',
)
(line 62)

Options to skip when processing options

  • access: protected

Inherited Variables

Inherited from Zend_Validate_Abstract

Zend_Validate_Abstract::$_defaultTranslator
Zend_Validate_Abstract::$_errors
Zend_Validate_Abstract::$_messageLength
Zend_Validate_Abstract::$_messages
Zend_Validate_Abstract::$_messageTemplates
Zend_Validate_Abstract::$_messageVariables
Zend_Validate_Abstract::$_obscureValue
Zend_Validate_Abstract::$_translator
Zend_Validate_Abstract::$_translatorDisabled
Zend_Validate_Abstract::$_value
Methods
Constructor __construct (line 94)

Constructor

  • access: public
void __construct ([array|Zend_Config $options = null])

Redefined in descendants as:
getDecorator (line 172)

Get optional decorator

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

  • access: public
null getDecorator ()

Implementation of:
Zend_Captcha_Adapter::getDecorator()
Get optional private decorator for this captcha type

Redefined in descendants as:
getName (line 72)

Get name

  • access: public
string getName ()

Implementation of:
Zend_Captcha_Adapter::getName()
Get captcha name
getOptions (line 149)

Retrieve options representing object state

  • access: public
array getOptions ()
setConfig (line 160)

Set object state from config object

  • access: public
Zend_Captcha_Base setConfig ( $config)
setName (line 82)

Set name

  • access: public
void setName (string $name)
  • string $name

Implementation of:
Zend_Captcha_Adapter::setName()
Set captcha name
setOption (line 111)

Set single option for the object

  • access: public
Zend_Form_Element setOption (string $key, string $value)
  • string $key
  • string $value

Redefined in descendants as:
setOptions (line 136)

Set object state from options array

  • access: public
Zend_Form_Element setOptions ([array $options = null])
  • array $options

Inherited Methods

Inherited From Zend_Validate_Abstract

 Zend_Validate_Abstract::getDefaultTranslator()
 Zend_Validate_Abstract::getErrors()
 Zend_Validate_Abstract::getMessageLength()
 Zend_Validate_Abstract::getMessages()
 Zend_Validate_Abstract::getMessageTemplates()
 Zend_Validate_Abstract::getMessageVariables()
 Zend_Validate_Abstract::getObscureValue()
 Zend_Validate_Abstract::getTranslator()
 Zend_Validate_Abstract::hasDefaultTranslator()
 Zend_Validate_Abstract::hasTranslator()
 Zend_Validate_Abstract::setDefaultTranslator()
 Zend_Validate_Abstract::setDisableTranslator()
 Zend_Validate_Abstract::setMessage()
 Zend_Validate_Abstract::setMessageLength()
 Zend_Validate_Abstract::setMessages()
 Zend_Validate_Abstract::setObscureValue()
 Zend_Validate_Abstract::setTranslator()
 Zend_Validate_Abstract::translatorIsDisabled()
 Zend_Validate_Abstract::_createMessage()
 Zend_Validate_Abstract::_error()
 Zend_Validate_Abstract::_setValue()
 Zend_Validate_Abstract::__get()

Documentation generated on Mon, 21 Jun 2010 15:08:44 -0400 by phpDocumentor 1.4.3