<?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\InvalidArgumentException; use Symfony\Component\Form\Exception\BadMethodCallException; /** * A builder for {@link Button} instances. * * @author Bernhard Schussek <bschussek@gmail.com> */ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface { /** * @var Boolean */ protected $locked = false; /** * @var Boolean */ private $disabled; /** * @var ResolvedFormTypeInterface */ private $type; /** * @var string */ private $name; /** * @var array */ private $attributes = array(); /** * @var array */ private $options; /** * Creates a new button builder. * * @param string $name The name of the button. * @param array $options The button's options. * * @throws InvalidArgumentException If the name is empty. */ public function __construct($name, array $options = array()) { if (empty($name) && 0 != $name) { throw new InvalidArgumentException('Buttons cannot have empty names.'); } $this->name = (string) $name; $this->options = $options; } /** * Unsupported method. * * This method should not be invoked. * * @param string|integer|FormBuilderInterface $child * @param string|FormTypeInterface $type * @param array $options * * @throws BadMethodCallException */ public function add($child, $type = null, array $options = array()) { throw new BadMethodCallException('Buttons cannot have children.'); } /** * Unsupported method. * * This method should not be invoked. * * @param string $name * @param string|FormTypeInterface $type * @param array $options * * @throws BadMethodCallException */ public function create($name, $type = null, array $options = array()) { throw new BadMethodCallException('Buttons cannot have children.'); } /** * Unsupported method. * * This method should not be invoked. * * @param string $name * * @throws BadMethodCallException */ public function get($name) { throw new BadMethodCallException('Buttons cannot have children.'); } /** * Unsupported method. * * This method should not be invoked. * * @param string $name * * @throws BadMethodCallException */ public function remove($name) { throw new BadMethodCallException('Buttons cannot have children.'); } /** * Unsupported method. * * @param string $name * * @return Boolean Always returns false. */ public function has($name) { return false; } /** * Returns the children. * * @return array Always returns an empty array. */ public function all() { return array(); } /** * Creates the button. * * @return Button The button */ public function getForm() { return new Button($this->getFormConfig()); } /** * Unsupported method. * * This method should not be invoked. * * @param string $eventName * @param callable $listener * @param integer $priority * * @throws BadMethodCallException */ public function addEventListener($eventName, $listener, $priority = 0) { throw new BadMethodCallException('Buttons do not support event listeners.'); } /** * Unsupported method. * * This method should not be invoked. * * @param EventSubscriberInterface $subscriber * * @throws BadMethodCallException */ public function addEventSubscriber(EventSubscriberInterface $subscriber) { throw new BadMethodCallException('Buttons do not support event subscribers.'); } /** * Unsupported method. * * This method should not be invoked. * * @param DataTransformerInterface $viewTransformer * @param Boolean $forcePrepend * * @throws BadMethodCallException */ public function addViewTransformer(DataTransformerInterface $viewTransformer, $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. * * @param DataTransformerInterface $modelTransformer * @param Boolean $forceAppend * * @throws BadMethodCallException */ public function addModelTransformer(DataTransformerInterface $modelTransformer, $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($name, $value) { $this->attributes[$name] = $value; } /** * {@inheritdoc} */ public function setAttributes(array $attributes) { $this->attributes = $attributes; } /** * Unsupported method. * * This method should not be invoked. * * @param DataMapperInterface $dataMapper * * @throws BadMethodCallException */ public function setDataMapper(DataMapperInterface $dataMapper = null) { throw new BadMethodCallException('Buttons do not support data mappers.'); } /** * Set whether the button is disabled. * * @param Boolean $disabled Whether the button is disabled * * @return ButtonBuilder The button builder. */ public function setDisabled($disabled) { $this->disabled = $disabled; } /** * 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. * * @param Boolean $errorBubbling * * @throws BadMethodCallException */ public function setErrorBubbling($errorBubbling) { throw new BadMethodCallException('Buttons do not support error bubbling.'); } /** * Unsupported method. * * This method should not be invoked. * * @param Boolean $required * * @throws BadMethodCallException */ public function setRequired($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. * * @param Boolean $mapped * * @throws BadMethodCallException */ public function setMapped($mapped) { throw new BadMethodCallException('Buttons do not support data mapping.'); } /** * Unsupported method. * * This method should not be invoked. * * @param Boolean $byReference * * @throws BadMethodCallException */ public function setByReference($byReference) { throw new BadMethodCallException('Buttons do not support data mapping.'); } /** * Unsupported method. * * This method should not be invoked. * * @param Boolean $virtual * * @throws BadMethodCallException */ public function setVirtual($virtual) { throw new BadMethodCallException('Buttons cannot be virtual.'); } /** * Unsupported method. * * This method should not be invoked. * * @param Boolean $compound * * @throws BadMethodCallException */ public function setCompound($compound) { throw new BadMethodCallException('Buttons cannot be compound.'); } /** * Sets the type of the button. * * @param ResolvedFormTypeInterface $type The type of the button. * * @return ButtonBuilder The button builder. */ public function setType(ResolvedFormTypeInterface $type) { $this->type = $type; } /** * Unsupported method. * * This method should not be invoked. * * @param array $data * * @throws BadMethodCallException */ public function setData($data) { throw new BadMethodCallException('Buttons do not support data.'); } /** * Unsupported method. * * This method should not be invoked. * * @param Boolean $locked * * @throws BadMethodCallException */ public function setDataLocked($locked) { throw new BadMethodCallException('Buttons do not support data locking.'); } /** * Unsupported method. * * This method should not be invoked. * * @param FormFactoryInterface $formFactory * * @return void * * @throws BadMethodCallException */ public function setFormFactory(FormFactoryInterface $formFactory) { throw new BadMethodCallException('Buttons do not support form factories.'); } /** * Unsupported method. * * @param string $action * * @throws BadMethodCallException */ public function setAction($action) { throw new BadMethodCallException('Buttons do not support actions.'); } /** * Unsupported method. * * @param string $method * * @throws BadMethodCallException */ public function setMethod($method) { throw new BadMethodCallException('Buttons do not support methods.'); } /** * Unsupported method. * * @param RequestHandlerInterface $requestHandler * * @throws BadMethodCallException */ public function setRequestHandler(RequestHandlerInterface $requestHandler) { throw new BadMethodCallException('Buttons do not support form processors.'); } /** * Unsupported method. * * @param Boolean $initialize * * @throws BadMethodCallException */ public function setAutoInitialize($initialize) { if (true === $initialize) { throw new BadMethodCallException('Buttons do not support automatic initialization.'); } return $this; } /** * Unsupported method. * * @param Boolean $inheritData * * @throws BadMethodCallException */ public function setInheritData($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. * * @return null Always returns null. */ public function getEventDispatcher() { return null; } /** * {@inheritdoc} */ public function getName() { return $this->name; } /** * Unsupported method. * * @return null Always returns null. */ public function getPropertyPath() { return null; } /** * Unsupported method. * * @return Boolean Always returns false. */ public function getMapped() { return false; } /** * Unsupported method. * * @return Boolean Always returns false. */ public function getByReference() { return false; } /** * Unsupported method. * * @return Boolean Always returns false. */ public function getVirtual() { return false; } /** * Unsupported method. * * @return Boolean 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 array(); } /** * Unsupported method. * * @return array Always returns an empty array. */ public function getModelTransformers() { return array(); } /** * Unsupported method. * * @return null Always returns null. */ public function getDataMapper() { return null; } /** * Unsupported method. * * @return Boolean Always returns false. */ public function getRequired() { return false; } /** * Returns whether the button is disabled. * * @return Boolean Whether the button is disabled. */ public function getDisabled() { return $this->disabled; } /** * Unsupported method. * * @return Boolean Always returns false. */ public function getErrorBubbling() { return false; } /** * Unsupported method. * * @return null Always returns null. */ 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. * * @param string $name The attribute name. * * @return Boolean Whether the attribute exists. */ public function hasAttribute($name) { return array_key_exists($name, $this->attributes); } /** * 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) { return array_key_exists($name, $this->attributes) ? $this->attributes[$name] : $default; } /** * Unsupported method. * * @return null Always returns null. */ public function getData() { return null; } /** * Unsupported method. * * @return null Always returns null. */ public function getDataClass() { return null; } /** * Unsupported method. * * @return Boolean Always returns false. */ public function getDataLocked() { return false; } /** * Unsupported method. * * @return null Always returns null. */ public function getFormFactory() { return null; } /** * Unsupported method. * * @return null Always returns null. */ public function getAction() { return null; } /** * Unsupported method. * * @return null Always returns null. */ public function getMethod() { return null; } /** * Unsupported method. * * @return null Always returns null. */ public function getRequestHandler() { return null; } /** * Unsupported method. * * @return Boolean Always returns false. */ public function getAutoInitialize() { return false; } /** * Unsupported method. * * @return Boolean 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. * * @param string $name The option name, * * @return Boolean Whether the option exists. */ public function hasOption($name) { return array_key_exists($name, $this->options); } /** * 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) { return array_key_exists($name, $this->options) ? $this->options[$name] : $default; } /** * Unsupported method. * * @return integer Always returns 0. */ public function count() { return 0; } /** * Unsupported method. * * @return \EmptyIterator Always returns an empty iterator. */ public function getIterator() { return new \EmptyIterator(); } }