<?php /* vim: set binary expandtab tabstop=4 shiftwidth=4 textwidth=80:
-------------------------------------------------------------------------------
                                    mlib
-------------------------------------------------------------------------------
This file is part of mlib.

mlib is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.

mlib 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. See the GNU Lesser General Public License for more 
details.
 
You should have received a copy of the GNU Lesser General Public License; if 
not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
Boston, MA  02111-1307  USA
-------------------------------------------------------------------------------
Created: lun ago  2 10:48:51 ART 2004
Authors: Martín Marrese <m_marrese@argentina.com>
         Leandro Lucarella <luca@llucax.hn.org>
-------------------------------------------------------------------------------
$Id$
-----------------------------------------------------------------------------*/

require_once 'MLIB/Widget.php';

/**
 * Container base class.
 * 
 * @todo Add a global example using all the methods.
 * @author Leandro Lucarella <luca@llucax.hn.org>
 * @author Martín Marrese <m_marrese@argentina.com>
 * @since  1.0
 */
class MLIB_Widget_Container extends MLIB_Widget {

    /**
     * Contents of the widget.
     *
     * @protected
     */
    var $contents = array ();
    
    /**
     * Adds new content to the container and returns the corresponding key.
     *
     * @param $content New content.
     *
     * @return Key
     * @todo Add an example.
     */
    function addContent($content)
    {
        $this->contents[] = $content;
        return key($this->contents);
    }

    /**
     * Sets new content erasing previous one.ng key.
     *
     * @param $content New content. It can be a single component or an array of
     *                 components.
     *
     * @todo Add an example.
     */
    function setContent($content)
    {
        if (is_array($content))
        {
            $this->contents = $content;
        }
        else
        {
            $this->contents = array ($content);
        }
    }

    /**
     * Gets a content.
     *
     * @param $raw If is true, this method will return the contents array, 
     *             otherwise it will return a string as result of joining the 
     *             array components.
     *
     * @return mixed
     * @todo Add an example.
     */
    function getContent($raw = false)
    {
        if ($raw)
        {
            return $this->contents;            
        }
        else
        {
            $output = '';
            foreach ($this->contents as $content)
            {
                if (is_object($content))
                {
                    $output .= $content->__toString();
                }
                else
                {
                    $output .= $content;  
                }
            }
        }
    }
}
?>