API Documentation

Captcha/Base.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
Classes
Zend_Captcha_Base

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_Base

Extends from
Zend_Validate_Abstract
Implements
Zend_Captcha_Adapter
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: Base.php 20096 2010-01-06 02:05:09Z bkarwin $
Properties
$_name
$_options
$_skipOptions
Methods
getName
setName
__construct
setOption
setOptions
getOptions
setConfig
getDecorator

Description

Base class for Captcha adapters

Provides some utility functionality to build on

Properties

$_name

string $_name = ''

Element name

Useful to generate/check form fields

Details

$_name
string
visibility
protected
default
final
false
static
false

$_options

array $_options = 'array'

Captcha options

Details

$_options
array
visibility
protected
default
array
final
false
static
false

$_skipOptions

array $_skipOptions = 'array'

Options to skip when processing options

Details

$_skipOptions
array
visibility
protected
default
array
final
false
static
false

Methods

__construct

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

Constructor

Arguments
$options
arrayZend_Config
Details
visibility
public
final
false
static
false

getDecorator

getDecorator( ) : null

Get optional decorator

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

Output
null
Details
visibility
public
final
false
static
false

getName

getName( ) : string

Get name

Output
string
Details
visibility
public
final
false
static
false

getOptions

getOptions( ) : array

Retrieve options representing object state

Output
array
Details
visibility
public
final
false
static
false

setConfig

setConfig( Zend_Config $config ) : Zend_Captcha_Base

Set object state from config object

Arguments
$config
Zend_Config
Details
visibility
public
final
false
static
false

setName

setName( string $name ) :

Set name

Arguments
$name
string
Details
visibility
public
final
false
static
false

setOption

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

Set single option for the object

Arguments
$key
string
$value
string
Details
visibility
public
final
false
static
false

setOptions

setOptions( array $options = null ) : Zend_Form_Element

Set object state from options array

Arguments
$options
array
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.