This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
symfony/src/Symfony/Component/Form/FormView.php

289 lines
5.8 KiB
PHP
Raw Normal View History

<?php
/*
* This file is part of the Symfony package.
*
2011-04-24 12:59:46 +01:00
* (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;
class FormView implements \ArrayAccess, \IteratorAggregate, \Countable
{
private $vars = array(
'value' => null,
2011-05-10 14:32:14 +01:00
'attr' => array(),
);
private $parent;
private $children = array();
/**
* Is the form attached to this renderer rendered?
*
* 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.
*
* @var Boolean
*/
private $rendered = false;
/**
* @param string $name
* @param mixed $value
*
* @return FormView The current view
*/
public function set($name, $value)
{
$this->vars[$name] = $value;
return $this;
}
/**
* @param $name
2011-12-13 07:50:54 +00:00
*
* @return Boolean
*/
public function has($name)
{
return array_key_exists($name, $this->vars);
}
/**
* @param $name
* @param $default
2011-05-10 14:32:14 +01:00
*
* @return mixed
*/
public function get($name, $default = null)
{
if (false === $this->has($name)) {
return $default;
}
return $this->vars[$name];
}
/**
* @return array
*/
public function all()
{
return $this->vars;
}
/**
* 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
*
* @return FormView The current view
2011-05-10 14:32:14 +01:00
*/
public function setAttribute($name, $value)
{
$this->vars['attr'][$name] = $value;
return $this;
}
2011-05-10 14:32:14 +01:00
/**
* Returns whether the attached form is rendered.
*
* @return Boolean Whether the form is rendered
*/
public function isRendered()
{
2011-06-09 16:33:42 +01:00
$hasChildren = 0 < count($this->children);
if (true === $this->rendered || !$hasChildren) {
return $this->rendered;
}
2011-06-09 16:33:42 +01:00
if ($hasChildren) {
foreach ($this->children as $child) {
if (!$child->isRendered()) {
return false;
}
}
return $this->rendered = true;
}
2011-06-09 16:33:42 +01:00
return false;
}
2011-05-10 14:32:14 +01:00
/**
* Marks the attached form as rendered
*
* @return FormView The current view
2011-05-10 14:32:14 +01:00
*/
public function setRendered()
{
$this->rendered = true;
return $this;
}
2011-05-10 14:32:14 +01:00
/**
* Sets the parent view.
*
* @param FormView $parent The parent view
*
* @return FormView The current view
2011-05-10 14:32:14 +01:00
*/
public function setParent(FormView $parent = null)
{
$this->parent = $parent;
return $this;
}
2011-05-10 14:32:14 +01:00
/**
* Returns the parent view.
*
* @return FormView The parent view
*/
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
*/
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
*
* @return FormView The current view
2011-05-10 14:32:14 +01:00
*/
public function setChildren(array $children)
{
$this->children = $children;
return $this;
}
2011-05-10 14:32:14 +01:00
/**
* Returns the children.
*
* @return array The children as instances of FormView
*/
public function getChildren()
{
return $this->children;
}
2011-05-30 13:57:33 +01:00
/**
* Returns a given child.
*
2011-12-13 07:50:54 +00:00
* @param string $name The name of the child
2011-05-30 13:57:33 +01:00
*
* @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
*/
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
*/
public function offsetGet($name)
{
2011-05-30 13:57:33 +01:00
return $this->getChild($name);
}
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
*/
public function offsetExists($name)
{
return isset($this->children[$name]);
}
2011-05-10 14:32:14 +01:00
/**
* Implements \ArrayAccess.
*
* @throws \BadMethodCallException always as setting a child by name is not allowed
*/
public function offsetSet($name, $value)
{
throw new \BadMethodCallException('Not supported');
}
2011-05-10 14:32:14 +01:00
/**
* Removes a child (implements \ArrayAccess).
*
* @param string $name The child name
*/
public function offsetUnset($name)
{
unset($this->children[$name]);
}
2011-05-10 14:32:14 +01:00
/**
* Returns an iterator to iterate over children (implements \IteratorAggregate)
*
* @return \ArrayIterator The iterator
*/
public function getIterator()
{
2011-05-09 16:53:18 +01:00
return new \ArrayIterator($this->children);
}
/**
2011-05-10 14:32:14 +01:00
* Implements \Countable.
*
* @return integer The number of children views
*/
public function count()
{
return count($this->children);
}
}