123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811 |
- <?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\EventDispatcher\EventSubscriberInterface;
- use Symfony\Component\EventDispatcher\ImmutableEventDispatcher;
- use Symfony\Component\Form\Exception\BadMethodCallException;
- use Symfony\Component\Form\Exception\InvalidArgumentException;
- use Symfony\Component\PropertyAccess\PropertyPath;
- use Symfony\Component\PropertyAccess\PropertyPathInterface;
- /**
- * A basic form configuration.
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
- class FormConfigBuilder implements FormConfigBuilderInterface
- {
- /**
- * Caches a globally unique {@link NativeRequestHandler} instance.
- *
- * @var NativeRequestHandler
- */
- private static $nativeRequestHandler;
- protected $locked = false;
- private $dispatcher;
- private $name;
- /**
- * @var PropertyPathInterface|string|null
- */
- private $propertyPath;
- private $mapped = true;
- private $byReference = true;
- private $inheritData = false;
- private $compound = false;
- /**
- * @var ResolvedFormTypeInterface
- */
- private $type;
- private $viewTransformers = [];
- private $modelTransformers = [];
- /**
- * @var DataMapperInterface|null
- */
- private $dataMapper;
- private $required = true;
- private $disabled = false;
- private $errorBubbling = false;
- /**
- * @var mixed
- */
- private $emptyData;
- private $attributes = [];
- /**
- * @var mixed
- */
- private $data;
- /**
- * @var string|null
- */
- private $dataClass;
- private $dataLocked = false;
- /**
- * @var FormFactoryInterface|null
- */
- private $formFactory;
- /**
- * @var string|null
- */
- private $action;
- private $method = 'POST';
- /**
- * @var RequestHandlerInterface|null
- */
- private $requestHandler;
- private $autoInitialize = false;
- private $options;
- private $isEmptyCallback;
- /**
- * Creates an empty form configuration.
- *
- * @param string|null $name The form name
- * @param string|null $dataClass The class of the form's data
- *
- * @throws InvalidArgumentException if the data class is not a valid class or if
- * the name contains invalid characters
- */
- public function __construct(?string $name, ?string $dataClass, EventDispatcherInterface $dispatcher, array $options = [])
- {
- self::validateName($name);
- if (null !== $dataClass && !class_exists($dataClass) && !interface_exists($dataClass, false)) {
- throw new InvalidArgumentException(sprintf('Class "%s" not found. Is the "data_class" form option set correctly?', $dataClass));
- }
- $this->name = (string) $name;
- $this->dataClass = $dataClass;
- $this->dispatcher = $dispatcher;
- $this->options = $options;
- }
- /**
- * {@inheritdoc}
- */
- public function addEventListener(string $eventName, callable $listener, int $priority = 0)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->dispatcher->addListener($eventName, $listener, $priority);
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function addEventSubscriber(EventSubscriberInterface $subscriber)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->dispatcher->addSubscriber($subscriber);
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- if ($forcePrepend) {
- array_unshift($this->viewTransformers, $viewTransformer);
- } else {
- $this->viewTransformers[] = $viewTransformer;
- }
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function resetViewTransformers()
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->viewTransformers = [];
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- if ($forceAppend) {
- $this->modelTransformers[] = $modelTransformer;
- } else {
- array_unshift($this->modelTransformers, $modelTransformer);
- }
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function resetModelTransformers()
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->modelTransformers = [];
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getEventDispatcher()
- {
- if ($this->locked && !$this->dispatcher instanceof ImmutableEventDispatcher) {
- $this->dispatcher = new ImmutableEventDispatcher($this->dispatcher);
- }
- return $this->dispatcher;
- }
- /**
- * {@inheritdoc}
- */
- public function getName()
- {
- return $this->name;
- }
- /**
- * {@inheritdoc}
- */
- public function getPropertyPath()
- {
- return $this->propertyPath;
- }
- /**
- * {@inheritdoc}
- */
- public function getMapped()
- {
- return $this->mapped;
- }
- /**
- * {@inheritdoc}
- */
- public function getByReference()
- {
- return $this->byReference;
- }
- /**
- * {@inheritdoc}
- */
- public function getInheritData()
- {
- return $this->inheritData;
- }
- /**
- * {@inheritdoc}
- */
- public function getCompound()
- {
- return $this->compound;
- }
- /**
- * {@inheritdoc}
- */
- public function getType()
- {
- return $this->type;
- }
- /**
- * {@inheritdoc}
- */
- public function getViewTransformers()
- {
- return $this->viewTransformers;
- }
- /**
- * {@inheritdoc}
- */
- public function getModelTransformers()
- {
- return $this->modelTransformers;
- }
- /**
- * {@inheritdoc}
- */
- public function getDataMapper()
- {
- return $this->dataMapper;
- }
- /**
- * {@inheritdoc}
- */
- public function getRequired()
- {
- return $this->required;
- }
- /**
- * {@inheritdoc}
- */
- public function getDisabled()
- {
- return $this->disabled;
- }
- /**
- * {@inheritdoc}
- */
- public function getErrorBubbling()
- {
- return $this->errorBubbling;
- }
- /**
- * {@inheritdoc}
- */
- public function getEmptyData()
- {
- return $this->emptyData;
- }
- /**
- * {@inheritdoc}
- */
- public function getAttributes()
- {
- return $this->attributes;
- }
- /**
- * {@inheritdoc}
- */
- public function hasAttribute(string $name)
- {
- return \array_key_exists($name, $this->attributes);
- }
- /**
- * {@inheritdoc}
- */
- public function getAttribute(string $name, $default = null)
- {
- return \array_key_exists($name, $this->attributes) ? $this->attributes[$name] : $default;
- }
- /**
- * {@inheritdoc}
- */
- public function getData()
- {
- return $this->data;
- }
- /**
- * {@inheritdoc}
- */
- public function getDataClass()
- {
- return $this->dataClass;
- }
- /**
- * {@inheritdoc}
- */
- public function getDataLocked()
- {
- return $this->dataLocked;
- }
- /**
- * {@inheritdoc}
- */
- public function getFormFactory()
- {
- return $this->formFactory;
- }
- /**
- * {@inheritdoc}
- */
- public function getAction()
- {
- return $this->action;
- }
- /**
- * {@inheritdoc}
- */
- public function getMethod()
- {
- return $this->method;
- }
- /**
- * {@inheritdoc}
- */
- public function getRequestHandler()
- {
- if (null === $this->requestHandler) {
- if (null === self::$nativeRequestHandler) {
- self::$nativeRequestHandler = new NativeRequestHandler();
- }
- $this->requestHandler = self::$nativeRequestHandler;
- }
- return $this->requestHandler;
- }
- /**
- * {@inheritdoc}
- */
- public function getAutoInitialize()
- {
- return $this->autoInitialize;
- }
- /**
- * {@inheritdoc}
- */
- public function getOptions()
- {
- return $this->options;
- }
- /**
- * {@inheritdoc}
- */
- public function hasOption(string $name)
- {
- return \array_key_exists($name, $this->options);
- }
- /**
- * {@inheritdoc}
- */
- public function getOption(string $name, $default = null)
- {
- return \array_key_exists($name, $this->options) ? $this->options[$name] : $default;
- }
- /**
- * {@inheritdoc}
- */
- public function getIsEmptyCallback(): ?callable
- {
- return $this->isEmptyCallback;
- }
- /**
- * {@inheritdoc}
- */
- public function setAttribute(string $name, $value)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->attributes[$name] = $value;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setAttributes(array $attributes)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->attributes = $attributes;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setDataMapper(DataMapperInterface $dataMapper = null)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->dataMapper = $dataMapper;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setDisabled(bool $disabled)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->disabled = $disabled;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setEmptyData($emptyData)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->emptyData = $emptyData;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setErrorBubbling(bool $errorBubbling)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->errorBubbling = $errorBubbling;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setRequired(bool $required)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->required = $required;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setPropertyPath($propertyPath)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- if (null !== $propertyPath && !$propertyPath instanceof PropertyPathInterface) {
- $propertyPath = new PropertyPath($propertyPath);
- }
- $this->propertyPath = $propertyPath;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setMapped(bool $mapped)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->mapped = $mapped;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setByReference(bool $byReference)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->byReference = $byReference;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setInheritData(bool $inheritData)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->inheritData = $inheritData;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setCompound(bool $compound)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->compound = $compound;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setType(ResolvedFormTypeInterface $type)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->type = $type;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setData($data)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->data = $data;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setDataLocked(bool $locked)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->dataLocked = $locked;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setFormFactory(FormFactoryInterface $formFactory)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->formFactory = $formFactory;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setAction(string $action)
- {
- if ($this->locked) {
- throw new BadMethodCallException('The config builder cannot be modified anymore.');
- }
- $this->action = $action;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setMethod(string $method)
- {
- if ($this->locked) {
- throw new BadMethodCallException('The config builder cannot be modified anymore.');
- }
- $this->method = strtoupper($method);
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setRequestHandler(RequestHandlerInterface $requestHandler)
- {
- if ($this->locked) {
- throw new BadMethodCallException('The config builder cannot be modified anymore.');
- }
- $this->requestHandler = $requestHandler;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setAutoInitialize(bool $initialize)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->autoInitialize = $initialize;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getFormConfig()
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormConfigBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- // This method should be idempotent, so clone the builder
- $config = clone $this;
- $config->locked = true;
- return $config;
- }
- /**
- * {@inheritdoc}
- */
- public function setIsEmptyCallback(?callable $isEmptyCallback)
- {
- $this->isEmptyCallback = $isEmptyCallback;
- return $this;
- }
- /**
- * Validates whether the given variable is a valid form name.
- *
- * @throws InvalidArgumentException if the name contains invalid characters
- *
- * @internal
- */
- final public static function validateName(?string $name)
- {
- if (!self::isValidName($name)) {
- throw new InvalidArgumentException(sprintf('The name "%s" contains illegal characters. Names should start with a letter, digit or underscore and only contain letters, digits, numbers, underscores ("_"), hyphens ("-") and colons (":").', $name));
- }
- }
- /**
- * Returns whether the given variable contains a valid form name.
- *
- * A name is accepted if it
- *
- * * is empty
- * * starts with a letter, digit or underscore
- * * contains only letters, digits, numbers, underscores ("_"),
- * hyphens ("-") and colons (":")
- */
- final public static function isValidName(?string $name): bool
- {
- return '' === $name || null === $name || preg_match('/^[a-zA-Z0-9_][a-zA-Z0-9_\-:]*$/D', $name);
- }
- }
|