AJAX.php

Go to the documentation of this file.

<?php
// {{{ license

// +----------------------------------------------------------------------+
// | FastFrame Application Framework                                      |
// +----------------------------------------------------------------------+
// | Copyright (c) 2002-2006 The Codejanitor Group                        |
// +----------------------------------------------------------------------+
// | This source file is subject to the GNU Lesser Public License (LGPL), |
// | that is bundled with this package in the file LICENSE, and is        |
// | available at through the world-wide-web at                           |
// | http://www.fsf.org/copyleft/lesser.html                              |
// | If you did not receive a copy of the LGPL and are unable to          |
// | obtain it through the world-wide-web, you can get it by writing the  |
// | Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
// | MA 02111-1307, USA.                                                  |
// +----------------------------------------------------------------------+
// | Authors: The Horde Team <http://www.horde.org>                       |
// |          Jason Rust <jrust@codejanitor.com>                          |
// |          Dan Allen <dan@mojavelinux.com>                             |
// +----------------------------------------------------------------------+

// }}}
// {{{ class FF_Output_AJAX

// }}}
class FF_Output_AJAX extends FF_Output {
    // {{{ properties

    var $_xml = '';

    var $_nodes = array();

    // }}}
    // {{{ display()

    function display()
    {
        $this->_renderMessages();
        foreach ($this->_nodes as $s_key => $val) {
            if (is_array($val) && count($val) == 1) {
                $this->_xml .= $this->arrayToXML(current($val), $s_key, key($val));
            }
            else {
                $this->_xml .= $this->arrayToXML(array($s_key => $val));
            }
        }

        header('Content-Type: text/xml');
        print '<?xml version="1.0" encoding="ISO-8859-1"?>';
        print '<ajax>';
        print $this->_xml;
        print '</ajax>';
    }

    // }}}
    // {{{ addNode()

    function addNode($in_key, $in_value, $in_nodeName = null)
    {
        if (is_null($in_nodeName)) {
            $this->_nodes[$in_key] = $in_value;
        }
        else {
            $this->_nodes[$in_key] = array($in_nodeName => $in_value);
        }
    }

    // }}}
    // {{{ arrayToXML()

    function arrayToXML($in_array, $in_topNode = null, $in_nodeName = 'el', $in_level = 1) 
    {
        $s_xml = '';
        if ($in_level == 1 && !is_null($in_topNode)) {
            $s_xml .= "<$in_topNode>";
        }

        foreach ($in_array as $key => $value) {
            if (is_array($value)) {
                // Here we handle integer keys
                // NOTE: We don't handle mixed int/string arrays
                if (isset($value[0])) {
                    $s_xml .= $this->arrayToXML($value, $in_topNode, $key, $in_level);
                }
                else {
                    if (is_int($key)) {
                        $key = $in_nodeName;
                    }

                    $s_xml .= "<$key>";
                    $s_xml .= $this->arrayToXML($value, $key, $in_nodeName, $in_level + 1);
                    $s_xml .= "</$key>";
                }
            }
            else {
                // Remove control characters -- breaks XML
                $value = preg_replace('/[[:cntrl:]]/', '', $value);
                if (trim($value) == '') {
                    $s_xml .= "<$key />";
                }
                else if (htmlspecialchars($value) != $value) {
                    $s_xml .= "<$key><![CDATA[$value]]></$key>";
                } 
                else {
                    $s_xml .= "<$key>$value</$key>";
                }
            } 
        }

        if ($in_level == 1 && !is_null($in_topNode)) {
            $s_xml .= "</$in_topNode>";
        }

        return $s_xml;
    }

    // }}}
    // {{{ setMessage()

    function setMessage($in_message, $in_mode = FASTFRAME_NORMAL_MESSAGE, $in_top = false)
    {
        parent::setMessage($in_message, $in_mode, $in_top);
        // If it's an error then we assume the operation failed, so send out the error code.
        if ($in_mode == FASTFRAME_ERROR_MESSAGE) {
            header('HTTP/1.0 500 Unsuccessful Action');
        }
    }

    // }}}
    // {{{ _renderMessages()

    function _renderMessages()
    {
        $a_messages = array();
        foreach ($this->messages as $a_message) {
            $a_messages[] = array('txt' => $a_message[0], 'type' => $a_message[1]);
        }

        $this->addNode('msgs', $a_messages, 'msg');
    }

    // }}}
}
?>

---