web/Zend/Form/Element/Multi.php
changeset 0 4eba9c11703f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/web/Zend/Form/Element/Multi.php	Mon Dec 13 18:29:26 2010 +0100
@@ -0,0 +1,317 @@
+<?php
+/**
+ * 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
+ * @package    Zend_Form
+ * @subpackage Element
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+/** Zend_Form_Element_Xhtml */
+require_once 'Zend/Form/Element/Xhtml.php';
+
+/**
+ * Base class for multi-option form elements
+ *
+ * @category   Zend
+ * @package    Zend_Form
+ * @subpackage Element
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id: Multi.php 22322 2010-05-30 11:12:57Z thomas $
+ */
+abstract class Zend_Form_Element_Multi extends Zend_Form_Element_Xhtml
+{
+    /**
+     * Array of options for multi-item
+     * @var array
+     */
+    public $options = array();
+
+    /**
+     * Flag: autoregister inArray validator?
+     * @var bool
+     */
+    protected $_registerInArrayValidator = true;
+
+    /**
+     * Separator to use between options; defaults to '<br />'.
+     * @var string
+     */
+    protected $_separator = '<br />';
+
+    /**
+     * Which values are translated already?
+     * @var array
+     */
+    protected $_translated = array();
+
+    /**
+     * Retrieve separator
+     *
+     * @return mixed
+     */
+    public function getSeparator()
+    {
+        return $this->_separator;
+    }
+
+    /**
+     * Set separator
+     *
+     * @param mixed $separator
+     * @return self
+     */
+    public function setSeparator($separator)
+    {
+        $this->_separator = $separator;
+        return $this;
+    }
+
+    /**
+     * Retrieve options array
+     *
+     * @return array
+     */
+    protected function _getMultiOptions()
+    {
+        if (null === $this->options || !is_array($this->options)) {
+            $this->options = array();
+        }
+
+        return $this->options;
+    }
+
+    /**
+     * Add an option
+     *
+     * @param  string $option
+     * @param  string $value
+     * @return Zend_Form_Element_Multi
+     */
+    public function addMultiOption($option, $value = '')
+    {
+        $option  = (string) $option;
+        $this->_getMultiOptions();
+        if (!$this->_translateOption($option, $value)) {
+            $this->options[$option] = $value;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Add many options at once
+     *
+     * @param  array $options
+     * @return Zend_Form_Element_Multi
+     */
+    public function addMultiOptions(array $options)
+    {
+        foreach ($options as $option => $value) {
+            if (is_array($value)
+                && array_key_exists('key', $value)
+                && array_key_exists('value', $value)
+            ) {
+                $this->addMultiOption($value['key'], $value['value']);
+            } else {
+                $this->addMultiOption($option, $value);
+            }
+        }
+        return $this;
+    }
+
+    /**
+     * Set all options at once (overwrites)
+     *
+     * @param  array $options
+     * @return Zend_Form_Element_Multi
+     */
+    public function setMultiOptions(array $options)
+    {
+        $this->clearMultiOptions();
+        return $this->addMultiOptions($options);
+    }
+
+    /**
+     * Retrieve single multi option
+     *
+     * @param  string $option
+     * @return mixed
+     */
+    public function getMultiOption($option)
+    {
+        $option  = (string) $option;
+        $this->_getMultiOptions();
+        if (isset($this->options[$option])) {
+            $this->_translateOption($option, $this->options[$option]);
+            return $this->options[$option];
+        }
+
+        return null;
+    }
+
+    /**
+     * Retrieve options
+     *
+     * @return array
+     */
+    public function getMultiOptions()
+    {
+        $this->_getMultiOptions();
+        foreach ($this->options as $option => $value) {
+            $this->_translateOption($option, $value);
+        }
+        return $this->options;
+    }
+
+    /**
+     * Remove a single multi option
+     *
+     * @param  string $option
+     * @return bool
+     */
+    public function removeMultiOption($option)
+    {
+        $option  = (string) $option;
+        $this->_getMultiOptions();
+        if (isset($this->options[$option])) {
+            unset($this->options[$option]);
+            if (isset($this->_translated[$option])) {
+                unset($this->_translated[$option]);
+            }
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Clear all options
+     *
+     * @return Zend_Form_Element_Multi
+     */
+    public function clearMultiOptions()
+    {
+        $this->options = array();
+        $this->_translated = array();
+        return $this;
+    }
+
+    /**
+     * Set flag indicating whether or not to auto-register inArray validator
+     *
+     * @param  bool $flag
+     * @return Zend_Form_Element_Multi
+     */
+    public function setRegisterInArrayValidator($flag)
+    {
+        $this->_registerInArrayValidator = (bool) $flag;
+        return $this;
+    }
+
+    /**
+     * Get status of auto-register inArray validator flag
+     *
+     * @return bool
+     */
+    public function registerInArrayValidator()
+    {
+        return $this->_registerInArrayValidator;
+    }
+
+    /**
+     * Is the value provided valid?
+     *
+     * Autoregisters InArray validator if necessary.
+     *
+     * @param  string $value
+     * @param  mixed $context
+     * @return bool
+     */
+    public function isValid($value, $context = null)
+    {
+        if ($this->registerInArrayValidator()) {
+            if (!$this->getValidator('InArray')) {
+                $multiOptions = $this->getMultiOptions();
+                $options      = array();
+
+                foreach ($multiOptions as $opt_value => $opt_label) {
+                    // optgroup instead of option label
+                    if (is_array($opt_label)) {
+                        $options = array_merge($options, array_keys($opt_label));
+                    }
+                    else {
+                        $options[] = $opt_value;
+                    }
+                }
+
+                $this->addValidator(
+                    'InArray',
+                    true,
+                    array($options)
+                );
+            }
+        }
+        return parent::isValid($value, $context);
+    }
+
+    /**
+     * Translate an option
+     *
+     * @param  string $option
+     * @param  string $value
+     * @return bool
+     */
+    protected function _translateOption($option, $value)
+    {
+        if ($this->translatorIsDisabled()) {
+            return false;
+        }
+
+        if (!isset($this->_translated[$option]) && !empty($value)) {
+            $this->options[$option] = $this->_translateValue($value);
+            if ($this->options[$option] === $value) {
+                return false;
+            }
+            $this->_translated[$option] = true;
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Translate a multi option value
+     *
+     * @param  string $value
+     * @return string
+     */
+    protected function _translateValue($value)
+    {
+        if (is_array($value)) {
+            foreach ($value as $key => $val) {
+                $value[$key] = $this->_translateValue($val);
+            }
+            return $value;
+        } else {
+            if (null !== ($translator = $this->getTranslator())) {
+                return $translator->translate($value);
+            }
+
+            return $value;
+        }
+    }
+}