Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 363 lines (323 sloc) 8.67 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
<?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;

/**
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class FormView implements \ArrayAccess, \IteratorAggregate, \Countable
{
    /**
* The variables assigned to this view.
* @var array
*/
    public $vars = array(
        'value' => null,
        'attr' => array(),
    );

    /**
* The parent view.
* @var FormView
*/
    public $parent;

    /**
* The child views.
* @var array
*/
    public $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;

    public function __construct(FormView $parent = null)
    {
        $this->parent = $parent;
    }

    /**
* Returns the name of the form.
*
* @return string The form name.
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link vars} instead which contains an
* entry named "name".
*/
    public function getName()
    {
        return $this->vars['name'];
    }

    /**
* @param string $name
* @param mixed $value
*
* @return FormView The current view
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link vars} instead.
*/
    public function set($name, $value)
    {
        $this->vars[$name] = $value;

        return $this;
    }

    /**
* @param $name
*
* @return Boolean
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link vars} instead.
*/
    public function has($name)
    {
        return array_key_exists($name, $this->vars);
    }

    /**
* @param $name
* @param $default
*
* @return mixed
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link vars} instead.
*/
    public function get($name, $default = null)
    {
        if (false === $this->has($name)) {
            return $default;
        }

        return $this->vars[$name];
    }

    /**
* @return array
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link vars} instead.
*/
    public function all()
    {
        return $this->vars;
    }

    /**
* Returns the values of all view variables.
*
* @return array The values of all variables.
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link vars} instead.
*/
    public function getVars()
    {
        return $this->vars;
    }

    /**
* Sets the value for an attribute.
*
* @param string $name The name of the attribute
* @param string $value The value
*
* @return FormView The current view
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link vars} instead which contains an
* entry named "attr".
*/
    public function setAttribute($name, $value)
    {
        $this->vars['attr'][$name] = $value;

        return $this;
    }

    /**
* Returns whether the view was already rendered.
*
* @return Boolean Whether this view's widget is rendered.
*/
    public function isRendered()
    {
        $hasChildren = 0 < count($this->children);

        if (true === $this->rendered || !$hasChildren) {
            return $this->rendered;
        }

        if ($hasChildren) {
            foreach ($this->children as $child) {
                if (!$child->isRendered()) {
                    return false;
                }
            }

            return $this->rendered = true;
        }

        return false;
    }

    /**
* Marks the view as rendered.
*
* @return FormView The view object.
*/
    public function setRendered()
    {
        $this->rendered = true;

        return $this;
    }

    /**
* Sets the parent view.
*
* @param FormView $parent The parent view.
*
* @return FormView The view object.
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link parent} instead.
*/
    public function setParent(FormView $parent = null)
    {
        $this->parent = $parent;

        return $this;
    }

    /**
* Returns the parent view.
*
* @return FormView The parent view.
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link parent} instead.
*/
    public function getParent()
    {
        return $this->parent;
    }

    /**
* Returns whether this view has a parent.
*
* @return Boolean Whether this view has a parent
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link parent} instead.
*/
    public function hasParent()
    {
        return null !== $this->parent;
    }

    /**
* Sets the children view.
*
* @param array $children The children as instances of FormView
*
* @return FormView The current view
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link children} instead.
*/
    public function setChildren(array $children)
    {
        $this->children = $children;

        return $this;
    }

    /**
* Returns the children.
*
* @return array The children as instances of FormView
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link children} instead.
*/
    public function getChildren()
    {
        return $this->children;
    }

    /**
* Returns a given child.
*
* @param string $name The name of the child
*
* @return FormView The child view
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Access
* the public property {@link children} instead.
*/
    public function getChild($name)
    {
        return $this->children[$name];
    }

    /**
* Returns whether this view has any children.
*
* @return Boolean Whether the view has children.
*
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
* {@link count()} instead.
*/
    public function hasChildren()
    {
        return count($this->children) > 0;
    }

    /**
* Returns a child by name (implements \ArrayAccess).
*
* @param string $name The child name
*
* @return FormView The child view
*/
    public function offsetGet($name)
    {
        return $this->children[$name];
    }

    /**
* 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]);
    }

    /**
* Implements \ArrayAccess.
*
* @throws \BadMethodCallException always as setting a child by name is not allowed
*/
    public function offsetSet($name, $value)
    {
        throw new \BadMethodCallException('Not supported');
    }

    /**
* Removes a child (implements \ArrayAccess).
*
* @param string $name The child name
*/
    public function offsetUnset($name)
    {
        unset($this->children[$name]);
    }

    /**
* Returns an iterator to iterate over children (implements \IteratorAggregate)
*
* @return \ArrayIterator The iterator
*/
    public function getIterator()
    {
        return new \ArrayIterator($this->children);
    }

    /**
* Implements \Countable.
*
* @return integer The number of children views
*/
    public function count()
    {
        return count($this->children);
    }
}
Something went wrong with that request. Please try again.