formelementtray.php

Go to the documentation of this file.

<?php
defined('XOOPS_ROOT_PATH') or die('Restricted access');

class XoopsFormElementTray extends XoopsFormElement {
        var $_elements = array();

        var $_required = array();

        var $_delimeter;

        function XoopsFormElementTray( $caption, $delimeter = "&nbsp;", $name = "" ) {
                $this->setName( $name );
                $this->setCaption( $caption );
                $this->_delimeter = $delimeter;
        }

        function isContainer() {
                return true;
        }

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

        function addElement( &$formElement, $required = false ) {
                $this->_elements[] = $formElement;
                if ( !$formElement->isContainer() ) {
                        if ( $required ) {
                                $formElement->_required = true;
                                $this->_required[] = $formElement;
                        }
                } else {
                        $required_elements = $formElement->getRequired();
                        $count = count( $required_elements );
                        for ( $i = 0 ; $i < $count; $i++ ) {
                                $this->_required[] = &$required_elements[$i];
                        }
                }
        }

        function &getRequired() {
                return $this->_required;
        }

        function &getElements( $recurse = false ) {
                if ( !$recurse ) {
                        return $this->_elements;
                } else {
                        $ret = array();
                        $count = count( $this->_elements );
                        for ( $i = 0; $i < $count; $i++ ) {
                                if ( !$this->_elements[$i]->isContainer() ) {
                                        $ret[] = &$this->_elements[$i];
                                } else {
                                        $elements = &$this->_elements[$i]->getElements( true );
                                        $count2 = count( $elements );
                                        for ( $j = 0; $j < $count2; $j++ ) {
                                                $ret[] = &$elements[$j];
                                        }
                                        unset( $elements );
                                }
                        }
                        return $ret;
                }
        }

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

        function render() {
                $count = 0;
                $ret = "";
                foreach ( $this->getElements() as $ele ) {
                        if ( $count > 0 ) {
                                $ret .= $this->getDelimeter();
                        }
                        if ( $ele->getCaption() != '' ) {
                                $ret .= $ele->getCaption() . "&nbsp;";
                        }
                        $ret .= $ele->render() . NWLINE ;
                        if ( !$ele->isHidden() ) {
                                $count++;
                        }
                }
                return $ret;
        }
}

?>