Captcha/Base.php

Show: PublicProtectedPrivateinherited
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-2014 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
Parent(s)
\Zend_Validate_Abstract
Children
\Zend_Captcha_ReCaptcha
\Zend_Captcha_Word
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id$  

Properties

>VPropertyprotectedstring $_name
Element name
Useful to generate/check form fields
Details
Type
string
>VPropertyprotectedarray $_options = array()
Captcha options
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_skipOptions = array('options', 'config')
Options to skip when processing options
Default valuearray('options', 'config')Details
Type
array

Methods

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

Constructor

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodpublicgetDecorator() : null

Get optional decorator

By default, return null, indicating no extra decorator needed.
Returns
TypeDescription
null
methodpublicgetName() : string

Get name

Returns
TypeDescription
string
methodpublicgetOptions() : array

Retrieve options representing object state

Returns
TypeDescription
array
methodpublicsetConfig(\Zend_Config $config) : \Zend_Captcha_Base

Set object state from config object

Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Captcha_Base
methodpublicsetName(string $name) : void

Set name

Parameters
NameTypeDescription
$namestring
methodpublicsetOption(string $key, string $value) : \Zend_Form_Element

Set single option for the object

Parameters
NameTypeDescription
$keystring
$valuestring
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetOptions(array $options = null) : \Zend_Form_Element

Set object state from options array

Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Element
Documentation was generated by phpDocumentor 2.2.0 .