2011-02-18 19:17:44 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This file is part of the Symfony package.
|
|
|
|
*
|
|
|
|
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Symfony\Component\Form\Renderer;
|
|
|
|
|
2011-03-20 12:35:19 +00:00
|
|
|
use Symfony\Component\Form\FormInterface;
|
2011-03-27 22:39:01 +01:00
|
|
|
use Symfony\Component\Form\Renderer\Theme\ThemeInterface;
|
|
|
|
use Symfony\Component\Form\Renderer\Theme\ThemeFactoryInterface;
|
2011-04-02 17:26:28 +01:00
|
|
|
use Symfony\Component\Form\Util\ChoiceUtil;
|
2011-02-18 19:17:44 +00:00
|
|
|
|
2011-03-27 22:39:01 +01:00
|
|
|
class ThemeRenderer implements ThemeRendererInterface, \ArrayAccess, \IteratorAggregate
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-26 15:03:09 +00:00
|
|
|
private $blockHistory = array();
|
2011-03-24 13:27:21 +00:00
|
|
|
|
|
|
|
private $themeFactory;
|
2011-02-18 19:17:44 +00:00
|
|
|
|
2011-03-24 09:55:12 +00:00
|
|
|
private $theme;
|
2011-02-18 19:17:44 +00:00
|
|
|
|
2011-04-02 13:14:18 +01:00
|
|
|
private $vars = array(
|
|
|
|
'value' => null,
|
|
|
|
'choices' => array(),
|
|
|
|
'preferred_choices' => array(),
|
|
|
|
'attr' => array(),
|
|
|
|
);
|
2011-02-18 19:17:44 +00:00
|
|
|
|
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-03-26 15:03:09 +00:00
|
|
|
private $parent;
|
|
|
|
|
2011-03-24 21:20:54 +00:00
|
|
|
private $children = array();
|
|
|
|
|
2011-03-27 22:39:01 +01:00
|
|
|
public function __construct(ThemeFactoryInterface $themeFactory)
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-24 13:27:21 +00:00
|
|
|
$this->themeFactory = $themeFactory;
|
2011-03-26 15:03:09 +00:00
|
|
|
}
|
2011-02-18 19:17:44 +00:00
|
|
|
|
2011-03-26 15:03:09 +00:00
|
|
|
public function setParent(self $parent)
|
|
|
|
{
|
|
|
|
$this->parent = $parent;
|
|
|
|
}
|
2011-03-25 15:37:14 +00:00
|
|
|
|
2011-03-26 15:03:09 +00:00
|
|
|
public function setChildren(array $children)
|
|
|
|
{
|
|
|
|
$this->children = $children;
|
2011-03-18 11:50:26 +00:00
|
|
|
}
|
|
|
|
|
2011-03-24 13:27:21 +00:00
|
|
|
public function setTemplate($template)
|
|
|
|
{
|
|
|
|
$this->setTheme($this->themeFactory->create($template));
|
|
|
|
}
|
|
|
|
|
2011-03-27 22:39:01 +01:00
|
|
|
public function setTheme(ThemeInterface $theme)
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-24 09:55:12 +00:00
|
|
|
$this->theme = $theme;
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-03-24 09:55:12 +00:00
|
|
|
public function getTheme()
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-26 18:39:31 +00:00
|
|
|
if (!$this->theme && $this->parent) {
|
|
|
|
return $this->parent->getTheme();
|
|
|
|
}
|
|
|
|
|
2011-03-24 09:55:12 +00:00
|
|
|
return $this->theme;
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-03-24 13:27:21 +00:00
|
|
|
public function setBlock($block)
|
|
|
|
{
|
2011-03-26 15:03:09 +00:00
|
|
|
array_unshift($this->blockHistory, $block);
|
2011-03-24 13:27:21 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public function getBlock()
|
|
|
|
{
|
2011-03-26 15:03:09 +00:00
|
|
|
reset($this->blockHistory);
|
|
|
|
|
|
|
|
return current($this->block);
|
2011-03-24 13:27:21 +00:00
|
|
|
}
|
|
|
|
|
2011-02-21 17:16:40 +00:00
|
|
|
public function setVar($name, $value)
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-24 21:20:54 +00:00
|
|
|
$this->vars[$name] = $value;
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-03-24 21:08:08 +00:00
|
|
|
public function setAttribute($name, $value)
|
|
|
|
{
|
|
|
|
$this->vars['attr'][$name] = $value;
|
|
|
|
}
|
|
|
|
|
2011-02-25 00:11:53 +00:00
|
|
|
public function hasVar($name)
|
|
|
|
{
|
|
|
|
return array_key_exists($name, $this->vars);
|
|
|
|
}
|
|
|
|
|
2011-02-21 17:16:40 +00:00
|
|
|
public function getVar($name)
|
2011-02-19 12:46:32 +00:00
|
|
|
{
|
2011-03-26 15:03:09 +00:00
|
|
|
if (!isset($this->vars[$name])) {
|
|
|
|
return null;
|
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-02-28 15:50:23 +00:00
|
|
|
public function getVars()
|
|
|
|
{
|
|
|
|
return $this->vars;
|
|
|
|
}
|
|
|
|
|
2011-02-28 16:01:11 +00:00
|
|
|
public function isRendered()
|
|
|
|
{
|
|
|
|
return $this->rendered;
|
|
|
|
}
|
|
|
|
|
2011-02-21 17:16:40 +00:00
|
|
|
public function getWidget(array $vars = array())
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-02-28 16:01:11 +00:00
|
|
|
$this->rendered = true;
|
|
|
|
|
2011-03-28 10:22:27 +01:00
|
|
|
return $this->renderPart('widget', $vars);
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-02-21 17:16:40 +00:00
|
|
|
public function getErrors(array $vars = array())
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-28 10:22:27 +01:00
|
|
|
return $this->renderPart('errors', $vars);
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-02-21 17:16:40 +00:00
|
|
|
public function getRow(array $vars = array())
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-19 13:31:25 +00:00
|
|
|
$this->rendered = true;
|
|
|
|
|
2011-03-28 10:22:27 +01:00
|
|
|
return $this->renderPart('row', $vars);
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-02-28 15:50:23 +00:00
|
|
|
public function getRest(array $vars = array())
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-28 10:22:27 +01:00
|
|
|
return $this->renderPart('rest', $vars);
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2011-03-21 19:56:33 +00:00
|
|
|
* Renders the label of the given form
|
2011-02-18 19:17:44 +00:00
|
|
|
*
|
2011-03-21 19:56:33 +00:00
|
|
|
* @param FormInterface $form The form to render the label for
|
2011-03-24 13:27:21 +00:00
|
|
|
* @param array $params Additional variables passed to the block
|
2011-02-18 19:17:44 +00:00
|
|
|
*/
|
2011-02-21 17:16:40 +00:00
|
|
|
public function getLabel($label = null, array $vars = array())
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
|
|
|
if (null !== $label) {
|
2011-02-21 17:16:40 +00:00
|
|
|
$vars['label'] = $label;
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-03-28 10:22:27 +01:00
|
|
|
return $this->renderPart('label', $vars);
|
2011-02-18 19:17:44 +00:00
|
|
|
}
|
|
|
|
|
2011-03-17 13:40:34 +00:00
|
|
|
public function getEnctype()
|
|
|
|
{
|
2011-03-28 10:22:27 +01:00
|
|
|
return $this->renderPart('enctype', $this->vars);
|
2011-03-17 13:40:34 +00:00
|
|
|
}
|
|
|
|
|
2011-03-27 22:43:14 +01:00
|
|
|
protected function renderPart($part, array $vars = array())
|
2011-02-18 19:17:44 +00:00
|
|
|
{
|
2011-03-26 18:39:31 +00:00
|
|
|
return $this->getTheme()->render($this->blockHistory, $part, array_replace(
|
2011-02-21 17:16:40 +00:00
|
|
|
$this->vars,
|
|
|
|
$vars
|
2011-02-18 19:17:44 +00:00
|
|
|
));
|
|
|
|
}
|
2011-03-24 22:54:56 +00:00
|
|
|
|
2011-03-27 22:43:14 +01:00
|
|
|
public function render(array $vars = array())
|
|
|
|
{
|
|
|
|
return $this->getWidget($vars);
|
|
|
|
}
|
|
|
|
|
2011-03-24 21:20:54 +00:00
|
|
|
public function getParent()
|
|
|
|
{
|
|
|
|
return $this->parent;
|
|
|
|
}
|
|
|
|
|
2011-03-26 15:03:09 +00:00
|
|
|
public function hasParent()
|
|
|
|
{
|
|
|
|
return null !== $this->parent;
|
|
|
|
}
|
|
|
|
|
2011-03-24 21:20:54 +00:00
|
|
|
public function getChildren()
|
|
|
|
{
|
|
|
|
return $this->children;
|
|
|
|
}
|
|
|
|
|
2011-03-26 15:03:09 +00:00
|
|
|
public function hasChildren()
|
|
|
|
{
|
|
|
|
return count($this->children) > 0;
|
|
|
|
}
|
|
|
|
|
2011-03-02 21:56:20 +00:00
|
|
|
public function offsetGet($name)
|
|
|
|
{
|
2011-03-26 15:03:09 +00:00
|
|
|
return $this->children[$name];
|
2011-03-02 21:56:20 +00:00
|
|
|
}
|
2011-03-24 22:54:56 +00:00
|
|
|
|
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-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-03-02 21:56:20 +00:00
|
|
|
public function offsetUnset($name)
|
|
|
|
{
|
|
|
|
throw new \BadMethodCallException('Not supported');
|
|
|
|
}
|
2011-03-26 11:25:47 +00:00
|
|
|
|
|
|
|
public function getIterator()
|
|
|
|
{
|
2011-03-26 15:03:09 +00:00
|
|
|
if (isset($this->children)) {
|
2011-03-26 11:25:47 +00:00
|
|
|
$this->rendered = true;
|
2011-03-26 15:03:09 +00:00
|
|
|
|
|
|
|
return new \ArrayIterator($this->children);
|
2011-03-26 11:25:47 +00:00
|
|
|
}
|
2011-03-26 15:03:09 +00:00
|
|
|
|
2011-03-26 11:25:47 +00:00
|
|
|
return new \ArrayIterator(array());
|
|
|
|
}
|
2011-04-02 13:14:18 +01:00
|
|
|
|
|
|
|
public function getChoiceLabel($choice)
|
|
|
|
{
|
|
|
|
return isset($this->vars['choices'][$choice])
|
|
|
|
? $this->vars['choices'][$choice]
|
|
|
|
: (isset($this->vars['preferred_choices'][$choice])
|
|
|
|
? $this->cars['preferred_choices'][$choice]
|
|
|
|
: null
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
public function isChoiceGroup($choice)
|
|
|
|
{
|
|
|
|
return is_array($choice) || $choice instanceof \Traversable;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function isChoiceSelected($choice)
|
|
|
|
{
|
2011-04-02 17:26:28 +01:00
|
|
|
$choice = ChoiceUtil::toValidChoice($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-03-24 21:08:08 +00:00
|
|
|
}
|