123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780 |
- <?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\Form\Exception\BadMethodCallException;
- use Symfony\Component\Form\Exception\InvalidArgumentException;
- /**
- * A builder for {@link Button} instances.
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
- class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
- {
- protected $locked = false;
- /**
- * @var bool
- */
- private $disabled = false;
- /**
- * @var ResolvedFormTypeInterface
- */
- private $type;
- /**
- * @var string
- */
- private $name;
- /**
- * @var array
- */
- private $attributes = [];
- /**
- * @var array
- */
- private $options;
- /**
- * @throws InvalidArgumentException if the name is empty
- */
- public function __construct(?string $name, array $options = [])
- {
- if ('' === $name || null === $name) {
- throw new InvalidArgumentException('Buttons cannot have empty names.');
- }
- $this->name = $name;
- $this->options = $options;
- FormConfigBuilder::validateName($name);
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function add($child, string $type = null, array $options = [])
- {
- throw new BadMethodCallException('Buttons cannot have children.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function create(string $name, string $type = null, array $options = [])
- {
- throw new BadMethodCallException('Buttons cannot have children.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function get(string $name)
- {
- throw new BadMethodCallException('Buttons cannot have children.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function remove(string $name)
- {
- throw new BadMethodCallException('Buttons cannot have children.');
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function has(string $name)
- {
- return false;
- }
- /**
- * Returns the children.
- *
- * @return array Always returns an empty array
- */
- public function all()
- {
- return [];
- }
- /**
- * Creates the button.
- *
- * @return Button The button
- */
- public function getForm()
- {
- return new Button($this->getFormConfig());
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function addEventListener(string $eventName, callable $listener, int $priority = 0)
- {
- throw new BadMethodCallException('Buttons do not support event listeners.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function addEventSubscriber(EventSubscriberInterface $subscriber)
- {
- throw new BadMethodCallException('Buttons do not support event subscribers.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)
- {
- throw new BadMethodCallException('Buttons do not support data transformers.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function resetViewTransformers()
- {
- throw new BadMethodCallException('Buttons do not support data transformers.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)
- {
- throw new BadMethodCallException('Buttons do not support data transformers.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function resetModelTransformers()
- {
- throw new BadMethodCallException('Buttons do not support data transformers.');
- }
- /**
- * {@inheritdoc}
- */
- public function setAttribute(string $name, $value)
- {
- $this->attributes[$name] = $value;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function setAttributes(array $attributes)
- {
- $this->attributes = $attributes;
- return $this;
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function setDataMapper(DataMapperInterface $dataMapper = null)
- {
- throw new BadMethodCallException('Buttons do not support data mappers.');
- }
- /**
- * Set whether the button is disabled.
- *
- * @return $this
- */
- public function setDisabled(bool $disabled)
- {
- $this->disabled = $disabled;
- return $this;
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @param mixed $emptyData
- *
- * @throws BadMethodCallException
- */
- public function setEmptyData($emptyData)
- {
- throw new BadMethodCallException('Buttons do not support empty data.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function setErrorBubbling(bool $errorBubbling)
- {
- throw new BadMethodCallException('Buttons do not support error bubbling.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function setRequired(bool $required)
- {
- throw new BadMethodCallException('Buttons cannot be required.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @param null $propertyPath
- *
- * @throws BadMethodCallException
- */
- public function setPropertyPath($propertyPath)
- {
- throw new BadMethodCallException('Buttons do not support property paths.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function setMapped(bool $mapped)
- {
- throw new BadMethodCallException('Buttons do not support data mapping.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function setByReference(bool $byReference)
- {
- throw new BadMethodCallException('Buttons do not support data mapping.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function setCompound(bool $compound)
- {
- throw new BadMethodCallException('Buttons cannot be compound.');
- }
- /**
- * Sets the type of the button.
- *
- * @return $this
- */
- public function setType(ResolvedFormTypeInterface $type)
- {
- $this->type = $type;
- return $this;
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @param mixed $data
- *
- * @throws BadMethodCallException
- */
- public function setData($data)
- {
- throw new BadMethodCallException('Buttons do not support data.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function setDataLocked(bool $locked)
- {
- throw new BadMethodCallException('Buttons do not support data locking.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function setFormFactory(FormFactoryInterface $formFactory)
- {
- throw new BadMethodCallException('Buttons do not support form factories.');
- }
- /**
- * Unsupported method.
- *
- * @throws BadMethodCallException
- */
- public function setAction(string $action)
- {
- throw new BadMethodCallException('Buttons do not support actions.');
- }
- /**
- * Unsupported method.
- *
- * @throws BadMethodCallException
- */
- public function setMethod(string $method)
- {
- throw new BadMethodCallException('Buttons do not support methods.');
- }
- /**
- * Unsupported method.
- *
- * @throws BadMethodCallException
- */
- public function setRequestHandler(RequestHandlerInterface $requestHandler)
- {
- throw new BadMethodCallException('Buttons do not support request handlers.');
- }
- /**
- * Unsupported method.
- *
- * @return $this
- *
- * @throws BadMethodCallException
- */
- public function setAutoInitialize(bool $initialize)
- {
- if (true === $initialize) {
- throw new BadMethodCallException('Buttons do not support automatic initialization.');
- }
- return $this;
- }
- /**
- * Unsupported method.
- *
- * @throws BadMethodCallException
- */
- public function setInheritData(bool $inheritData)
- {
- throw new BadMethodCallException('Buttons do not support data inheritance.');
- }
- /**
- * Builds and returns the button configuration.
- *
- * @return FormConfigInterface
- */
- public function getFormConfig()
- {
- // This method should be idempotent, so clone the builder
- $config = clone $this;
- $config->locked = true;
- return $config;
- }
- /**
- * Unsupported method.
- *
- * @throws BadMethodCallException
- */
- public function setIsEmptyCallback(?callable $isEmptyCallback)
- {
- throw new BadMethodCallException('Buttons do not support "is empty" callback.');
- }
- /**
- * Unsupported method.
- */
- public function getEventDispatcher()
- {
- return null;
- }
- /**
- * {@inheritdoc}
- */
- public function getName()
- {
- return $this->name;
- }
- /**
- * Unsupported method.
- */
- public function getPropertyPath()
- {
- return null;
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function getMapped()
- {
- return false;
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function getByReference()
- {
- return false;
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function getCompound()
- {
- return false;
- }
- /**
- * Returns the form type used to construct the button.
- *
- * @return ResolvedFormTypeInterface The button's type
- */
- public function getType()
- {
- return $this->type;
- }
- /**
- * Unsupported method.
- *
- * @return array Always returns an empty array
- */
- public function getViewTransformers()
- {
- return [];
- }
- /**
- * Unsupported method.
- *
- * @return array Always returns an empty array
- */
- public function getModelTransformers()
- {
- return [];
- }
- /**
- * Unsupported method.
- */
- public function getDataMapper()
- {
- return null;
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function getRequired()
- {
- return false;
- }
- /**
- * Returns whether the button is disabled.
- *
- * @return bool Whether the button is disabled
- */
- public function getDisabled()
- {
- return $this->disabled;
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function getErrorBubbling()
- {
- return false;
- }
- /**
- * Unsupported method.
- */
- public function getEmptyData()
- {
- return null;
- }
- /**
- * Returns additional attributes of the button.
- *
- * @return array An array of key-value combinations
- */
- public function getAttributes()
- {
- return $this->attributes;
- }
- /**
- * Returns whether the attribute with the given name exists.
- *
- * @return bool Whether the attribute exists
- */
- public function hasAttribute(string $name)
- {
- return \array_key_exists($name, $this->attributes);
- }
- /**
- * Returns the value of the given attribute.
- *
- * @param mixed $default The value returned if the attribute does not exist
- *
- * @return mixed The attribute value
- */
- public function getAttribute(string $name, $default = null)
- {
- return \array_key_exists($name, $this->attributes) ? $this->attributes[$name] : $default;
- }
- /**
- * Unsupported method.
- */
- public function getData()
- {
- return null;
- }
- /**
- * Unsupported method.
- */
- public function getDataClass()
- {
- return null;
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function getDataLocked()
- {
- return false;
- }
- /**
- * Unsupported method.
- */
- public function getFormFactory()
- {
- throw new BadMethodCallException('Buttons do not support adding children.');
- }
- /**
- * Unsupported method.
- */
- public function getAction()
- {
- return null;
- }
- /**
- * Unsupported method.
- */
- public function getMethod()
- {
- return null;
- }
- /**
- * Unsupported method.
- */
- public function getRequestHandler()
- {
- return null;
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function getAutoInitialize()
- {
- return false;
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function getInheritData()
- {
- return false;
- }
- /**
- * Returns all options passed during the construction of the button.
- *
- * @return array The passed options
- */
- public function getOptions()
- {
- return $this->options;
- }
- /**
- * Returns whether a specific option exists.
- *
- * @return bool Whether the option exists
- */
- public function hasOption(string $name)
- {
- return \array_key_exists($name, $this->options);
- }
- /**
- * Returns the value of a specific option.
- *
- * @param mixed $default The value returned if the option does not exist
- *
- * @return mixed The option value
- */
- public function getOption(string $name, $default = null)
- {
- return \array_key_exists($name, $this->options) ? $this->options[$name] : $default;
- }
- /**
- * Unsupported method.
- *
- * @throws BadMethodCallException
- */
- public function getIsEmptyCallback(): ?callable
- {
- throw new BadMethodCallException('Buttons do not support "is empty" callback.');
- }
- /**
- * Unsupported method.
- *
- * @return int Always returns 0
- */
- public function count()
- {
- return 0;
- }
- /**
- * Unsupported method.
- *
- * @return \EmptyIterator Always returns an empty iterator
- */
- public function getIterator()
- {
- return new \EmptyIterator();
- }
- }
|