2011-02-18 19:17:44 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This file is part of the Symfony package.
|
|
|
|
*
|
2011-04-24 12:59:46 +01:00
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
2011-02-18 19:17:44 +00:00
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
2011-04-07 08:57:44 +01:00
|
|
|
namespace Symfony\Component\Form;
|
2011-02-18 19:17:44 +00:00
|
|
|
|
2011-04-18 14:07:12 +01:00
|
|
|
use Symfony\Component\Form\Util\FormUtil;
|
2011-02-18 19:17:44 +00:00
|
|
|
|
2011-04-16 12:54:31 +01:00
|
|
|
class FormView implements \ArrayAccess, \IteratorAggregate, \Countable
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-04-02 13:14:18 +01:00
|
|
|
private $vars = array(
|
|
|
|
'value' => null,
|
2011-05-10 14:32:14 +01:00
|
|
|
'attr' => array(),
|
2011-04-02 13:14:18 +01:00
|
|
|
);
|
2011-02-18 19:17:44 +00:00
|
|
|
|
2011-04-07 08:57:44 +01:00
|
|
|
private $parent;
|
|
|
|
|
|
|
|
private $children = array();
|
|
|
|
|
2011-03-19 13:31:25 +00:00
|
|
|
/**
|
2011-03-21 19:56:33 +00:00
|
|
|
* Is the form attached to this renderer rendered?
|
2011-03-19 13:31:25 +00:00
|
|
|
*
|
|
|
|
* Rendering happens when either the widget or the row method was called.
|
|
|
|
* Row implicitly includes widget, however certain rendering mechanisms
|
|
|
|
* have to skip widget rendering when a row is rendered.
|
|
|
|
*
|
2011-03-24 13:27:21 +00:00
|
|
|
* @var Boolean
|
2011-03-19 13:31:25 +00:00
|
|
|
*/
|
2011-02-28 16:01:11 +00:00
|
|
|
private $rendered = false;
|
|
|
|
|
2011-04-14 16:59:41 +01:00
|
|
|
/**
|
|
|
|
* @param string $name
|
|
|
|
* @param mixed $value
|
2011-05-13 10:00:39 +01:00
|
|
|
*
|
|
|
|
* @return FormView The current view
|
2011-04-14 16:59:41 +01:00
|
|
|
*/
|
|
|
|
public function set($name, $value)
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-24 21:20:54 +00:00
|
|
|
$this->vars[$name] = $value;
|
2011-05-13 10:00:39 +01:00
|
|
|
|
|
|
|
return $this;
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-04-14 16:59:41 +01:00
|
|
|
/**
|
|
|
|
* @param $name
|
|
|
|
* @return Boolean
|
|
|
|
*/
|
|
|
|
public function has($name)
|
2011-02-25 00:11:53 +00:00
|
|
|
{
|
|
|
|
return array_key_exists($name, $this->vars);
|
|
|
|
}
|
|
|
|
|
2011-04-14 16:59:41 +01:00
|
|
|
/**
|
|
|
|
* @param $name
|
|
|
|
* @param $default
|
2011-05-10 14:32:14 +01:00
|
|
|
*
|
2011-04-14 16:59:41 +01:00
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function get($name, $default = null)
|
2011-02-19 12:46:32 +00:00
|
|
|
{
|
2011-04-14 16:59:41 +01:00
|
|
|
if (false === $this->has($name)) {
|
|
|
|
return $default;
|
2011-03-24 21:08:08 +00:00
|
|
|
}
|
2011-03-26 15:03:09 +00:00
|
|
|
|
|
|
|
return $this->vars[$name];
|
2011-02-19 12:46:32 +00:00
|
|
|
}
|
|
|
|
|
2011-04-14 16:59:41 +01:00
|
|
|
/**
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function all()
|
2011-02-28 15:50:23 +00:00
|
|
|
{
|
|
|
|
return $this->vars;
|
|
|
|
}
|
|
|
|
|
2011-04-14 16:59:41 +01:00
|
|
|
/**
|
|
|
|
* Alias of all so it is possible to do `form.vars.foo`
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getVars()
|
|
|
|
{
|
|
|
|
return $this->all();
|
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Sets the value for an attribute.
|
|
|
|
*
|
|
|
|
* @param string $name The name of the attribute
|
|
|
|
* @param string $value The value
|
2011-05-13 10:00:39 +01:00
|
|
|
*
|
|
|
|
* @return FormView The current view
|
2011-05-10 14:32:14 +01:00
|
|
|
*/
|
2011-04-07 08:57:44 +01:00
|
|
|
public function setAttribute($name, $value)
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-04-07 08:57:44 +01:00
|
|
|
$this->vars['attr'][$name] = $value;
|
2011-05-13 10:00:39 +01:00
|
|
|
|
|
|
|
return $this;
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Returns whether the attached form is rendered.
|
|
|
|
*
|
|
|
|
* @return Boolean Whether the form is rendered
|
|
|
|
*/
|
2011-04-07 08:57:44 +01:00
|
|
|
public function isRendered()
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-04-07 08:57:44 +01:00
|
|
|
return $this->rendered;
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Marks the attached form as rendered
|
2011-05-13 10:00:39 +01:00
|
|
|
*
|
|
|
|
* @return FormView The current view
|
2011-05-10 14:32:14 +01:00
|
|
|
*/
|
2011-04-07 08:57:44 +01:00
|
|
|
public function setRendered()
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-19 13:31:25 +00:00
|
|
|
$this->rendered = true;
|
2011-05-13 10:00:39 +01:00
|
|
|
|
|
|
|
return $this;
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Sets the parent view.
|
|
|
|
*
|
|
|
|
* @param FormView $parent The parent view
|
2011-05-13 10:00:39 +01:00
|
|
|
*
|
|
|
|
* @return FormView The current view
|
2011-05-10 14:32:14 +01:00
|
|
|
*/
|
2011-05-11 22:11:43 +01:00
|
|
|
public function setParent(FormView $parent = null)
|
2011-03-27 22:43:14 +01:00
|
|
|
{
|
2011-04-07 08:57:44 +01:00
|
|
|
$this->parent = $parent;
|
2011-05-13 10:00:39 +01:00
|
|
|
|
|
|
|
return $this;
|
2011-03-27 22:43:14 +01:00
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Returns the parent view.
|
|
|
|
*
|
|
|
|
* @return FormView The parent view
|
|
|
|
*/
|
2011-03-24 21:20:54 +00:00
|
|
|
public function getParent()
|
|
|
|
{
|
|
|
|
return $this->parent;
|
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
2011-05-29 15:19:02 +01:00
|
|
|
* Returns whether this view has a parent.
|
2011-05-10 14:32:14 +01:00
|
|
|
*
|
|
|
|
* @return Boolean Whether this view has a parent
|
|
|
|
*/
|
2011-03-26 15:03:09 +00:00
|
|
|
public function hasParent()
|
|
|
|
{
|
|
|
|
return null !== $this->parent;
|
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Sets the children view.
|
|
|
|
*
|
|
|
|
* @param array $children The children as instances of FormView
|
2011-05-13 10:00:39 +01:00
|
|
|
*
|
|
|
|
* @return FormView The current view
|
2011-05-10 14:32:14 +01:00
|
|
|
*/
|
2011-04-07 08:57:44 +01:00
|
|
|
public function setChildren(array $children)
|
|
|
|
{
|
|
|
|
$this->children = $children;
|
2011-05-13 10:00:39 +01:00
|
|
|
|
|
|
|
return $this;
|
2011-04-07 08:57:44 +01:00
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Returns the children.
|
|
|
|
*
|
|
|
|
* @return array The children as instances of FormView
|
|
|
|
*/
|
2011-03-24 21:20:54 +00:00
|
|
|
public function getChildren()
|
|
|
|
{
|
|
|
|
return $this->children;
|
|
|
|
}
|
|
|
|
|
2011-05-30 13:57:33 +01:00
|
|
|
/**
|
|
|
|
* Returns a given child.
|
|
|
|
*
|
|
|
|
* @param string name The name of the child
|
|
|
|
*
|
|
|
|
* @return FormView The child view
|
|
|
|
*/
|
|
|
|
public function getChild($name)
|
|
|
|
{
|
|
|
|
return $this->children[$name];
|
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
2011-05-29 15:19:02 +01:00
|
|
|
* Returns whether this view has children.
|
2011-05-10 14:32:14 +01:00
|
|
|
*
|
|
|
|
* @return Boolean Whether this view has children
|
|
|
|
*/
|
2011-03-26 15:03:09 +00:00
|
|
|
public function hasChildren()
|
|
|
|
{
|
|
|
|
return count($this->children) > 0;
|
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Returns a child by name (implements \ArrayAccess).
|
|
|
|
*
|
|
|
|
* @param string $name The child name
|
|
|
|
*
|
|
|
|
* @return FormView The child view
|
|
|
|
*/
|
2011-03-02 21:56:20 +00:00
|
|
|
public function offsetGet($name)
|
|
|
|
{
|
2011-05-30 13:57:33 +01:00
|
|
|
return $this->getChild($name);
|
2011-03-02 21:56:20 +00:00
|
|
|
}
|
2011-03-24 22:54:56 +00:00
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Returns whether the given child exists (implements \ArrayAccess).
|
|
|
|
*
|
|
|
|
* @param string $name The child name
|
|
|
|
*
|
|
|
|
* @return Boolean Whether the child view exists
|
|
|
|
*/
|
2011-03-02 21:56:20 +00:00
|
|
|
public function offsetExists($name)
|
|
|
|
{
|
2011-03-26 15:03:09 +00:00
|
|
|
return isset($this->children[$name]);
|
2011-03-02 21:56:20 +00:00
|
|
|
}
|
2011-03-24 22:54:56 +00:00
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Implements \ArrayAccess.
|
|
|
|
*
|
|
|
|
* @throws \BadMethodCallException always as setting a child by name is not allowed
|
|
|
|
*/
|
2011-03-02 21:56:20 +00:00
|
|
|
public function offsetSet($name, $value)
|
|
|
|
{
|
|
|
|
throw new \BadMethodCallException('Not supported');
|
|
|
|
}
|
2011-03-24 22:54:56 +00:00
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Removes a child (implements \ArrayAccess).
|
|
|
|
*
|
|
|
|
* @param string $name The child name
|
|
|
|
*/
|
2011-03-02 21:56:20 +00:00
|
|
|
public function offsetUnset($name)
|
|
|
|
{
|
2011-05-04 17:21:49 +01:00
|
|
|
unset($this->children[$name]);
|
2011-03-02 21:56:20 +00:00
|
|
|
}
|
2011-03-26 11:25:47 +00:00
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Returns an iterator to iterate over children (implements \IteratorAggregate)
|
|
|
|
*
|
|
|
|
* @return \ArrayIterator The iterator
|
|
|
|
*/
|
2011-03-26 11:25:47 +00:00
|
|
|
public function getIterator()
|
|
|
|
{
|
2011-05-09 16:53:18 +01:00
|
|
|
if (count($this->children)) {
|
2011-03-26 11:25:47 +00:00
|
|
|
$this->rendered = true;
|
|
|
|
}
|
2011-03-26 15:03:09 +00:00
|
|
|
|
2011-05-09 16:53:18 +01:00
|
|
|
return new \ArrayIterator($this->children);
|
2011-03-26 11:25:47 +00:00
|
|
|
}
|
2011-04-02 13:14:18 +01:00
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Returns whether the given choice is a group.
|
|
|
|
*
|
|
|
|
* @param mixed $choice A choice
|
|
|
|
*
|
|
|
|
* @return Boolean Whether the choice is a group
|
|
|
|
*/
|
2011-04-02 13:14:18 +01:00
|
|
|
public function isChoiceGroup($choice)
|
|
|
|
{
|
|
|
|
return is_array($choice) || $choice instanceof \Traversable;
|
|
|
|
}
|
|
|
|
|
2011-05-10 14:32:14 +01:00
|
|
|
/**
|
|
|
|
* Returns whether the given choice is selected.
|
|
|
|
*
|
|
|
|
* @param mixed $choice The choice
|
|
|
|
*
|
|
|
|
* @return Boolean Whether the choice is selected
|
|
|
|
*/
|
2011-04-02 13:14:18 +01:00
|
|
|
public function isChoiceSelected($choice)
|
|
|
|
{
|
2011-04-18 14:07:12 +01:00
|
|
|
$choice = FormUtil::toArrayKey($choice);
|
2011-04-02 13:14:18 +01:00
|
|
|
|
2011-04-02 17:26:28 +01:00
|
|
|
// The value should already have been converted by value transformers,
|
|
|
|
// otherwise we had to do the conversion on every call of this method
|
|
|
|
if (is_array($this->vars['value'])) {
|
|
|
|
return false !== array_search($choice, $this->vars['value'], true);
|
2011-04-02 15:00:46 +01:00
|
|
|
}
|
|
|
|
|
2011-04-02 17:26:28 +01:00
|
|
|
return $choice === $this->vars['value'];
|
2011-04-02 13:14:18 +01:00
|
|
|
}
|
2011-04-16 12:54:31 +01:00
|
|
|
|
|
|
|
/**
|
2011-05-10 14:32:14 +01:00
|
|
|
* Implements \Countable.
|
|
|
|
*
|
|
|
|
* @return integer The number of children views
|
2011-04-16 12:54:31 +01:00
|
|
|
*/
|
|
|
|
public function count()
|
|
|
|
{
|
|
|
|
return count($this->children);
|
|
|
|
}
|
2011-03-24 21:08:08 +00:00
|
|
|
}
|