<?php

/*

 * This file is part of the Symfony package.

 *

 * (c) Fabien Potencier <fabien@symfony.com>

 *

 * For the full copyright and license information, please view the LICENSE

 * file that was distributed with this source code.

 */

namespace Symfony\Component\Form;

use Symfony\Component\Form\Exception\FormException;

use Symfony\Component\Form\Exception\UnexpectedTypeException;

use Symfony\Component\Form\Exception\CircularReferenceException;

use Symfony\Component\EventDispatcher\EventDispatcherInterface;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class FormBuilder

{

    /**

     * @var string

     */

    private $name;

    /**

     * The form data in application format

     * @var mixed

     */

    private $appData;

    /**

     * The event dispatcher

     *

     * @var EventDispatcherInterface

     */

    private $dispatcher;

    /**

     * The form factory

     * @var FormFactoryInterface

     */

    private $factory;

    /**

     * @var Boolean

     */

    private $readOnly;

    /**

     * @var Boolean

     */

    private $required;

    /**

     * The transformers for transforming from normalized to client format and

     * back

     * @var array An array of DataTransformerInterface

     */

    private $clientTransformers = array();

    /**

     * The transformers for transforming from application to normalized format

     * and back

     * @var array An array of DataTransformerInterface

     */

    private $normTransformers = array();

    /**

     * @var array An array of FormValidatorInterface

     */

    private $validators = array();

    /**

     * Key-value store for arbitrary attributes attached to the form

     * @var array

     */

    private $attributes = array();

    /**

     * @var array An array of FormTypeInterface

     */

    private $types = array();

    /**

     * @var string

     */

    private $dataClass;

    /**

     * The children of the form

     * @var array

     */

    private $children = array();

    /**

     * @var DataMapperInterface

     */

    private $dataMapper;

    /**

     * Whether added errors should bubble up to the parent

     * @var Boolean

     */

    private $errorBubbling = false;

    /**

     * Data used for the client data when no value is bound

     * @var mixed

     */

    private $emptyData = '';

    private $currentLoadingType;

    /**

     * Constructor.

     *

     * @param string                    $name

     * @param FormFactoryInterface      $factory

     * @param EventDispatcherInterface  $dispatcher

     * @param string                    $dataClass

     */

    public function __construct($name, FormFactoryInterface $factory, EventDispatcherInterface $dispatcher, $dataClass = null)

    {

        $this->name = $name;

        $this->factory = $factory;

        $this->dispatcher = $dispatcher;

        $this->dataClass = $dataClass;

    }

    /**

     * Returns the associated form factory.

     *

     * @return FormFactoryInterface The factory

     */

    public function getFormFactory()

    {

        return $this->factory;

    }

    /**

     * Returns the name of the form.

     *

     * @return string The form name

     */

    public function getName()

    {

        return $this->name;

    }

    /**

     * Updates the field with default data.

     *

     * @param array $appData The data formatted as expected for the underlying object

     *

     * @return FormBuilder The current builder

     */

    public function setData($appData)

    {

        $this->appData = $appData;

        return $this;

    }

    /**

     * Returns the data in the format needed for the underlying object.

     *

     * @return mixed

     */

    public function getData()

    {

        return $this->appData;

    }

    /**

     * Set whether the form is read only

     *

     * @param Boolean $readOnly Whether the form is read only

     *

     * @return FormBuilder The current builder

     */

    public function setReadOnly($readOnly)

    {

        $this->readOnly = (Boolean) $readOnly;

        return $this;

    }

    /**

     * Returns whether the form is read only.

     *

     * @return Boolean Whether the form is read only

     */

    public function getReadOnly()

    {

        return $this->readOnly;

    }

    /**

     * Sets whether this field is required to be filled out when bound.

     *

     * @param Boolean $required

     *

     * @return FormBuilder The current builder

     */

    public function setRequired($required)

    {

        $this->required = (Boolean) $required;

        return $this;

    }

    /**

     * Returns whether this field is required to be filled out when bound.

     *

     * @return Boolean Whether this field is required

     */

    public function getRequired()

    {

        return $this->required;

    }

    /**

     * Sets whether errors bubble up to the parent.

     *

     * @param type $errorBubbling

     *

     * @return FormBuilder The current builder

     */

    public function setErrorBubbling($errorBubbling)

    {

        $this->errorBubbling = (Boolean) $errorBubbling;

        return $this;

    }

    /**

     * Returns whether errors bubble up to the parent.

     *

     * @return Boolean

     */

    public function getErrorBubbling()

    {

        return $this->errorBubbling;

    }

    /**

     * Adds a validator to the form.

     *

     * @param FormValidatorInterface $validator The validator

     *

     * @return FormBuilder The current builder

     */

    public function addValidator(FormValidatorInterface $validator)

    {

        $this->validators[] = $validator;

        return $this;

    }

    /**

     * Returns the validators used by the form.

     *

     * @return array An array of FormValidatorInterface

     */

    public function getValidators()

    {

        return $this->validators;

    }

    /**

     * Adds an event listener for events on this field

     *

     * @see Symfony\Component\EventDispatcher\EventDispatcherInterface::addListener

     *

     * @return FormBuilder The current builder

     */

    public function addEventListener($eventName, $listener, $priority = 0)

    {

        $this->dispatcher->addListener($eventName, $listener, $priority);

        return $this;

    }

    /**

     * Adds an event subscriber for events on this field

     *

     * @see Symfony\Component\EventDispatcher\EventDispatcherInterface::addSubscriber

     *

     * @return FormBuilder The current builder

     */

    public function addEventSubscriber(EventSubscriberInterface $subscriber)

    {

        $this->dispatcher->addSubscriber($subscriber);

        return $this;

    }

    /**

     * Appends a transformer to the normalization transformer chain

     *

     * @param DataTransformerInterface $clientTransformer

     *

     * @return FormBuilder The current builder

     */

    public function appendNormTransformer(DataTransformerInterface $normTransformer)

    {

        $this->normTransformers[] = $normTransformer;

        return $this;

    }

    /**

     * Prepends a transformer to the client transformer chain

     *

     * @param DataTransformerInterface $normTransformer

     *

     * @return FormBuilder The current builder

     */

    public function prependNormTransformer(DataTransformerInterface $normTransformer)

    {

        array_unshift($this->normTransformers, $normTransformer);

        return $this;

    }

    /**

     * Clears the normalization transformers.

     *

     * @return FormBuilder The current builder

     */

    public function resetNormTransformers()

    {

        $this->normTransformers = array();

        return $this;

    }

    /**

     * Returns all the normalization transformers.

     *

     * @return array An array of DataTransformerInterface

     */

    public function getNormTransformers()

    {

        return $this->normTransformers;

    }

    /**

     * Appends a transformer to the client transformer chain

     *

     * @param DataTransformerInterface $clientTransformer

     *

     * @return FormBuilder The current builder

     */

    public function appendClientTransformer(DataTransformerInterface $clientTransformer)

    {

        $this->clientTransformers[] = $clientTransformer;

        return $this;

    }

    /**

     * Prepends a transformer to the client transformer chain

     *

     * @param DataTransformerInterface $clientTransformer

     *

     * @return FormBuilder The current builder

     */

    public function prependClientTransformer(DataTransformerInterface $clientTransformer)

    {

        array_unshift($this->clientTransformers, $clientTransformer);

        return $this;

    }

    /**

     * Clears the client transformers.

     *

     * @return FormBuilder The current builder

     */

    public function resetClientTransformers()

    {

        $this->clientTransformers = array();

        return $this;

    }

    /**

     * Returns all the client transformers.

     *

     * @return array An array of DataTransformerInterface

     */

    public function getClientTransformers()

    {

        return $this->clientTransformers;

    }

    /**

     * Sets the value for an attribute.

     *

     * @param string $name  The name of the attribute

     * @param string $value The value of the attribute

     *

     * @return FormBuilder The current builder

     */

    public function setAttribute($name, $value)

    {

        $this->attributes[$name] = $value;

        return $this;

    }

    /**

     * Returns the value of the attributes with the given name.

     *

     * @param string $name The name of the attribute

     */

    public function getAttribute($name)

    {

        return $this->attributes[$name];

    }

    /**

     * Returns whether the form has an attribute with the given name.

     *

     * @param string $name The name of the attribute

     */

    public function hasAttribute($name)

    {

        return isset($this->attributes[$name]);

    }

    /**

     * Returns all the attributes.

     *

     * @return array An array of attributes

     */

    public function getAttributes()

    {

        return $this->attributes;

    }

    /**

     * Sets the data mapper used by the form.

     *

     * @param DataMapperInterface $dataMapper

     *

     * @return FormBuilder The current builder

     */

    public function setDataMapper(DataMapperInterface $dataMapper)

    {

        $this->dataMapper = $dataMapper;

        return $this;

    }

    /**

     * Returns the data mapper used by the form.

     *

     * @return array An array of DataMapperInterface

     */

    public function getDataMapper()

    {

        return $this->dataMapper;

    }

    /**

     * Set the types.

     *

     * @param array $types An array FormTypeInterface

     *

     * @return FormBuilder The current builder