Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Zend_Dojo_Form_Element_ComboBox Class Reference

Public Member Functions

 getStoreInfo ()
 Get datastore information.
 
 setStoreId ($identifier)
 Set datastore identifier.
 
 getStoreId ()
 Get datastore identifier.
 
 setStoreType ($dojoType)
 Set datastore dijit type.
 
 getStoreType ()
 Get datastore dijit type.
 
 setStoreParams (array $params)
 Set datastore parameters.
 
 getStoreParams ()
 Get datastore params.
 
 setAutocomplete ($flag)
 Set autocomplete flag.
 
 getAutocomplete ()
 Get autocomplete flag.
 
 isValid ($value, $context=null)
 Is the value valid?
 
- Public Member Functions inherited from Zend_Dojo_Form_Element_DijitMulti
 getSeparator ()
 Retrieve separator.
 
 setSeparator ($separator)
 Set separator.
 
 addMultiOption ($option, $value= '')
 Add an option.
 
 addMultiOptions (array $options)
 Add many options at once.
 
 setMultiOptions (array $options)
 Set all options at once (overwrites)
 
 getMultiOption ($option)
 Retrieve single multi option.
 
 getMultiOptions ()
 Retrieve options.
 
 removeMultiOption ($option)
 Remove a single multi option.
 
 clearMultiOptions ()
 Clear all options.
 
 setRegisterInArrayValidator ($flag)
 Set flag indicating whether or not to auto-register inArray validator.
 
 registerInArrayValidator ()
 Get status of auto-register inArray validator flag.
 
 isValid ($value, $context=null)
 Is the value provided valid?
 
- Public Member Functions inherited from Zend_Dojo_Form_Element_Dijit
 __construct ($spec, $options=null)
 Constructor.
 
 setDijitParam ($key, $value)
 Set a dijit parameter.
 
 setDijitParams (array $params)
 Set multiple dijit params at once.
 
 hasDijitParam ($key)
 Does the given dijit parameter exist?
 
 getDijitParam ($key)
 Get a single dijit parameter.
 
 getDijitParams ()
 Retrieve all dijit parameters.
 
 removeDijitParam ($key)
 Remove a single dijit parameter.
 
 clearDijitParams ()
 Clear all dijit parameters.
 
 loadDefaultDecorators ()
 Load default decorators.
 
 setView (Zend_View_Interface $view=null)
 Set the view object.
 
- Public Member Functions inherited from Zend_Form_Element
 __construct ($spec, $options=null)
 Constructor.
 
 init ()
 Initialize object; used by extending classes.
 
 setDisableLoadDefaultDecorators ($flag)
 Set flag to disable loading default decorators.
 
 loadDefaultDecoratorsIsDisabled ()
 Should we load the default decorators?
 
 loadDefaultDecorators ()
 Load default decorators.
 
 setOptions (array $options)
 Set object state from options array.
 
 setConfig (Zend_Config $config)
 Set object state from Zend_Config object.
 
 setTranslator ($translator=null)
 Set translator object for localization.
 
 getTranslator ()
 Retrieve localization translator object.
 
 hasTranslator ()
 Does this element have its own specific translator?
 
 setDisableTranslator ($flag)
 Indicate whether or not translation should be disabled.
 
 translatorIsDisabled ()
 Is translation disabled?
 
 filterName ($value, $allowBrackets=false)
 Filter a name to only allow valid variable characters.
 
 setName ($name)
 Set element name.
 
 getName ()
 Return element name.
 
 getFullyQualifiedName ()
 Get fully qualified name.
 
 getId ()
 Get element id.
 
 setValue ($value)
 Set element value.
 
 getValue ()
 Retrieve filtered element value.
 
 getUnfilteredValue ()
 Retrieve unfiltered element value.
 
 setLabel ($label)
 Set element label.
 
 getLabel ()
 Retrieve element label.
 
 setOrder ($order)
 Set element order.
 
 getOrder ()
 Retrieve element order.
 
 setRequired ($flag=true)
 Set required flag.
 
 isRequired ()
 Is the element required?
 
 setAutoInsertNotEmptyValidator ($flag)
 Set flag indicating whether a NotEmpty validator should be inserted when element is required.
 
 autoInsertNotEmptyValidator ()
 Get flag indicating whether a NotEmpty validator should be inserted when element is required.
 
 setDescription ($description)
 Set element description.
 
 getDescription ()
 Retrieve element description.
 
 setAllowEmpty ($flag)
 Set 'allow empty' flag.
 
 getAllowEmpty ()
 Get 'allow empty' flag.
 
 setIgnore ($flag)
 Set ignore flag (used when retrieving values at form level)
 
 getIgnore ()
 Get ignore flag (used when retrieving values at form level)
 
 setIsArray ($flag)
 Set flag indicating if element represents an array.
 
 isArray ()
 Is the element representing an array?
 
 setBelongsTo ($array)
 Set array to which element belongs.
 
 getBelongsTo ()
 Return array name to which element belongs.
 
 getType ()
 Return element type.
 
 setAttrib ($name, $value)
 Set element attribute.
 
 setAttribs (array $attribs)
 Set multiple attributes at once.
 
 getAttrib ($name)
 Retrieve element attribute.
 
 getAttribs ()
 Return all attributes.
 
 setConcatJustValuesInErrorMessage ($concatJustValuesInErrorMessage)
 Use one error message for array elements with concatenated values.
 
 getConcatJustValuesInErrorMessage ()
 Use one error message for array elements with concatenated values.
 
 __get ($key)
 Overloading: retrieve object property.
 
 __set ($key, $value)
 Overloading: set object property.
 
 __call ($method, $args)
 Overloading: allow rendering specific decorators.
 
 setPluginLoader (Zend_Loader_PluginLoader_Interface $loader, $type)
 Set plugin loader to use for validator or filter chain.
 
 getPluginLoader ($type)
 Retrieve plugin loader for validator or filter chain.
 
 addPrefixPath ($prefix, $path, $type=null)
 Add prefix path for plugin loader.
 
 addPrefixPaths (array $spec)
 Add many prefix paths at once.
 
 addValidator ($validator, $breakChainOnFailure=false, $options=array())
 Add validator to validation chain.
 
 addValidators (array $validators)
 Add multiple validators.
 
 setValidators (array $validators)
 Set multiple validators, overwriting previous validators.
 
 getValidator ($name)
 Retrieve a single validator by name.
 
 getValidators ()
 Retrieve all validators.
 
 removeValidator ($name)
 Remove a single validator by name.
 
 clearValidators ()
 Clear all validators.
 
 isValid ($value, $context=null)
 Validate element value.
 
 addErrorMessage ($message)
 Add a custom error message to return in the event of failed validation.
 
 addErrorMessages (array $messages)
 Add multiple custom error messages to return in the event of failed validation.
 
 setErrorMessages (array $messages)
 Same as addErrorMessages(), but clears custom error message stack first.
 
 getErrorMessages ()
 Retrieve custom error messages.
 
 clearErrorMessages ()
 Clear custom error messages stack.
 
 getErrorMessageSeparator ()
 Get errorMessageSeparator.
 
 setErrorMessageSeparator ($separator)
 Set errorMessageSeparator.
 
 markAsError ()
 Mark the element as being in a failed validation state.
 
 addError ($message)
 Add an error message and mark element as failed validation.
 
 addErrors (array $messages)
 Add multiple error messages and flag element as failed validation.
 
 setErrors (array $messages)
 Overwrite any previously set error messages and flag as failed validation.
 
 hasErrors ()
 Are there errors registered?
 
 getErrors ()
 Retrieve validator chain errors.
 
 getMessages ()
 Retrieve error messages.
 
 addFilter ($filter, $options=array())
 Add a filter to the element.
 
 addFilters (array $filters)
 Add filters to element.
 
 setFilters (array $filters)
 Add filters to element, overwriting any already existing.
 
 getFilter ($name)
 Retrieve a single filter by name.
 
 getFilters ()
 Get all filters.
 
 removeFilter ($name)
 Remove a filter by name.
 
 clearFilters ()
 Clear all filters.
 
 setView (Zend_View_Interface $view=null)
 Set view object.
 
 getView ()
 Retrieve view object.
 
 addDecorator ($decorator, $options=null)
 Add a decorator for rendering the element.
 
 addDecorators (array $decorators)
 Add many decorators at once.
 
 setDecorators (array $decorators)
 Overwrite all decorators.
 
 getDecorator ($name)
 Retrieve a registered decorator.
 
 getDecorators ()
 Retrieve all decorators.
 
 removeDecorator ($name)
 Remove a single decorator.
 
 clearDecorators ()
 Clear all decorators.
 
 render (Zend_View_Interface $view=null)
 Render form element.
 
 __toString ()
 String representation of form element.
 
