Dojo/Form/Element/CurrencyTextBox.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 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_Dojo  
Subpackage
Form_Element  

\Zend_Dojo_Form_Element_CurrencyTextBox

Package: Zend\Dojo\Form\Element
CurrencyTextBox dijit
Parent(s)
\Zend_Dojo_Form_Element_NumberTextBox < \Zend_Dojo_Form_Element_ValidationTextBox < \Zend_Dojo_Form_Element_TextBox < \Zend_Dojo_Form_Element_Dijit < \Zend_Form_Element
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_Dojo_Form_Element_NumberTextBox  
Version
$Id: CurrencyTextBox.php 24593 2012-01-05 20:35:02Z matthew $  

Constants

Properties

>VPropertyprotectedarray $_allowedTypes = array('decimal', 'scientific', 'percent', 'currency')
inherited
Allowed numeric type formats
Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::$$_allowedTypes
Default valuearray('decimal', 'scientific', 'percent', 'currency')Details
Type
array
Inherited_from
\Zend_Dojo_Form_Element_NumberTextBox::$$_allowedTypes  
>VPropertyprotectedbool $_isPartialRendering = false

This is to allow execution of logic inside the render() methods of child elements during the magic call while skipping the parent render() method.

Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_Element::$$_isPartialRendering  
Inherited_from
\Zend_Dojo_Form_Element_Dijit::$$_isPartialRendering  
Inherited_from
\Zend_Dojo_Form_Element_TextBox::$$_isPartialRendering  
Inherited_from
\Zend_Dojo_Form_Element_ValidationTextBox::$$_isPartialRendering  
Inherited_from
\Zend_Dojo_Form_Element_NumberTextBox::$$_isPartialRendering  
>VPropertypublicstring $helper = 'CurrencyTextBox'
Use CurrencyTextBox dijit view helper
Default value'CurrencyTextBox'Details
Type
string

Methods

methodpublic__call(string $method, array $args) : string

Call renderDecoratorName() to render a specific decorator.

Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Form_Exceptionfor invalid decorator or invalid method call
methodpublic__construct(mixed $spec, mixed $options = null) : void

$spec may be: - string: name of element - array: options with which to configure element - Zend_Config: Zend_Config with options for configuring element

Parameters
NameTypeDescription
$specmixed
$optionsmixed
Throws
ExceptionDescription
\Zend_Form_Exceptionif no element name after initialization
methodpublic__get(string $key) : mixed

Prevents access to properties beginning with '_'.

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublic__set(string $key, mixed $value) : \voide
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\voide
methodprotected_castBoolToString(mixed $item, string $key) : void
Parameters
NameTypeDescription
$itemmixed
$keystring
methodprotected_getDecorator(string $name, null | array $options) : \Zend_Form_Decorator_Interface
Parameters
NameTypeDescription
$namestring
$optionsnull | array
Returns
TypeDescription
\Zend_Form_Decorator_Interface
methodprotected_loadDecorator(array $decorator, mixed $name) : \Zend_Form_Decorator_Interface
Parameters
NameTypeDescription
$decoratorarray

Decorator type and options

$namemixed

Decorator name or alias

Returns
TypeDescription
\Zend_Form_Decorator_Interface
methodpublicaddDecorator(string | \Zend_Form_Decorator_Interface $decorator, array | \Zend_Config $options = null) : \Zend_Form_Element
Parameters
NameTypeDescription
$decoratorstring | \Zend_Form_Decorator_Interface
$optionsarray | \Zend_Config

Options with which to initialize decorator

Returns
TypeDescription
\Zend_Form_Element
methodpublicaddError(string $message) : \Zend_Form_Element
Parameters
NameTypeDescription
$messagestring
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddErrorMessage(string $message) : \Zend_Form_Element
Parameters
NameTypeDescription
$messagestring
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddErrorMessages(array $messages) : \Zend_Form_Element
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddErrors(array $messages) : \Zend_Form_Element
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicaddPrefixPath(string $prefix, string $path, string $type = null) : \Zend_Form_Element

If no $type specified, assumes it is a base path for both filters and validators, and sets each according to the following rules: - decorators: $prefix = $prefix . '_Decorator' - filters: $prefix = $prefix . '_Filter' - validators: $prefix = $prefix . '_Validate'

Otherwise, the path prefix is set on the appropriate plugin loader.

