Classes List

Symfony\Component\Form\FormConfigBuilderInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
 248 
 249 
 250 
 251 
 252 
 253 
 254 
 255 
 256 
 257 
 258 
 259 
 260 
 261 
 262 
 263 
 264 
 265 
 266 
 267 
 268 
 269 
 270 
 271 
 272 
 273 
 274 
 275 
 276 
<?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;
use Symfony\Component\PropertyAccess\PropertyPathInterface;

/** * @author Bernhard Schussek <bschussek@gmail.com> */
interface FormConfigBuilderInterface 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 int $priority The priority of the listener. Listeners * with a higher priority are called before * listeners with a lower priority. * * @return $this The configuration object */
    public function addEventListener($eventName$listener$priority = 0);

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

    /** * Appends / prepends 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 * @param bool $forcePrepend If set to true, prepend instead of appending * * @return $this The configuration object */
    public function addViewTransformer(DataTransformerInterface $viewTransformer$forcePrepend = false);

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

    /** * Prepends / appends 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 * @param bool $forceAppend If set to true, append instead of prepending * * @return $this The configuration object */
    public function addModelTransformer(DataTransformerInterface $modelTransformer$forceAppend = false);

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

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

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

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

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

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

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

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

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

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

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

    /** * Sets whether the form should read and write the data of its parent. * * @param bool $inheritData Whether the form should inherit its parent's data * * @return $this The configuration object */
    public function setInheritData($inheritData);

    /** * Sets whether the form should be compound. * * @param bool $compound Whether the form should be compound * * @return $this The configuration object * * @see FormConfigInterface::getCompound() */
    public function setCompound($compound);

    /** * Set the types. * * @return $this The configuration object */
    public function setType(ResolvedFormTypeInterface $type);

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

    /** * Locks the form's data to the data passed in the configuration. * * A form with locked data is restricted to the data passed in * this configuration. The data can only be modified then by * submitting the form. * * @param bool $locked Whether to lock the default data * * @return $this The configuration object */
    public function setDataLocked($locked);

    /** * Sets the form factory used for creating new forms. */
    public function setFormFactory(FormFactoryInterface $formFactory);

    /** * Sets the target URL of the form. * * @param string $action The target URL of the form * * @return $this The configuration object */
    public function setAction($action);

    /** * Sets the HTTP method used by the form. * * @param string $method The HTTP method of the form * * @return $this The configuration object */
    public function setMethod($method);

    /** * Sets the request handler used by the form. * * @return $this The configuration object */
    public function setRequestHandler(RequestHandlerInterface $requestHandler);

    /** * Sets whether the form should be initialized automatically. * * Should be set to true only for root forms. * * @param bool $initialize True to initialize the form automatically, * false to suppress automatic initialization. * In the second case, you need to call * {@link FormInterface::initialize()} manually. * * @return $this The configuration object */
    public function setAutoInitialize($initialize);

    /** * Builds and returns the form configuration. * * @return FormConfigInterface */
    public function getFormConfig();
}