<?php
#BEGIN_LICENSE
#-------------------------------------------------------------------------
# Module: CGExtensions (c) 2008-2014 by Robert Campbell
#         (calguy1000@cmsmadesimple.org)
#  An addon module for CMS Made Simple to provide useful functions
#  and commonly used gui capabilities to other modules.
#
#-------------------------------------------------------------------------
# CMSMS - CMS Made Simple is (c) 2005 by Ted Kulp (wishy@cmsmadesimple.org)
# Visit the CMSMS Homepage at: http://www.cmsmadesimple.org
#
#-------------------------------------------------------------------------
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# However, as a special exception to the GPL, this software is distributed
# as an addon module to CMS Made Simple.  You may not use this software
# in any Non GPL version of CMS Made simple, or in any version of CMS
# Made simple that does not indicate clearly and obviously in its admin
# section that the site was built with CMS Made simple.
#
# 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.  See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
# Or read it online: http://www.gnu.org/licenses/licenses.html#GPL
#
#-------------------------------------------------------------------------
#END_LICENSE

/**
 * The definition for the cge_message class.
 *
 * @package CGExtensions
 * @category Utilities
 * @author  calguy1000 <calguy1000@cmsmadesimple.org>
 * @copyright Copyright 2010 by Robert Campbell
 */

/**
 * A simple class for storing and retrieving data between requests.
 *
 * @package CGExtensions
 * @deprected
 */
final class cge_message
{
    /**
     * @ignore
     */
    private static $_data;

    /**
     * @ignore
     */
    private static function &_sess()
    {
        if( ! is_object(self::$_data) ) self::$_data = new cge_session(__CLASS__);
        return self::$_data;
    }

    /**
     * Set a message
     *
     * @param string $key
     * @param string $msg
     */
    public static function set($key,$msg)
    {
        self::_sess()->put($key,(string) $msg);
    }

    /**
     * Get a message
     *
     * @param string $key
     * @param string $dflt
     * @param bool   $erase Whether the data should be erased after retrieval.
     * @return string
     */
    public static function get($key,$dflt = null,$erase = TRUE)
    {
        $msg = self::_sess()->get($key,$dflt);
        if( $erase ) self::_sess()->clear($key);
        return $msg;
    }

    /**
     * Erase a message
     *
     * @param string $key
     */
    public static function erase($key)
    {
        $msg = self::_sess()->erase($key);
    }
} // end of class

?>
