API Documentation

Zend/Captcha/Base.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Captcha  
Subpackage
Adapter  

\Zend_Captcha_Base

Package: Zend\Captcha\Adapter

Base class for Captcha adapters

Provides some utility functionality to build on

Implements
\Zend_Captcha_Adapter
Parent(s)
\Zend_Validate_Abstract
Children
\Zend_Captcha_ReCaptcha
\Zend_Captcha_Word
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id: Base.php 24594 2012-01-05 21:27:01Z matthew $  

Properties

Propertyprotectedstring  $_name= ''

Element name

Useful to generate/check form fields

Details
Type
string
Propertyprotectedarray  $_options= 'array()'

Captcha options

Default valuearray()Details
Type
array
Propertyprotectedarray  $_skipOptions= 'array( 'options''

Options to skip when processing options

Default valuearray( 'options'Details
Type
array

Methods

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

Constructor

Parameters
Name Type Description
$options array|\Zend_Config
methodpublicgetDecorator( ) : null

Get optional decorator

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

Returns
Type Description
null
methodpublicgetName( ) : string

Get name

Returns
Type Description
string
methodpublicgetOptions( ) : array

Retrieve options representing object state

Returns
Type Description
array
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Captcha_Base

Set object state from config object

Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Captcha_Base
methodpublicsetName( string $name ) : void

Set name

Parameters
Name Type Description
$name string
methodpublicsetOption( string $key, string $value ) : \Zend_Form_Element

Set single option for the object

Parameters
Name Type Description
$key string
$value string
Returns
Type Description
\Zend_Form_Element
methodpublicsetOptions( array $options = null ) : \Zend_Form_Element

Set object state from options array

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Element
Documentation was generated by DocBlox 0.15.1.