Captcha/Base.php

Show:

inherited

Classes
- \Zend_Captcha_Base

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
jump to top

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 24593 2012-01-05 20:35:02Z matthew $

Properties

\Zend_Translate $_defaultTranslator

staticinherited

Default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::$$_defaultTranslator

Details

Type: \Zend_Translate
Inherited_from: \Zend_Validate_Abstract::$$_defaultTranslator

array $_errors = array()

inherited

Array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::$$_errors

Default valuearray()Details

Type: array
Inherited_from: \Zend_Validate_Abstract::$$_errors

Integer $_messageLength = -1

staticinherited

Limits the maximum returned length of a error message

Inherited from: \Zend_Validate_Abstract::$$_messageLength

Default value-1Details

Type: Integer
Inherited_from: \Zend_Validate_Abstract::$$_messageLength

array $_messageTemplates = array()

inherited

Validation failure message template definitions

Inherited from: \Zend_Validate_Abstract::$$_messageTemplates

Default valuearray()Details

Type: array
Inherited_from: \Zend_Validate_Abstract::$$_messageTemplates

array $_messageVariables = array()

inherited

Additional variables available for validation failure messages

Inherited from: \Zend_Validate_Abstract::$$_messageVariables

Default valuearray()Details

Type: array
Inherited_from: \Zend_Validate_Abstract::$$_messageVariables

array $_messages = array()

inherited

Array of validation failure messages

Inherited from: \Zend_Validate_Abstract::$$_messages

Default valuearray()Details

Type: array
Inherited_from: \Zend_Validate_Abstract::$$_messages

string $_name

Element name

Useful to generate/check form fields

Details

Type: string

bool $_obscureValue = false

inherited

Flag indidcating whether or not value should be obfuscated in error messages

Inherited from: \Zend_Validate_Abstract::$$_obscureValue

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Validate_Abstract::$$_obscureValue

array $_options = array()

Captcha options

Default valuearray()Details

Type: array

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

Options to skip when processing options

Default valuearray('options', 'config')Details

Type: array

\Zend_Translate $_translator

inherited

Translation object

Inherited from: \Zend_Validate_Abstract::$$_translator

Details

Type: \Zend_Translate
Inherited_from: \Zend_Validate_Abstract::$$_translator

Boolean $_translatorDisabled = false

inherited

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::$$_translatorDisabled

Default valuefalseDetails

Type: Boolean
Inherited_from: \Zend_Validate_Abstract::$$_translatorDisabled

mixed $_value

inherited

The value to be validated

Inherited from: \Zend_Validate_Abstract::$$_value

Details

Type: mixed
Inherited_from: \Zend_Validate_Abstract::$$_value

Methods

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

Constructor

Parameters

Name	Type	Description
$options	array \| \Zend_Config

__get(string $property) : mixed

inherited

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

Inherited from: \Zend_Validate_Abstract::__get()

Parameters

Name	Type	Description
$property	string

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Validate_Exception

_createMessage(string $messageKey, string $value) : string

inherited

Constructs and returns a validation failure message with the given message key and value.

Inherited from: \Zend_Validate_Abstract::_createMessage()

Returns null if and only if $messageKey does not correspond to an existing template.

If a translator is available and a translation exists for $messageKey, the translation will be used.

Parameters

Name	Type	Description
$messageKey	string
$value	string

Returns

Type	Description
string

_error(string $messageKey, string $value = null) : void

inherited

Inherited from: \Zend_Validate_Abstract::_error()

Parameters

Name	Type	Description
$messageKey	string
$value	string	OPTIONAL

_setValue(mixed $value) : void

inherited

Sets the value to be validated and clears the messages and errors arrays

Inherited from: \Zend_Validate_Abstract::_setValue()

Parameters

Name	Type	Description
$value	mixed

generate() : string

inherited

Generate a new captcha

Inherited from: \Zend_Captcha_Adapter::generate()

Returns

Type	Description
string	new captcha ID

getDecorator() : null

Get optional decorator

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

Returns

Type	Description
null

getDefaultTranslator() : \Zend_Translate_Adapter | null

staticinherited

Get default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

getErrors() : array

inherited

Returns array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::getErrors()

Returns

Type	Description
array

getMessageLength() : integer

