New framework for AJAX services
[wip/koha-chris_n.git] / C4 / Output / JSONStream.pm
1 package C4::Output::JSONStream;
2 #
3 # Copyright 2008 LibLime
4 #
5 # This file is part of Koha.
6 #
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
10 # version.
11 #
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA  02111-1307 USA
19
20 =head1 NAME
21
22 C4::Output::JSONStream - progressively build JSON data
23
24 =head1 SYNOPSIS
25
26 my $json = new C4::Output::JSONStream;
27
28 $json->param( issues => [ 'yes!', 'please', 'no', { emphasis = 'NO' } ] );
29 $json->param( stuff => 'realia' );
30
31 print $json->output;
32
33 =head1 DESCRIPTION
34
35 This module allows you to build JSON incrementally.
36
37 =cut
38
39 use strict;
40 use warnings;
41
42 use JSON;
43
44 sub new {
45     my $class = shift;
46     my $self = {
47         data => {},
48         options => {}
49     };
50
51     bless $self, $class;
52
53     return $self;
54 }
55
56 sub param {
57     my $self = shift;
58
59     if ( @_ % 2 != 0 ) {
60         die 'param() received odd number of arguments (should be called with param => "value" pairs)';
61     }
62
63     for ( my $i = 0; $i < $#_; $i += 2 ) {
64         $self->{data}->{$_[$i]} = $_[$i + 1];
65     }
66 }
67
68 sub output {
69     my $self = shift;
70
71     return to_json( $self->{data} );
72 }
73
74 1;