joonis Logo

PHP server-side KSS library

kss.php [5.26 KB]
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<?php
/*
*  kss.php - Server-side KSS library
*
*  Copyright (c) 2013 joonis new media
*  Author: Thimo Kraemer <thimo.kraemer@joonis.de>
*
*  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.
*
*  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., 51 Franklin Street, Fifth Floor, Boston,
*  MA 02110-1301, USA.

Usage:

// Load the server-side KSS library
require 'kss.php';

// Create a response instance (either 'xml' [default] or 'json')
$resp = new KSSResponse('xml', 'utf-8');

// Add a command and two parameters
$cmd = $resp->add_command('setKssAttribute', '#my-selector');
$cmd->set_param('name', 'foo');
$cmd->set_param('value', 'bar');

// or add all parameters as an array in one single step
$cmd = $resp->add_command('setKssAttribute', '#my-selector');
$cmd->set_params(array(
    'name' => 'foo',
    'value' => 'bar',
));

// or add the command and its parameters at once
$cmd = $resp->add_command('setKssAttribute', '#my-selector', '', array(
    'name' => 'foo',
    'value' => 'bar',
));

// Commands that do not require a selector
$cmd = $resp->add_command('alert');
$cmd->set_param('message', 'Hello!');

// Finally send the KSS response
$resp->send();

*/

// Represents a KSS command.
// It is not meant to be used directly! You get an instance
// via the 'add_command' method of a KSSResponse object.
class KSSCommand
{
    function __construct($name, $selector='', $selector_type='')
    {
        $this->name = $name;
        $this->selector = $selector;
        $this->selector_type = $selector_type;
        $this->params = array();
    }

    // Set a parameter of the KSS command.
    function set_param($name, $value)
    {
        $this->params[$name] = $value;
    }

    // Set more parameters of the KSS command via assoziative array.
    function set_params($params)
    {
        $this->params = array_merge($this->params, $params);
    }
}

// Represents a KSS response (XML or JSON).
class KSSResponse
{
    function __construct($format='xml', $encoding='utf-8')
    {
        $this->format = strtolower($format);
        $this->encoding = $encoding;
        $this->commands = array();
    }

    // Add and return a new KSS command.
    // Parameter arguments can be passed in via assoziative array.
    function add_command($name, $selector='', $selector_type='', $params=null)
    {
        $cmd = new KSSCommand($name, $selector, $selector_type);
        if ($params) {
            $cmd->set_params($params);
        }
        $this->commands[] = $cmd;
        return $cmd;
    }

    // Render and return the KSS response body.
    function render()
    {
        if ($this->format == 'xml') {
            $dom = new DOMDocument('1.0', $this->encoding);
            $kukit = $dom->createElement('kukit');
            $dom->appendChild($kukit);
            $commands = $dom->createElement('commands');
            $kukit->appendChild($commands);
            foreach ($this->commands as $cmd) {
                $command = $dom->createElement('command');
                $command->setAttribute('name', $cmd->name);
                $command->setAttribute('selector', $cmd->selector);
                $command->setAttribute('selectorType', $cmd->selector_type);
                $commands->appendChild($command);
                foreach ($cmd->params as $key => $value) {
                    $param = $dom->createElement('param');
                    $param->setAttribute('name', $key);
                    $cdata = $dom->createCDATASection($value);
                    $param->appendChild($cdata);
                    $command->appendChild($param);
                }
            }
            return $dom->saveXML();
        }
        else if ($this->format == 'json') {
            $json = array('commands' => array());
            foreach ($this->commands as $cmd) {
                $params = array();
                foreach ($cmd->params as $key => $value) {
                    $params[$key] = "$value";
                }
                $json['commands'][] = array(
                    'name' => $cmd->name,
                    'selector' => $cmd->selector,
                    'selectorType' => $cmd->selector_type,
                    'params' => $params,
                    );
            }
            return json_encode($json);
        }
        else {
            throw new Exception('Unknown format "'.$this->format.'"');
        }
    }

    // Send the KSS response out to the browser.
    function send()
    {
        if ($this->format == 'xml') {
            header('Content-Type: text/xml; charset='.$this->encoding);
        }
        else if ($this->format == 'json') {
            header('Content-Type: application/json; charset='.$this->encoding);
        }
        $body = $this->render();
        header('Content-Length: '.strlen($body));
        echo $body;
    }
}

?>

Kann ich
  Ihnen helfen?


Schreiben Sie mir
doch einfach unter
giraffe@joonis.de