<?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

 * @copyright  Copyright (c) 2005-2010 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-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Form.php 23429 2010-11-22 23:06:46Z bittarman $

 */

class Zend_Form implements Iterator, Countable, Zend_Validate_Interface

{

    /**#@+

     * Plugin loader type constants

     */

    const DECORATOR = 'DECORATOR';

    const ELEMENT = 'ELEMENT';

    /**#@-*/

    /**#@+

     * Method type constants

     */

    const METHOD_DELETE = 'delete';

    const METHOD_GET    = 'get';

    const METHOD_POST   = 'post';

    const METHOD_PUT    = 'put';

    /**#@-*/

    /**#@+

     * Encoding type constants

     */

    const ENCTYPE_URLENCODED = 'application/x-www-form-urlencoded';

    const ENCTYPE_MULTIPART  = 'multipart/form-data';

    /**#@-*/

    /**

     * Form metadata and attributes

     * @var array

     */

    protected $_attribs = array();

    /**

     * Decorators for rendering

     * @var array

     */

    protected $_decorators = array();

    /**

     * Default display group class

     * @var string

     */

    protected $_defaultDisplayGroupClass = 'Zend_Form_DisplayGroup';

    /**

     * Form description

     * @var string

     */

    protected $_description;

    /**

     * Should we disable loading the default decorators?

     * @var bool

     */

    protected $_disableLoadDefaultDecorators = false;

    /**

     * Display group prefix paths

     * @var array

     */

    protected $_displayGroupPrefixPaths = array();

    /**

     * Groups of elements grouped for display purposes

     * @var array

     */

    protected $_displayGroups = array();

    /**

     * Global decorators to apply to all elements

     * @var null|array

     */

    protected $_elementDecorators;

    /**

     * Prefix paths to use when creating elements

     * @var array

     */

    protected $_elementPrefixPaths = array();

    /**

     * Form elements

     * @var array

     */

    protected $_elements = array();

    /**

     * Array to which elements belong (if any)

     * @var string

     */

    protected $_elementsBelongTo;

    /**

     * Custom form-level error messages

     * @var array

     */

    protected $_errorMessages = array();

    /**

     * Are there errors in the form?

     * @var bool

     */

    protected $_errorsExist = false;

    /**

     * Has the form been manually flagged as an error?

     * @var bool

     */

    protected $_errorsForced = false;

    /**

     * Form order

     * @var int|null

     */

    protected $_formOrder;

    /**

     * Whether or not form elements are members of an array

     * @var bool

     */

    protected $_isArray = false;

    /**

     * Form legend

     * @var string

     */

    protected $_legend;

    /**

     * Plugin loaders

     * @var array

     */

    protected $_loaders = array();

    /**

     * Allowed form methods

     * @var array

     */

    protected $_methods = array('delete', 'get', 'post', 'put');

    /**

     * Order in which to display and iterate elements

     * @var array

     */

    protected $_order = array();

    /**

     * Whether internal order has been updated or not

     * @var bool

     */

    protected $_orderUpdated = false;

    /**

     * Sub form prefix paths

     * @var array

     */

    protected $_subFormPrefixPaths = array();

    /**

     * Sub forms

     * @var array

     */

    protected $_subForms = array();

    /**

     * @var Zend_Translate

     */

    protected $_translator;

    /**

     * Global default translation adapter

     * @var Zend_Translate

     */

    protected static $_translatorDefault;

    /**

     * is the translator disabled?

     * @var bool

     */

    protected $_translatorDisabled = false;

    /**

     * @var Zend_View_Interface

     */

    protected $_view;

    /**

     * @var bool

     */

    protected $_isRendered = false;

    /**

     * Constructor

     *

     * Registers form view helper as decorator

     *

     * @param mixed $options

     * @return void

     */

    public function __construct($options = null)

    {

        if (is_array($options)) {

            $this->setOptions($options);

        } elseif ($options instanceof Zend_Config) {

            $this->setConfig($options);

        }

        // Extensions...

        $this->init();

        $this->loadDefaultDecorators();

    }

    /**

     * Clone form object and all children

     *

     * @return void

     */

    public function __clone()

    {

        $elements = array();

        foreach ($this->getElements() as $name => $element) {

            $elements[] = clone $element;

        }

        $this->setElements($elements);

        $subForms = array();

        foreach ($this->getSubForms() as $name => $subForm) {

            $subForms[$name] = clone $subForm;

        }

        $this->setSubForms($subForms);

        $displayGroups = array();

        foreach ($this->_displayGroups as $group)  {

            $clone    = clone $group;

            $elements = array();

            foreach ($clone->getElements() as $name => $e) {

                $elements[] = $this->getElement($name);

            }

            $clone->setElements($elements);

            $displayGroups[] = $clone;

        }

        $this->setDisplayGroups($displayGroups);

    }

