kss.php 2.99 KB
Newer Older
Thimo Kraemer's avatar
Thimo Kraemer committed
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
<?php
/*
*  kss.php - Server-side KSS library
*
*  Copyright (c) 2017 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
$kss = new KSSResponse();

// Add a command
$kss->addCommand('setNodeAttr', '#my-selector', array(
    'name' => 'foo',
    'value' => 'bar',
));

// Or via dynamic method
$kss->setNodeAttr('#my-selector', array(
    'name' => 'foo',
    'value' => 'bar',
));

// Commands that do not require a selector
$kss->addCommand('alert', array(
    'message' => 'Hello!',
));

// Or via dynamic method
$kss->alert(array(
    'message' => 'Hello!',
));

// Finally send the KSS response as JSON
$kss->send();

// Or return it within an RPC service
return $kss->response;

*/

class KSSResponse
{
    function __construct($encoding='utf-8')
    {
        $this->encoding = $encoding;
        $this->response = array('commands' => array());
    }
    
    // Add a new KSS command
    // Either: addCommand('actionName', 'selector', array('param1'=>'value1'))
    // Or: addCommand('actionName', array('param1'=>'value1'))
    // Or: addCommand('actionName')
    function addCommand($action, ...$args)
    {
        if (count($args) == 1)
        {
            if (is_array($args[0])) // -> params
            {
                array_unshift($args, null);
            }
            else // string -> selector
            {
                array_push($args, null);
            }
        }
        
        $this->response['commands'][] = array(
            'action' => $action,
            'selector' => $args[0],
            'params' => $args[1],
            );
    }
    
    // Add a new KSS command via dynamic method
    // Either: actionName('selector', array('param1'=>'value1'))
    // Or: actionName(array('param1'=>'value1'))
    // Or: actionName()
    function __call($action, $args)
    {
        $this->addCommand($action, ...$args);
    }
    
    function __toString()
    {
        return json_encode($this->response);
    }
    
    // Send the KSS response out to the browser
    function send()
    {
        header('Content-Type: application/json; charset='.$this->encoding);
        $response = (string)$this;
        header('Content-Length: '.strlen($response));
        echo $response;
    }
}

?>