123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441 |
- <?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\Form\Exception\AlreadySubmittedException;
- use Symfony\Component\Form\Exception\BadMethodCallException;
- /**
- * A form button.
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
- class Button implements \IteratorAggregate, FormInterface
- {
- /**
- * @var FormInterface
- */
- private $parent;
- /**
- * @var FormConfigInterface
- */
- private $config;
- /**
- * @var bool
- */
- private $submitted = false;
- /**
- * Creates a new button from a form configuration.
- */
- public function __construct(FormConfigInterface $config)
- {
- $this->config = $config;
- }
- /**
- * Unsupported method.
- *
- * @param mixed $offset
- *
- * @return bool Always returns false
- */
- public function offsetExists($offset)
- {
- return false;
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @param mixed $offset
- *
- * @throws BadMethodCallException
- */
- public function offsetGet($offset)
- {
- throw new BadMethodCallException('Buttons cannot have children.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @param mixed $offset
- * @param mixed $value
- *
- * @throws BadMethodCallException
- */
- public function offsetSet($offset, $value)
- {
- throw new BadMethodCallException('Buttons cannot have children.');
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @param mixed $offset
- *
- * @throws BadMethodCallException
- */
- public function offsetUnset($offset)
- {
- throw new BadMethodCallException('Buttons cannot have children.');
- }
- /**
- * {@inheritdoc}
- */
- public function setParent(FormInterface $parent = null)
- {
- if ($this->submitted) {
- throw new AlreadySubmittedException('You cannot set the parent of a submitted button.');
- }
- $this->parent = $parent;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getParent()
- {
- return $this->parent;
- }
- /**
- * 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 get(string $name)
- {
- throw new BadMethodCallException('Buttons cannot have children.');
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function has(string $name)
- {
- return false;
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @throws BadMethodCallException
- */
- public function remove(string $name)
- {
- throw new BadMethodCallException('Buttons cannot have children.');
- }
- /**
- * {@inheritdoc}
- */
- public function all()
- {
- return [];
- }
- /**
- * {@inheritdoc}
- */
- public function getErrors(bool $deep = false, bool $flatten = true)
- {
- return new FormErrorIterator($this, []);
- }
- /**
- * Unsupported method.
- *
- * This method should not be invoked.
- *
- * @param mixed $modelData
- *
- * @return $this
- */
- public function setData($modelData)
- {
- // no-op, called during initialization of the form tree
- return $this;
- }
- /**
- * Unsupported method.
- */
- public function getData()
- {
- return null;
- }
- /**
- * Unsupported method.
- */
- public function getNormData()
- {
- return null;
- }
- /**
- * Unsupported method.
- */
- public function getViewData()
- {
- return null;
- }
- /**
- * Unsupported method.
- *
- * @return array Always returns an empty array
- */
- public function getExtraData()
- {
- return [];
- }
- /**
- * Returns the button's configuration.
- *
- * @return FormConfigInterface The configuration instance
- */
- public function getConfig()
- {
- return $this->config;
- }
- /**
- * Returns whether the button is submitted.
- *
- * @return bool true if the button was submitted
- */
- public function isSubmitted()
- {
- return $this->submitted;
- }
- /**
- * Returns the name by which the button is identified in forms.
- *
- * @return string The name of the button
- */
- public function getName()
- {
- return $this->config->getName();
- }
- /**
- * Unsupported method.
- */
- public function getPropertyPath()
- {
- return null;
- }
- /**
- * Unsupported method.
- *
- * @throws BadMethodCallException
- */
- public function addError(FormError $error)
- {
- throw new BadMethodCallException('Buttons cannot have errors.');
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns true
- */
- public function isValid()
- {
- return true;
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns false
- */
- public function isRequired()
- {
- return false;
- }
- /**
- * {@inheritdoc}
- */
- public function isDisabled()
- {
- if ($this->parent && $this->parent->isDisabled()) {
- return true;
- }
- return $this->config->getDisabled();
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns true
- */
- public function isEmpty()
- {
- return true;
- }
- /**
- * Unsupported method.
- *
- * @return bool Always returns true
- */
- public function isSynchronized()
- {
- return true;
- }
- /**
- * Unsupported method.
- */
- public function getTransformationFailure()
- {
- return null;
- }
- /**
- * Unsupported method.
- *
- * @throws BadMethodCallException
- */
- public function initialize()
- {
- throw new BadMethodCallException('Buttons cannot be initialized. Call initialize() on the root form instead.');
- }
- /**
- * Unsupported method.
- *
- * @param mixed $request
- *
- * @throws BadMethodCallException
- */
- public function handleRequest($request = null)
- {
- throw new BadMethodCallException('Buttons cannot handle requests. Call handleRequest() on the root form instead.');
- }
- /**
- * Submits data to the button.
- *
- * @param string|null $submittedData Not used
- * @param bool $clearMissing Not used
- *
- * @return $this
- *
- * @throws Exception\AlreadySubmittedException if the button has already been submitted
- */
- public function submit($submittedData, bool $clearMissing = true)
- {
- if ($this->submitted) {
- throw new AlreadySubmittedException('A form can only be submitted once.');
- }
- $this->submitted = true;
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function getRoot()
- {
- return $this->parent ? $this->parent->getRoot() : $this;
- }
- /**
- * {@inheritdoc}
- */
- public function isRoot()
- {
- return null === $this->parent;
- }
- /**
- * {@inheritdoc}
- */
- public function createView(FormView $parent = null)
- {
- if (null === $parent && $this->parent) {
- $parent = $this->parent->createView();
- }
- $type = $this->config->getType();
- $options = $this->config->getOptions();
- $view = $type->createView($this, $parent);
- $type->buildView($view, $this, $options);
- $type->finishView($view, $this, $options);
- return $view;
- }
- /**
- * 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();
- }
- }
|