Classes List

Symfony\Component\Form\FormConfigInterface

 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 
<?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\EventDispatcherInterface;
use Symfony\Component\PropertyAccess\PropertyPathInterface;

/** * The configuration of a {@link Form} object. * * @author Bernhard Schussek <bschussek@gmail.com> */
interface FormConfigInterface
{
    /** * Returns the event dispatcher used to dispatch form events. * * @return EventDispatcherInterface The dispatcher */
    public function getEventDispatcher();

    /** * Returns the name of the form used as HTTP parameter. * * @return string The form name */
    public function getName();

    /** * Returns the property path that the form should be mapped to. * * @return null|PropertyPathInterface The property path */
    public function getPropertyPath();

    /** * Returns whether the form should be mapped to an element of its * parent's data. * * @return bool Whether the form is mapped */
    public function getMapped();

    /** * Returns whether the form's data should be modified by reference. * * @return bool Whether to modify the form's data by reference */
    public function getByReference();

    /** * Returns whether the form should read and write the data of its parent. * * @return bool Whether the form should inherit its parent's data */
    public function getInheritData();

    /** * Returns whether the form is compound. * * This property is independent of whether the form actually has * children. A form can be compound and have no children at all, like * for example an empty collection form. * * @return bool Whether the form is compound */
    public function getCompound();

    /** * Returns the form types used to construct the form. * * @return ResolvedFormTypeInterface The form's type */
    public function getType();

    /** * Returns the view transformers of the form. * * @return DataTransformerInterface[] An array of {@link DataTransformerInterface} instances */
    public function getViewTransformers();

    /** * Returns the model transformers of the form. * * @return DataTransformerInterface[] An array of {@link DataTransformerInterface} instances */
    public function getModelTransformers();

    /** * Returns the data mapper of the form. * * @return DataMapperInterface The data mapper */
    public function getDataMapper();

    /** * Returns whether the form is required. * * @return bool Whether the form is required */
    public function getRequired();

    /** * Returns whether the form is disabled. * * @return bool Whether the form is disabled */
    public function getDisabled();

    /** * Returns whether errors attached to the form will bubble to its parent. * * @return bool Whether errors will bubble up */
    public function getErrorBubbling();

    /** * Returns the data that should be returned when the form is empty. * * @return mixed The data returned if the form is empty */
    public function getEmptyData();

    /** * Returns additional attributes of the form. * * @return array An array of key-value combinations */
    public function getAttributes();

    /** * Returns whether the attribute with the given name exists. * * @param string $name The attribute name * * @return bool Whether the attribute exists */
    public function hasAttribute($name);

    /** * Returns the value of the given attribute. * * @param string $name The attribute name * @param mixed $default The value returned if the attribute does not exist * * @return mixed The attribute value */
    public function getAttribute($name$default = null);

    /** * Returns the initial data of the form. * * @return mixed The initial form data */
    public function getData();

    /** * Returns the class of the form data or null if the data is scalar or an array. * * @return null|string The data class or null */
    public function getDataClass();

    /** * Returns whether the form's data is locked. * * 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. * * @return bool Whether the data is locked */
    public function getDataLocked();

    /** * Returns the form factory used for creating new forms. * * @return FormFactoryInterface The form factory */
    public function getFormFactory();

    /** * Returns the target URL of the form. * * @return string The target URL of the form */
    public function getAction();

    /** * Returns the HTTP method used by the form. * * @return string The HTTP method of the form */
    public function getMethod();

    /** * Returns the request handler used by the form. * * @return RequestHandlerInterface The request handler */
    public function getRequestHandler();

    /** * Returns whether the form should be initialized upon creation. * * @return bool returns true if the form should be initialized * when created, false otherwise */
    public function getAutoInitialize();

    /** * Returns all options passed during the construction of the form. * * @return array The passed options */
    public function getOptions();

    /** * Returns whether a specific option exists. * * @param string $name The option name, * * @return bool Whether the option exists */
    public function hasOption($name);

    /** * Returns the value of a specific option. * * @param string $name The option name * @param mixed $default The value returned if the option does not exist * * @return mixed The option value */
    public function getOption($name$default = null);
}