symfony/src/Symfony/Component/Form/FormConfigEditorInterface.php

<?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\EventDispatcher\EventSubscriberInterface;

/**
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
interface FormConfigEditorInterface extends FormConfigInterface
{
    /**
     * Adds an event listener to an event on this form.
     *
     * @param string   $eventName The name of the event to listen to.
     * @param callable $listener  The listener to execute.
     * @param integer  $priority  The priority of the listener. Listeners
     *                            with a higher priority are called before
     *                            listeners with a lower priority.
     *
     * @return self The configuration object.
     */
    function addEventListener($eventName, $listener, $priority = 0);

    /**
     * Adds an event subscriber for events on this form.
     *
     * @param EventSubscriberInterface $subscriber The subscriber to attach.
     *
     * @return self The configuration object.
     */
    function addEventSubscriber(EventSubscriberInterface $subscriber);

    /**
     * Adds a validator to the form.
     *
     * @param FormValidatorInterface $validator The validator.
     *
     * @return self The configuration object.
     *
     * @deprecated Deprecated since version 2.1, to be removed in 2.3.
     */
    function addValidator(FormValidatorInterface $validator);

    /**
     * Appends a transformer to the view transformer chain.
     *
     * The transform method of the transformer is used to convert data from the
     * normalized to the view format.
     * The reverseTransform method of the transformer is used to convert from the
     * view to the normalized format.
     *
     * @param DataTransformerInterface $viewTransformer
     *
     * @return self The configuration object.
     */
    function addViewTransformer(DataTransformerInterface $viewTransformer);

    /**
     * Clears the view transformers.
     *
     * @return self The configuration object.
     */
    function resetViewTransformers();

    /**
     * Prepends a transformer to the normalization transformer chain.
     *
     * The transform method of the transformer is used to convert data from the
     * model to the normalized format.
     * The reverseTransform method of the transformer is used to convert from the
     * normalized to the model format.
     *
     * @param DataTransformerInterface $modelTransformer
     *
     * @return self The configuration object.
     */
    function addModelTransformer(DataTransformerInterface $modelTransformer);

    /**
     * Clears the normalization transformers.
     *
     * @return self The configuration object.
     */
    function resetModelTransformers();

    /**
     * Sets the value for an attribute.
     *
     * @param string $name  The name of the attribute
     * @param string $value The value of the attribute
     *
     * @return self The configuration object.
     */
    function setAttribute($name, $value);

    /**
     * Sets the attributes.
     *
     * @param array $attributes The attributes.
     *
     * @return self The configuration object.
     */
    function setAttributes(array $attributes);

    /**
     * Sets the data mapper used by the form.
     *
     * @param  DataMapperInterface $dataMapper
     *
     * @return self The configuration object.
     */
    function setDataMapper(DataMapperInterface $dataMapper = null);

    /**
     * Set whether the form is disabled.
     *
     * @param  Boolean $disabled Whether the form is disabled
     *
     * @return self The configuration object.
     */
    function setDisabled($disabled);

    /**
     * Sets the data used for the client data when no value is bound.
     *
     * @param  mixed $emptyData The empty data.
     *
     * @return self The configuration object.
     */
    function setEmptyData($emptyData);

    /**
     * Sets whether errors bubble up to the parent.
     *
     * @param  Boolean $errorBubbling
     *
     * @return self The configuration object.
     */
    function setErrorBubbling($errorBubbling);

    /**
     * Sets whether this field is required to be filled out when bound.
     *
     * @param Boolean $required
     *
     * @return self The configuration object.
     */
    function setRequired($required);

    /**
     * Sets the property path that the form should be mapped to.
     *
     * @param  string|PropertyPath $propertyPath The property path or null if the path
     *                                           should be set automatically based on
     *                                           the form's name.
     *
     * @return self The configuration object.
     */
    function setPropertyPath($propertyPath);

    /**
     * Sets whether the form should be mapped to an element of its
     * parent's data.
     *
     * @param  Boolean $mapped Whether the form should be mapped.
     *
     * @return self The configuration object.
     */
    function setMapped($mapped);

    /**
     * Sets whether the form's data should be modified by reference.
     *
     * @param  Boolean $byReference Whether the data should be
     * modified by reference.
     *
     * @return self The configuration object.
     */
    function setByReference($byReference);

    /**
     * Sets whether the form should be virtual.
     *
     * @param  Boolean $virtual Whether the form should be virtual.
     *
     * @return self The configuration object.
     */
    function setVirtual($virtual);

    /**
     * Set the types.
     *
     * @param array $types An array FormTypeInterface
     *
     * @return self The configuration object.
     */
    function setTypes(array $types);

    /**
     * Sets the initial data of the form.
     *
     * @param array $data The data of the form in application format.
     *
     * @return self The configuration object.
     */
    function setData($data);
}