tweet_live: comparison web/lib/Zend/Form.php

equal deleted inserted replaced

-:5a6b6e770365
+:68c69c656a2c
 * 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
 * @package    Zend_Form
-* @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+* @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
 /** @see Zend_Validate_Interface */
 require_once 'Zend/Validate/Interface.php';
 /**
 * Zend_Form
 *
 * @category   Zend
 * @package    Zend_Form
-* @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
+* @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
-* @version    $Id: Form.php 25223 2013-01-17 14:44:54Z frosch $
+* @version    $Id$
 */
 class Zend_Form implements Iterator, Countable, Zend_Validate_Interface
 {
 /**#@+
 * Plugin loader type constants
 * Constructor
 *
 * Registers form view helper as decorator
 *
 * @param mixed $options
-* @return void
 */
 public function __construct($options = null)
 {
 if (is_array($options)) {
 $this->setOptions($options);
 }
 $this->setSubForms($subForms);
 $displayGroups = array();
 foreach ($this->_displayGroups as $group)  {
+/** @var Zend_Form_DisplayGroup $clone */
 $clone    = clone $group;
 $elements = array();
 foreach ($clone->getElements() as $name => $e) {
 $elements[] = $this->getElement($name);
 }
 *
 * @return Zend_Form
 */
 public function reset()
 {
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $element) {
 $element->setValue(null);
 }
+/** @var Zend_Form_SubForm $subForm */
 foreach ($this->getSubForms() as $subForm) {
 $subForm->reset();
 }
 return $this;
 * If a plugin loader does not exist for the given type, defaults are
 * created.
 *
 * @param  string $type
 * @return Zend_Loader_PluginLoader_Interface
+* @throws Zend_Form_Exception
 */
 public function getPluginLoader($type = null)
 {
 $type = strtoupper($type);
 if (!isset($this->_loaders[$type])) {
 'prefix' => $prefix,
 'path'   => $path,
 'type'   => $type,
 );
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $element) {
 $element->addPrefixPath($prefix, $path, $type);
 }
+/** @var Zend_Form_SubForm $subForm */
 foreach ($this->getSubForms() as $subForm) {
 $subForm->addElementPrefixPath($prefix, $path, $type);
 }
 return $this;
 */
 public function addElementPrefixPaths(array $spec)
 {
 $this->_elementPrefixPaths = $this->_elementPrefixPaths + $spec;
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $element) {
 $element->addPrefixPaths($spec);
 }
 return $this;
 $this->_displayGroupPrefixPaths[] = array(
 'prefix' => $prefix,
 'path'   => $path,
 );
+/** @var Zend_Form_DisplayGroup $group */
 foreach ($this->getDisplayGroups() as $group) {
 $group->addPrefixPath($prefix, $path);
 }
 return $this;
 /**
 * Set form name
 *
 * @param  string $name
 * @return Zend_Form
+* @throws Zend_Form_Exception
 */
 public function setName($name)
 {
 $name = $this->filterName($name);
 if ('' === (string)$name) {
 * Acts as a factory for creating elements. Elements created with this
 * method will not be attached to the form, but will contain element
 * settings as specified in the form object (including plugin loader
 * prefix paths, default decorators, etc.).
 *
-* @param  string $type
+* @param  string            $type
-* @param  string $name
+* @param  string            $name
 * @param  array|Zend_Config $options
+* @throws Zend_Form_Exception
 * @return Zend_Form_Element
 */
 public function createElement($type, $name, $options = null)
 {
 if (!is_string($type)) {
 unset($this->_elements[$name]);
 if (array_key_exists($name, $this->_order)) {
 unset($this->_order[$name]);
 $this->_orderUpdated = true;
 } else {
+/** @var Zend_Form_DisplayGroup $group */
 foreach ($this->_displayGroups as $group) {
 if (null !== $group->getElement($name)) {
 $group->removeElement($name);
 }
 }
 if ($this->isArray()) {
 $eBelongTo = $this->getElementsBelongTo();
 $defaults = $this->_dissolveArrayValue($defaults, $eBelongTo);
 }
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $name => $element) {
 $check = $defaults;
 if (($belongsTo = $element->getBelongsTo()) !== $eBelongTo) {
 $check = $this->_dissolveArrayValue($defaults, $belongsTo);
 }
 if (array_key_exists($name, $check)) {
 $this->setDefault($name, $check[$name]);
 $defaults = $this->_dissolveArrayUnsetKey($defaults, $belongsTo, $name);
 }
 }
+/** @var Zend_Form_SubForm $form */
 foreach ($this->getSubForms() as $name => $form) {
 if (!$form->isArray() && array_key_exists($name, $defaults)) {
 $form->setDefaults($defaults[$name]);
 } else {
 $form->setDefaults($defaults);
 $name = (string) $name;
 if ($element = $this->getElement($name)) {
 $element->setValue($value);
 } else {
 if (is_scalar($value)) {
+/** @var Zend_Form_SubForm $subForm */
 foreach ($this->getSubForms() as $subForm) {
 $subForm->setDefault($name, $value);
 }
 } elseif (is_array($value) && ($subForm = $this->getSubForm($name))) {
 $subForm->setDefaults($value);
 if ($subForm = $this->getSubForm($name)) {
 return $subForm->getValues(true);
 }
+/** @var Zend_Form_SubForm $subForm */
 foreach ($this->getSubForms() as $subForm) {
 if ($name == $subForm->getElementsBelongTo()) {
 return $subForm->getValues(true);
 }
 }
 $eBelongTo = null;
 if ($this->isArray()) {
 $eBelongTo = $this->getElementsBelongTo();
 }
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $key => $element) {
 if (!$element->getIgnore()) {
 $merge = array();
 if (($belongsTo = $element->getBelongsTo()) !== $eBelongTo) {
 if ('' !== (string)$belongsTo) {
 }
 $merge = $this->_attachToArray($element->getValue(), $key);
 $values = $this->_array_replace_recursive($values, $merge);
 }
 }
+/** @var Zend_Form_SubForm $subForm */
 foreach ($this->getSubForms() as $key => $subForm) {
 $merge = array();
 if (!$subForm->isArray()) {
 $merge[$key] = $subForm->getValues();
 } else {
 if ($this->isArray()) {
 $eBelongTo = $this->getElementsBelongTo();
 $data = $this->_dissolveArrayValue($data, $eBelongTo);
 }
 $context = $data;
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $key => $element) {
 if (!$element->getIgnore()) {
 $check = $data;
 if (($belongsTo = $element->getBelongsTo()) !== $eBelongTo) {
 $check = $this->_dissolveArrayValue($data, $belongsTo);
 }
 $data = $this->_dissolveArrayUnsetKey($data, $belongsTo, $key);
 }
 }
 }
+/** @var Zend_Form_SubForm $form */
 foreach ($this->getSubForms() as $key => $form) {
 $merge = array();
 if (isset($data[$key]) && !$form->isArray()) {
 $tmp = $form->getValidValues($data[$key]);
 if (!empty($tmp)) {
 * @return array
 */
 public function getUnfilteredValues()
 {
 $values = array();
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $key => $element) {
 $values[$key] = $element->getUnfilteredValue();
 }
 return $values;
 * @param  array $filters
 * @return Zend_Form
 */
 public function setElementFilters(array $filters)
 {
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $element) {
 $element->setFilters($filters);
 }
 return $this;
 }
 if (null === $array) {
 return;
 }
 if (null === $name) {
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $element) {
 $element->setBelongsTo($array);
 }
 } else {
 if (null !== ($element = $this->getElement($name))) {
 * @return Zend_Form
 */
 public function addSubForm(Zend_Form $form, $name, $order = null)
 {
 $name = (string) $name;
+/** @var Zend_Loader_PluginLoader $loader */
 foreach ($this->_loaders as $type => $loader) {
 $loaderPaths = $loader->getPaths();
 foreach ($loaderPaths as $prefix => $paths) {
 foreach ($paths as $path) {
 $form->addPrefixPath($prefix, $path, $type);
 /**
 * Add a display group object (used with cloning)
 *
 * @param  Zend_Form_DisplayGroup $group
-* @param  string|null $name
+* @param  string|null            $name
+* @throws Zend_Form_Exception
 * @return Zend_Form
 */
 protected function _addDisplayGroupObject(Zend_Form_DisplayGroup $group, $name = null)
 {
 if (null === $name) {
 */
 public function removeDisplayGroup($name)
 {
 $name = (string) $name;
 if (array_key_exists($name, $this->_displayGroups)) {
+/** @var Zend_Form_Element $element */
 foreach ($this->_displayGroups[$name] as $key => $element) {
 if (array_key_exists($key, $this->_elements)) {
 $this->_order[$key]  = $element->getOrder();
 $this->_orderUpdated = true;
 }
 {
 foreach ($this->_displayGroups as $key => $group) {
 if (array_key_exists($key, $this->_order)) {
 unset($this->_order[$key]);
 }
+/** @var Zend_Form_Element $element */
 foreach ($group as $name => $element) {
 if (isset($this->_elements[$name])) {
 $this->_order[$name] = $element->getOrder();
 }
 $this->_order[$name] = $element->getOrder();
 if ($this->$name instanceof Zend_Form_Element ||
 $this->$name instanceof Zend_Form) {
 array_splice($ordered, $order, 0, array($this->$name));
 } else if ($this->$name instanceof Zend_Form_DisplayGroup) {
 $subordered = array();
+/** @var Zend_Form_Element $element */
 foreach ($this->$name->getElements() as $element) {
 $suborder = $element->getOrder();
 $suborder = (null !== $suborder) ? $suborder : count($subordered);
 array_splice($subordered, $suborder, 0, array($element));
 }
 /**
 * This is a helper function until php 5.3 is widespreaded
 *
 * @param array $into
-* @access protected
+* @return array
-* @return void
 */
 protected function _array_replace_recursive(array $into)
 {
 $fromArrays = array_slice(func_get_args(),1);
 /**
 * Validate the form
 *
 * @param  array $data
-* @return boolean
+* @throws Zend_Form_Exception
+* @return bool
 */
 public function isValid($data)
 {
 if (!is_array($data)) {
 require_once 'Zend/Form/Exception.php';
 if ($this->isArray()) {
 $eBelongTo = $this->getElementsBelongTo();
 $data = $this->_dissolveArrayValue($data, $eBelongTo);
 }
 $context = $data;
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $key => $element) {
 if (null !== $translator && $this->hasTranslator()
 && !$element->hasTranslator()) {
 $element->setTranslator($translator);
 }
 } else {
 $valid = $element->isValid($check[$key], $context) && $valid;
 $data = $this->_dissolveArrayUnsetKey($data, $belongsTo, $key);
 }
 }
+/** @var Zend_Form_SubForm $form */
 foreach ($this->getSubForms() as $key => $form) {
 if (null !== $translator && $this->hasTranslator()
 && !$form->hasTranslator()) {
 $form->setTranslator($translator);
 }
 $translator = $this->getTranslator();
 $valid      = true;
 $context    = $data;
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $key => $element) {
 $check = $data;
 if (($belongsTo = $element->getBelongsTo()) !== $eBelongTo) {
 $check = $this->_dissolveArrayValue($data, $belongsTo);
 }
 }
 $valid = $element->isValid($check[$key], $context) && $valid;
 $data = $this->_dissolveArrayUnsetKey($data, $belongsTo, $key);
 }
 }
+/** @var Zend_Form_SubForm $form */
 foreach ($this->getSubForms() as $key => $form) {
 if (null !== $translator && !$form->hasTranslator()) {
 $form->setTranslator($translator);
 }
 if (isset($data[$key]) && !$form->isArray()) {
 *
 * @return bool
 */
 public function hasErrors()
 {
-return $this->_errorsExist;
+$errors = $this->_errorsExist;
+if (!$errors) {
+/** @var Zend_Form_Element $element */
+foreach ($this->getElements() as $element) {
+if ($element->hasErrors()) {
+$errors = true;
+break;
+}
+}
+/** @var Zend_Form_SubForm $subForm */
+foreach ($this->getSubForms() as $subForm) {
+if ($subForm->hasErrors()) {
+$errors = true;
+break;
+}
+}
+}
+return $errors;
 }
 /**
 * Get error codes for all elements failing validation
 *
 * @param  string $name
+* @param  bool   $suppressArrayNotation
 * @return array
 */
 public function getErrors($name = null, $suppressArrayNotation = false)
 {
 $errors = array();
 } else if (isset($this->_subForms[$name])) {
 return $this->getSubForm($name)->getErrors(null, true);
 }
 }
+/** @var Zend_Form_Element $element */
 foreach ($this->_elements as $key => $element) {
 $errors[$key] = $element->getErrors();
 }
+/** @var Zend_Form_SubForm $subForm */
 foreach ($this->getSubForms() as $key => $subForm) {
 $merge = array();
 if (!$subForm->isArray()) {
 $merge[$key] = $subForm->getErrors();
 } else {
 if (isset($this->_elements[$name])) {
 return $this->getElement($name)->getMessages();
 } else if (isset($this->_subForms[$name])) {
 return $this->getSubForm($name)->getMessages(null, true);
 }
+/** @var Zend_Form_SubForm $subForm */
 foreach ($this->getSubForms() as $key => $subForm) {
 if ($subForm->isArray()) {
 $belongTo = $subForm->getElementsBelongTo();
 if ($name == $this->_getArrayName($belongTo)) {
 return $subForm->getMessages(null, true);
 return $customMessages;
 }
 $messages = array();
+/** @var Zend_Form_Element $element */
 foreach ($this->getElements() as $name => $element) {
 $eMessages = $element->getMessages();
 if (!empty($eMessages)) {
 $messages[$name] = $eMessages;
 }
 }
+/** @var Zend_Form_SubForm $subForm */
 foreach ($this->getSubForms() as $key => $subForm) {
 $merge = $subForm->getMessages(null, true);
 if (!empty($merge)) {
 if (!$subForm->isArray()) {
 $merge = array($key => $merge);
 /**
 * Add a decorator for rendering the element
 *
 * @param  string|Zend_Form_Decorator_Interface $decorator
-* @param  array|Zend_Config $options Options with which to initialize decorator
+* @param  array|Zend_Config                    $options Options with which to initialize decorator
+* @throws Zend_Form_Exception
 * @return Zend_Form
 */
 public function addDecorator($decorator, $options = null)
 {
 if ($decorator instanceof Zend_Form_Decorator_Interface) {
 /**
 * Add many decorators at once
 *
 * @param  array $decorators
+* @throws Zend_Form_Exception
 * @return Zend_Form
 */
 public function addDecorators(array $decorators)
 {
 foreach ($decorators as $decoratorName => $decoratorInfo) {
 }
 } else {
 $elementObjs = $this->getElements();
 }
+/** @var Zend_Form_Element $element */
 foreach ($elementObjs as $element) {
 $element->setDecorators($decorators);
 }
 $this->_elementDecorators = $decorators;
 * @param  array $decorators
 * @return Zend_Form
 */
 public function setDisplayGroupDecorators(array $decorators)
 {
+/** @var Zend_Form_DisplayGroup $group */
 foreach ($this->getDisplayGroups() as $group) {
 $group->setDecorators($decorators);
 }
 return $this;
 * @param  array $decorators
 * @return Zend_Form
 */
 public function setSubFormDecorators(array $decorators)
 {
+/** @var Zend_Form_SubForm $form */
 foreach ($this->getSubForms() as $form) {
 $form->setDecorators($decorators);
 }
 return $this;
 if (null !== $view) {
 $this->setView($view);
 }
 $content = '';
+/** @var Zend_Form_Decorator_Abstract $decorator */
 foreach ($this->getDecorators() as $decorator) {
 $decorator->setElement($this);
 $content = $decorator->render($content);
 }
 $this->_setIsRendered();
 /**
 * Set translator object
 *
 * @param  Zend_Translate|Zend_Translate_Adapter|null $translator
+* @throws Zend_Form_Exception
 * @return Zend_Form
 */
 public function setTranslator($translator = null)
 {
 if (null === $translator) {
 /**
 * Set global default translator object
 *
 * @param  Zend_Translate|Zend_Translate_Adapter|null $translator
+* @throws Zend_Form_Exception
 * @return void
 */
 public static function setDefaultTranslator($translator = null)
 {
 if (null === $translator) {
 // Interfaces: Iterator, Countable
 /**
 * Current element/subform/display group
 *
+* @throws Zend_Form_Exception
 * @return Zend_Form_Element|Zend_Form_DisplayGroup|Zend_Form
 */
 public function current()
 {
 $this->_sort();
 }
 /**
 * Sort items according to their order
 *
+* @throws Zend_Form_Exception
 * @return void
 */
 protected function _sort()
 {
 if ($this->_orderUpdated) {
 $items[$index] = $key;
 ++$index;
 } else {
 $items[$order] = $key;
 }
+} elseif (isset($items[$order]) && $items[$order] !== $key) {
+throw new Zend_Form_Exception('Form elements ' .
+$items[$order] . ' and ' . $key .
+' have the same order (' .
+$order . ') - ' .
+'this would result in only the last added element to be rendered'
+);
 } else {
 $items[$order] = $key;
 }
 }

changeset 1230	68c69c656a2c
parent 807	877f952ae2bd