Parameters
NameTypeDescription
$prefixstring
$pathstring
$typestring
Returns
TypeDescription
\Zend_Form_Element
Throws
ExceptionDescription
\Zend_Form_Exceptionfor invalid type
methodpublicaddValidator(string | \Zend_Validate_Interface $validator, bool $breakChainOnFailure = false, array $options = array()) : \Zend_Form_Element

Note: will overwrite existing validators if they are of the same class.

Parameters
NameTypeDescription
$validatorstring | \Zend_Validate_Interface
$breakChainOnFailurebool
$optionsarray
Returns
TypeDescription
\Zend_Form_Element
Throws
ExceptionDescription
\Zend_Form_Exceptionif invalid validator type
methodpublicfilterName(string $value, bool $allowBrackets = false) : string
Parameters
NameTypeDescription
$valuestring
$allowBracketsbool
Returns
TypeDescription
string
methodpublicgetAttrib(string $name) : string
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
string
methodpublicgetConstraint(string $key) : mixed
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetConstraints() : array
Returns
TypeDescription
array
methodpublicgetCurrency() : string | null

Retrieve currency

Returns
TypeDescription
string | null
methodpublicgetDijitParam(string $key) : mixed
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetFractional() : bool

Get whether or not to present fractional values

Returns
TypeDescription
bool
methodpublicgetInvalidMessage() : string | null
Returns
TypeDescription
string | null
methodpublicgetLocale() : string | null
inherited

Retrieve locale

Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::getLocale()
Returns
TypeDescription
string | null
methodpublicgetMessages() : array

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
TypeDescription
array
methodpublicgetPattern() : string | null
inherited

Retrieve numeric format pattern

Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::getPattern()
Returns
TypeDescription
string | null
methodpublicgetPlaces() : int | null
inherited

Retrieve decimal places

Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::getPlaces()
Returns
TypeDescription
int | null
methodpublicgetPluginLoader(string $type) : \Zend_Loader_PluginLoader

Instantiates with default rules if none available for that type. Use 'decorator', 'filter', or 'validate' for $type.

Parameters
NameTypeDescription
$typestring
Returns
TypeDescription
\Zend_Loader_PluginLoader
Throws
ExceptionDescription
\Zend_Loader_Exceptionon invalid type.
methodpublicgetPromptMessage() : string | null
Returns
TypeDescription
string | null
methodpublicgetRegExp() : string | null
Returns
TypeDescription
string | null
methodpublicgetStrict() : bool
inherited

Retrieve strict flag

Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::getStrict()
Returns
TypeDescription
bool
methodpublicgetSymbol() : string | null

Retrieve symbol

Returns
TypeDescription
string | null
methodpublicgetType() : string | null
inherited

Retrieve type

Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::getType()
Returns
TypeDescription
string | null
methodpublicgetValidator(string $name) : \Zend_Validate_Interface | false
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Validate_Interface | falseFalse if not found, validator otherwise
methodpublichasConstraint(string $key) : bool
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
bool
methodpublichasDijitParam(string $key) : bool
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
bool
methodpublicisValid(mixed $value, mixed $context = null) : boolean

If a translation adapter is registered, any error messages will be translated according to the current locale, using the given error code; if no matching translation is found, the original message will be utilized.

Note: The filtered value is validated.

Parameters
NameTypeDescription
$valuemixed
$contextmixed
Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Validate_ExceptionIf validation of $value is impossible
methodpublicremoveConstraint(string $key) : \Zend_Dojo_Form_Element_ValidationTextBox
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_Dojo_Form_Element_ValidationTextBox
methodpublicresolveElementId(\Zend_Form_Decorator_Interface $decorator) : string

Passed to the HtmlTag decorator as a callback in order to provide an ID.

Parameters
NameTypeDescription
$decorator\Zend_Form_Decorator_Interface
Returns
TypeDescription
string
methodpublicsetAllowEmpty(bool $flag) : \Zend_Form_Element

When the allow empty flag is enabled and the required flag is false, the element will validate with empty values.

Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetAttrib(string $name, mixed $value) : \Zend_Form_Element
Parameters
NameTypeDescription
$namestring
$valuemixed
Returns
TypeDescription
\Zend_Form_Element
Throws
ExceptionDescription
\Zend_Form_Exceptionfor invalid $name values
methodpublicsetConstraint(string $key, mixed $value) : \Zend_Dojo_Form_Element_ValidationTextBox
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Dojo_Form_Element_ValidationTextBox
methodpublicsetConstraints(array $constraints) : \Zend_Dojo_Form_Element_ValidationTextBox