    /**

     * Reset values of form

     *

     * @return Zend_Form

     */

    public function reset()

    {

        foreach ($this->getElements() as $element) {

            $element->setValue(null);

        }

        foreach ($this->getSubForms() as $subForm) {

            $subForm->reset();

        }

        return $this;

    }

    /**

     * Initialize form (used by extending classes)

     *

     * @return void

     */

    public function init()

    {

    }

    /**

     * Set form state from options array

     *

     * @param  array $options

     * @return Zend_Form

     */

    public function setOptions(array $options)

    {

        if (isset($options['prefixPath'])) {

            $this->addPrefixPaths($options['prefixPath']);

            unset($options['prefixPath']);

        }

        if (isset($options['elementPrefixPath'])) {

            $this->addElementPrefixPaths($options['elementPrefixPath']);

            unset($options['elementPrefixPath']);

        }

        if (isset($options['displayGroupPrefixPath'])) {

            $this->addDisplayGroupPrefixPaths($options['displayGroupPrefixPath']);

            unset($options['displayGroupPrefixPath']);

        }

        if (isset($options['elementDecorators'])) {

            $this->_elementDecorators = $options['elementDecorators'];

            unset($options['elementDecorators']);

        }

        if (isset($options['elements'])) {

            $this->setElements($options['elements']);

            unset($options['elements']);

        }

        if (isset($options['defaultDisplayGroupClass'])) {

            $this->setDefaultDisplayGroupClass($options['defaultDisplayGroupClass']);

            unset($options['defaultDisplayGroupClass']);

        }

        if (isset($options['displayGroupDecorators'])) {

            $displayGroupDecorators = $options['displayGroupDecorators'];

            unset($options['displayGroupDecorators']);

        }

        if (isset($options['elementsBelongTo'])) {

            $elementsBelongTo = $options['elementsBelongTo'];

            unset($options['elementsBelongTo']);

        }

        if (isset($options['attribs'])) {

            $this->addAttribs($options['attribs']);

            unset($options['attribs']);

        }

        $forbidden = array(

            'Options', 'Config', 'PluginLoader', 'SubForms', 'Translator',

            'Attrib', 'Default',

        );

        foreach ($options as $key => $value) {

            $normalized = ucfirst($key);

            if (in_array($normalized, $forbidden)) {

                continue;

            }

            $method = 'set' . $normalized;

            if (method_exists($this, $method)) {

                if($normalized == 'View' && !($value instanceof Zend_View_Interface)) {

                    continue;

                }

                $this->$method($value);

            } else {

                $this->setAttrib($key, $value);

            }

        }

        if (isset($displayGroupDecorators)) {

            $this->setDisplayGroupDecorators($displayGroupDecorators);

        }

        if (isset($elementsBelongTo)) {

            $this->setElementsBelongTo($elementsBelongTo);

        }

        return $this;

    }

    /**

     * Set form state from config object

     *

     * @param  Zend_Config $config

     * @return Zend_Form

     */

    public function setConfig(Zend_Config $config)

    {

        return $this->setOptions($config->toArray());

    }

    // Loaders

    /**

     * Set plugin loaders for use with decorators and elements

     *

     * @param  Zend_Loader_PluginLoader_Interface $loader

     * @param  string $type 'decorator' or 'element'

     * @return Zend_Form

     * @throws Zend_Form_Exception on invalid type

     */

    public function setPluginLoader(Zend_Loader_PluginLoader_Interface $loader, $type = null)

    {

        $type = strtoupper($type);

        switch ($type) {

            case self::DECORATOR:

            case self::ELEMENT:

                $this->_loaders[$type] = $loader;

                return $this;

            default:

                require_once 'Zend/Form/Exception.php';

                throw new Zend_Form_Exception(sprintf('Invalid type "%s" provided to setPluginLoader()', $type));

        }

    }

    /**

     * Retrieve plugin loader for given type

     *

     * $type may be one of:

     * - decorator

     * - element

     *

     * If a plugin loader does not exist for the given type, defaults are

     * created.

     *

     * @param  string $type

     * @return Zend_Loader_PluginLoader_Interface

     */

    public function getPluginLoader($type = null)

    {

        $type = strtoupper($type);

        if (!isset($this->_loaders[$type])) {

            switch ($type) {

                case self::DECORATOR:

                    $prefixSegment = 'Form_Decorator';

                    $pathSegment   = 'Form/Decorator';

                    break;

                case self::ELEMENT:

                    $prefixSegment = 'Form_Element';

                    $pathSegment   = 'Form/Element';

                    break;

                default:

                    require_once 'Zend/Form/Exception.php';

                    throw new Zend_Form_Exception(sprintf('Invalid type "%s" provided to getPluginLoader()', $type));

            }