ElementTray.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

namespace Xoops\Form;

class ElementTray extends Element implements ContainerInterface
{
    protected $elements = array();

    protected $required = array();

    protected $delimiter;

    public function __construct($caption, $delimiter = "&nbsp;", $name = "")
    {
        $this->setName($name);
        $this->setCaption($caption);
        $this->delimiter = $delimiter;
    }

    public function isRequired()
    {
        return !empty($this->required);
    }

    public function addElement(Element $formElement, $required = false)
    {
        $this->elements[] = $formElement;
        if ($formElement instanceof ContainerInterface) {
            /* @var $formElement ContainerInterface */
            $required_elements = $formElement->getRequired();
            $count = count($required_elements);
            for ($i = 0; $i < $count; ++$i) {
                $this->required[] = $required_elements[$i];
            }
        } else {
            if ($required) {
                $formElement->setRequired();
                $this->required[] = $formElement;
            }
        }
    }

    public function getRequired()
    {
        return $this->required;
    }

    public function getElements($recursively = false)
    {
        if (!$recursively) {
            return $this->elements;
        } else {
            $ret = array();
            foreach ($this->elements as $ele) {
                if ($ele instanceof ContainerInterface) {
                    /* @var ContainerInterface $ele */
                    $elements = $ele->getElements(true);
                    foreach ($elements as $ele2) {
                        $ret[] = $ele2;
                    }
                    unset($elements);
                    unset($ele2);
                } else {
                    $ret[] = $ele;
                }
                unset($ele);
            }
            return $ret;
        }
    }

    public function getDelimiter($encode = false)
    {
        return $encode ? htmlspecialchars(str_replace('&nbsp;', ' ', $this->delimiter)) : $this->delimiter;
    }

    public function render()
    {
        $count = 0;
        $ret = "";
        foreach ($this->getElements() as $ele) {
            /* @var Element $ele */
            if ($count > 0) {
                $ret .= $this->getDelimiter();
            }
            if ($ele->getCaption() != '') {
                $ret .= $ele->getCaption() . "&nbsp;";
            }
            $ret .= $ele->render() . NWLINE;
            if (!$ele->isHidden()) {
                ++$count;
            }
        }
        return $ret;
    }
}