staticinherited

Returns the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::getMessageLength()

Returns

Type	Description
integer

getMessageTemplates() : array

inherited

Returns the message templates from the validator

Inherited from: \Zend_Validate_Abstract::getMessageTemplates()

Returns

Type	Description
array

getMessageVariables() : array

inherited

Returns an array of the names of variables that are used in constructing validation failure messages

Inherited from: \Zend_Validate_Abstract::getMessageVariables()

Returns

Type	Description
array

getMessages() : array

inherited

Returns an array of messages that explain why the most recent isValid() call returned false.

Inherited from: \Zend_Validate_Interface::getMessages()\Zend_Captcha_Adapter::getMessages()

The array keys are validation failure message identifiers, and the array values are the corresponding human-readable message strings.

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

Returns

Type	Description
array

getName() : string

Get name

Returns

Type	Description
string

getObscureValue() : bool

inherited

Retrieve flag indicating whether or not value should be obfuscated in messages

Inherited from: \Zend_Validate_Abstract::getObscureValue()

Returns

Type	Description
bool

getOptions() : array

Retrieve options representing object state

Returns

Type	Description
array

getTranslator() : \Zend_Translate_Adapter | null

inherited

Return translation object

Inherited from: \Zend_Validate_Abstract::getTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

hasDefaultTranslator() : boolean

staticinherited

Is there a default translation object set?

Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()

Returns

Type	Description
boolean

hasTranslator() : bool

inherited

Does this validator have its own specific translator?

Inherited from: \Zend_Validate_Abstract::hasTranslator()

Returns

Type	Description
bool

isValid(mixed $value) : boolean

inherited

Returns true if and only if $value meets the validation requirements

Inherited from: \Zend_Validate_Interface::isValid()\Zend_Captcha_Adapter::isValid()

If $value fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.

Parameters

Name	Type	Description
$value	mixed

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Validate_Exception	If validation of $value is impossible

render(\Zend_View_Interface $view = null, mixed $element = null) : string

inherited

Display the captcha

Inherited from: \Zend_Captcha_Adapter::render()

Parameters

Name	Type	Description
$view	\Zend_View_Interface
$element	mixed

Returns

Type	Description
string

setConfig(\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

setDefaultTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : void

staticinherited

Set default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()

Parameters

Name	Type	Description
$translator	\Zend_Translate \| \Zend_Translate_Adapter \| null

setDisableTranslator(bool $flag) : \Zend_Validate_Abstract

inherited

Indicate whether or not translation should be disabled

Inherited from: \Zend_Validate_Abstract::setDisableTranslator()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Validate_Abstract

setMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract

inherited

Sets the validation failure message template for a particular key

Inherited from: \Zend_Validate_Abstract::setMessage()

Parameters

Name	Type	Description
$messageString	string
$messageKey	string	OPTIONAL

Returns

Type	Description
\Zend_Validate_Abstract	Provides a fluent interface

Throws

Exception	Description
\Zend_Validate_Exception

setMessageLength(integer $length = -1) : void

staticinherited

Sets the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::setMessageLength()

Parameters

Name	Type	Description
$length	integer

setMessages(array $messages) : \Zend_Validate_Abstract

inherited

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.

Inherited from: \Zend_Validate_Abstract::setMessages()

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Validate_Abstract

setName(string $name) : \Zend_Captcha_Adapter

Set name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Captcha_Adapter

setObscureValue(bool $flag) : \Zend_Validate_Abstract

inherited

Set flag indicating whether or not value should be obfuscated in messages

Inherited from: \Zend_Validate_Abstract::setObscureValue()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Validate_Abstract

setOption(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

setOptions(array $options = null) : \Zend_Form_Element

Set object state from options array

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Form_Element

setTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Validate_Abstract

inherited

Set translation object

Inherited from: \Zend_Validate_Abstract::setTranslator()

Parameters

Name	Type	Description
$translator	\Zend_Translate \| \Zend_Translate_Adapter \| null

Returns

Type	Description
\Zend_Validate_Abstract

translatorIsDisabled() : bool

inherited

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()

Returns

Type	Description
bool

Captcha/Base.php

\Zend_Captcha_Basejump to top

Properties

Methods

\Zend_Captcha_Base
jump to top