- Public Member Functions inherited from Zend_Validate_Interface
 isValid ($value)
 Returns true if and only if $value meets the validation requirements.
 

Public Attributes

 $helper = 'ComboBox'
 
- Public Attributes inherited from Zend_Dojo_Form_Element_DijitMulti
 $options = array()
 
- Public Attributes inherited from Zend_Dojo_Form_Element_Dijit
 $dijitParams = array()
 
 $helper
 
- Public Attributes inherited from Zend_Form_Element
const DECORATOR = 'DECORATOR'
 Element Constants.
 
const FILTER = 'FILTER'
 
const VALIDATE = 'VALIDATE'
 
 $helper = 'formText'
 

Protected Attributes

 $_registerInArrayValidator = false
 
- Protected Attributes inherited from Zend_Dojo_Form_Element_DijitMulti
 $_registerInArrayValidator = true
 
 $_separator = '<br />'
 
 $_translated = array()
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Form_Element
static resolveElementId (Zend_Form_Decorator_Interface $decorator)
 Used to resolve and return an element ID.
 
- Protected Member Functions inherited from Zend_Dojo_Form_Element_DijitMulti
 _getMultiOptions ()
 Retrieve options array.
 
 _translateOption ($option, $value)
 Translate an option.
 
 _translateValue ($value)
 Translate a value.
 

Member Function Documentation

getAutocomplete ( )

Get autocomplete flag.

Returns
bool
getStoreId ( )

Get datastore identifier.

Returns
string|null
getStoreInfo ( )

Get datastore information.

Returns
array
getStoreParams ( )

Get datastore params.

Returns
array
getStoreType ( )

Get datastore dijit type.

Returns
string|null
isValid (   $value,
  $context = null 
)

Is the value valid?

Parameters
string$value
mixed$context
Returns
bool
setAutocomplete (   $flag)

Set autocomplete flag.

Parameters
bool$flag
Returns
Zend_Dojo_Form_Element_ComboBox
setStoreId (   $identifier)

Set datastore identifier.

Parameters
string$identifier
Returns
Zend_Dojo_Form_Element_ComboBox
setStoreParams ( array  $params)

Set datastore parameters.

Parameters
array$params
Returns
Zend_Dojo_Form_Element_ComboBox
setStoreType (   $dojoType)

Set datastore dijit type.

Parameters
string$dojoType
Returns
Zend_Dojo_Form_Element_ComboBox

Member Data Documentation

$_registerInArrayValidator = false
protected
$helper = 'ComboBox'