2012-12-31 14:29:36 +00:00
|
|
|
<?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;
|
|
|
|
|
2013-04-20 16:32:55 +01:00
|
|
|
use Symfony\Component\Form\Exception\AlreadySubmittedException;
|
2012-12-30 15:38:36 +00:00
|
|
|
use Symfony\Component\Form\Exception\BadMethodCallException;
|
2012-12-31 14:29:36 +00:00
|
|
|
|
|
|
|
/**
|
2013-04-11 15:58:10 +01:00
|
|
|
* A form button.
|
2012-12-31 14:29:36 +00:00
|
|
|
*
|
|
|
|
* @author Bernhard Schussek <bschussek@gmail.com>
|
|
|
|
*/
|
|
|
|
class Button implements \IteratorAggregate, FormInterface
|
|
|
|
{
|
|
|
|
/**
|
2013-10-31 14:11:32 +00:00
|
|
|
* @var FormInterface|null
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
private $parent;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var FormConfigInterface
|
|
|
|
*/
|
|
|
|
private $config;
|
|
|
|
|
|
|
|
/**
|
2014-04-16 11:30:19 +01:00
|
|
|
* @var bool
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
2013-04-20 16:32:55 +01:00
|
|
|
private $submitted = false;
|
2012-12-31 14:29:36 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a new button from a form configuration.
|
|
|
|
*
|
|
|
|
* @param FormConfigInterface $config The button's configuration.
|
|
|
|
*/
|
|
|
|
public function __construct(FormConfigInterface $config)
|
|
|
|
{
|
|
|
|
$this->config = $config;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* @param mixed $offset
|
|
|
|
*
|
2014-07-09 11:03:33 +01:00
|
|
|
* @return bool Always returns false.
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function offsetExists($offset)
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* This method should not be invoked.
|
|
|
|
*
|
|
|
|
* @param mixed $offset
|
|
|
|
*
|
2013-04-15 21:11:02 +01:00
|
|
|
* @throws BadMethodCallException
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function offsetGet($offset)
|
|
|
|
{
|
2013-04-15 21:11:02 +01:00
|
|
|
throw new BadMethodCallException('Buttons cannot have children.');
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* This method should not be invoked.
|
|
|
|
*
|
|
|
|
* @param mixed $offset
|
|
|
|
* @param mixed $value
|
|
|
|
*
|
2013-04-15 21:11:02 +01:00
|
|
|
* @throws BadMethodCallException
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function offsetSet($offset, $value)
|
|
|
|
{
|
2013-04-15 21:11:02 +01:00
|
|
|
throw new BadMethodCallException('Buttons cannot have children.');
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* This method should not be invoked.
|
|
|
|
*
|
|
|
|
* @param mixed $offset
|
|
|
|
*
|
2013-04-15 21:11:02 +01:00
|
|
|
* @throws BadMethodCallException
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function offsetUnset($offset)
|
|
|
|
{
|
2013-04-15 21:11:02 +01:00
|
|
|
throw new BadMethodCallException('Buttons cannot have children.');
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function setParent(FormInterface $parent = null)
|
|
|
|
{
|
|
|
|
$this->parent = $parent;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function getParent()
|
|
|
|
{
|
|
|
|
return $this->parent;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* This method should not be invoked.
|
|
|
|
*
|
|
|
|
* @param int|string|FormInterface $child
|
|
|
|
* @param null $type
|
|
|
|
* @param array $options
|
|
|
|
*
|
2013-04-15 21:11:02 +01:00
|
|
|
* @throws BadMethodCallException
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function add($child, $type = null, array $options = array())
|
|
|
|
{
|
2013-04-15 21:11:02 +01:00
|
|
|
throw new BadMethodCallException('Buttons cannot have children.');
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* This method should not be invoked.
|
|
|
|
*
|
|
|
|
* @param string $name
|
|
|
|
*
|
2013-04-15 21:11:02 +01:00
|
|
|
* @throws BadMethodCallException
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function get($name)
|
|
|
|
{
|
2013-04-15 21:11:02 +01:00
|
|
|
throw new BadMethodCallException('Buttons cannot have children.');
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* @param string $name
|
|
|
|
*
|
2014-07-09 11:03:33 +01:00
|
|
|
* @return bool Always returns false.
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function has($name)
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* This method should not be invoked.
|
|
|
|
*
|
|
|
|
* @param string $name
|
|
|
|
*
|
2013-04-15 21:11:02 +01:00
|
|
|
* @throws BadMethodCallException
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function remove($name)
|
|
|
|
{
|
2013-04-15 21:11:02 +01:00
|
|
|
throw new BadMethodCallException('Buttons cannot have children.');
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function all()
|
|
|
|
{
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function getErrors()
|
|
|
|
{
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* This method should not be invoked.
|
|
|
|
*
|
|
|
|
* @param string $modelData
|
|
|
|
*
|
2013-04-15 21:11:02 +01:00
|
|
|
* @throws BadMethodCallException
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function setData($modelData)
|
|
|
|
{
|
2013-08-22 13:19:04 +01:00
|
|
|
// called during initialization of the form tree
|
|
|
|
// noop
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* @return null Always returns null.
|
|
|
|
*/
|
|
|
|
public function getData()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* @return null Always returns null.
|
|
|
|
*/
|
|
|
|
public function getNormData()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* @return null Always returns null.
|
|
|
|
*/
|
|
|
|
public function getViewData()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* @return array Always returns an empty array.
|
|
|
|
*/
|
|
|
|
public function getExtraData()
|
|
|
|
{
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the button's configuration.
|
|
|
|
*
|
|
|
|
* @return FormConfigInterface The configuration.
|
|
|
|
*/
|
|
|
|
public function getConfig()
|
|
|
|
{
|
|
|
|
return $this->config;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns whether the button is submitted.
|
|
|
|
*
|
2014-07-09 11:03:33 +01:00
|
|
|
* @return bool true if the button was submitted.
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
2013-04-20 16:32:55 +01:00
|
|
|
public function isSubmitted()
|
2012-12-31 14:29:36 +00:00
|
|
|
{
|
2013-04-20 16:32:55 +01:00
|
|
|
return $this->submitted;
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*
|
|
|
|
* @return null Always returns null.
|
|
|
|
*/
|
|
|
|
public function getPropertyPath()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* @param FormError $error
|
|
|
|
*
|
2013-04-15 21:11:02 +01:00
|
|
|
* @throws BadMethodCallException
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function addError(FormError $error)
|
|
|
|
{
|
2013-04-15 21:11:02 +01:00
|
|
|
throw new BadMethodCallException('Buttons cannot have errors.');
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
2014-07-09 11:03:33 +01:00
|
|
|
* @return bool Always returns true.
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function isValid()
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
2014-07-09 11:03:33 +01:00
|
|
|
* @return bool Always returns false.
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function isRequired()
|
|
|
|
{
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* {@inheritdoc}
|
|
|
|
*/
|
|
|
|
public function isDisabled()
|
|
|
|
{
|
2014-01-22 15:19:57 +00:00
|
|
|
if (null === $this->parent || !$this->parent->isDisabled()) {
|
|
|
|
return $this->config->getDisabled();
|
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
2014-07-09 11:03:33 +01:00
|
|
|
* @return bool Always returns true.
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function isEmpty()
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
2014-07-09 11:03:33 +01:00
|
|
|
* @return bool Always returns true.
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function isSynchronized()
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2013-04-29 16:31:30 +01:00
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* @throws BadMethodCallException
|
|
|
|
*/
|
|
|
|
public function initialize()
|
|
|
|
{
|
2013-05-02 08:53:57 +01:00
|
|
|
throw new BadMethodCallException('Buttons cannot be initialized. Call initialize() on the root form instead.');
|
2013-04-29 16:31:30 +01:00
|
|
|
}
|
|
|
|
|
2012-12-30 15:38:36 +00:00
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* @param mixed $request
|
|
|
|
*
|
|
|
|
* @throws BadMethodCallException
|
|
|
|
*/
|
2013-04-20 14:56:42 +01:00
|
|
|
public function handleRequest($request = null)
|
2012-12-30 15:38:36 +00:00
|
|
|
{
|
2013-04-29 16:31:30 +01:00
|
|
|
throw new BadMethodCallException('Buttons cannot handle requests. Call handleRequest() on the root form instead.');
|
2012-12-30 15:38:36 +00:00
|
|
|
}
|
|
|
|
|
2012-12-31 14:29:36 +00:00
|
|
|
/**
|
2013-04-20 16:32:55 +01:00
|
|
|
* Submits data to the button.
|
2012-12-31 14:29:36 +00:00
|
|
|
*
|
2013-04-25 15:08:09 +01:00
|
|
|
* @param null|string $submittedData The data.
|
2014-04-12 18:54:57 +01:00
|
|
|
* @param bool $clearMissing Not used.
|
2012-12-31 14:29:36 +00:00
|
|
|
*
|
|
|
|
* @return Button The button instance
|
|
|
|
*
|
2013-04-20 16:32:55 +01:00
|
|
|
* @throws Exception\AlreadySubmittedException If the button has already been submitted.
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
2013-04-25 15:08:09 +01:00
|
|
|
public function submit($submittedData, $clearMissing = true)
|
2012-12-31 14:29:36 +00:00
|
|
|
{
|
2013-04-20 16:32:55 +01:00
|
|
|
if ($this->submitted) {
|
|
|
|
throw new AlreadySubmittedException('A form can only be submitted once');
|
2012-12-31 14:29:36 +00:00
|
|
|
}
|
|
|
|
|
2013-04-20 16:32:55 +01:00
|
|
|
$this->submitted = true;
|
2012-12-31 14:29:36 +00:00
|
|
|
|
|
|
|
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();
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->config->getType()->createView($this, $parent);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
2014-07-09 11:03:33 +01:00
|
|
|
* @return int Always returns 0.
|
2012-12-31 14:29:36 +00:00
|
|
|
*/
|
|
|
|
public function count()
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsupported method.
|
|
|
|
*
|
|
|
|
* @return \EmptyIterator Always returns an empty iterator.
|
|
|
|
*/
|
|
|
|
public function getIterator()
|
|
|
|
{
|
|
|
|
return new \EmptyIterator();
|
|
|
|
}
|
|
|
|
}
|