Refer to Dojo dijit.form.ValidationTextBox documentation for valid structure.

Parameters
NameTypeDescription
$constraintsarray
Returns
TypeDescription
\Zend_Dojo_Form_Element_ValidationTextBox
methodpublicsetCurrency(string $currency) : \Zend_Dojo_Form_Element_CurrencyTextBox

Set currency

Parameters
NameTypeDescription
$currencystring
Returns
TypeDescription
\Zend_Dojo_Form_Element_CurrencyTextBox
methodpublicsetErrorMessages(array $messages) : \Zend_Form_Element
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetErrors(array $messages) : \Zend_Form_Element
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetFilters(array $filters) : \Zend_Form_Element
Parameters
NameTypeDescription
$filtersarray
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetFractional(bool $flag) : \Zend_Dojo_Form_Element_CurrencyTextBox

Set whether currency is fractional

Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Dojo_Form_Element_CurrencyTextBox
methodpublicsetInvalidMessage(string $message) : \Zend_Dojo_Form_Element_ValidationTextBox
Parameters
NameTypeDescription
$messagestring
Returns
TypeDescription
\Zend_Dojo_Form_Element_ValidationTextBox
methodpublicsetLocale(string $locale) : \Zend_Dojo_Form_Element_NumberTextBox
inherited

Set locale

Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::setLocale()
Parameters
NameTypeDescription
$localestring
Returns
TypeDescription
\Zend_Dojo_Form_Element_NumberTextBox
methodpublicsetPattern(string $pattern) : \Zend_Dojo_Form_Element_NumberTextBox
inherited

Set numeric format pattern

Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::setPattern()
Parameters
NameTypeDescription
$patternstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_NumberTextBox
methodpublicsetPlaces(int $places) : \Zend_Dojo_Form_Element_NumberTextBox
inherited

Set decimal places

Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::setPlaces()
Parameters
NameTypeDescription
$placesint
Returns
TypeDescription
\Zend_Dojo_Form_Element_NumberTextBox
methodpublicsetPluginLoader(\Zend_Loader_PluginLoader_Interface $loader, string $type) : \Zend_Form_Element
Parameters
NameTypeDescription
$loader\Zend_Loader_PluginLoader_Interface
$typestring

'decorator', 'filter', or 'validate'

Returns
TypeDescription
\Zend_Form_Element
Throws
ExceptionDescription
\Zend_Form_Exceptionon invalid type
methodpublicsetPromptMessage(string $message) : \Zend_Dojo_Form_Element_ValidationTextBox
Parameters
NameTypeDescription
$messagestring
Returns
TypeDescription
\Zend_Dojo_Form_Element_ValidationTextBox
methodpublicsetRegExp(string $regexp) : \Zend_Dojo_Form_Element_ValidationTextBox
Parameters
NameTypeDescription
$regexpstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_ValidationTextBox
methodpublicsetStrict( $flag) : \Zend_Dojo_Form_Element_NumberTextBox
inherited

Set strict flag

Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::setStrict()
Parameters
NameTypeDescription
$flag
Returns
TypeDescription
\Zend_Dojo_Form_Element_NumberTextBox
methodpublicsetSymbol(string $symbol) : \Zend_Dojo_Form_Element_CurrencyTextBox

Set currency symbol

Casts to string, uppercases, and trims to three characters.

Parameters
NameTypeDescription
$symbolstring
Returns
TypeDescription
\Zend_Dojo_Form_Element_CurrencyTextBox
methodpublicsetType(string $type) : \Zend_Dojo_Form_Element_NumberTextBox
inherited

Set numeric format type

Inherited from: \Zend_Dojo_Form_Element_NumberTextBox::setType()
Parameters
NameTypeDescription
$typestring
Returns
TypeDescription
\Zend_Dojo_Form_Element_NumberTextBox
Details
See
\$_allowedTypes  
methodpublicsetView(\Zend_View_Interface $view = null) : \Zend_Dojo_Form_Element_Dijit

Ensures that the view object has the dojo view helper path set.

Parameters
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
\Zend_Dojo_Form_Element_Dijit
Documentation was generated by phpDocumentor 2.0.0a12.