NAME

JavaScript::Writer - JavaScript code generation from Perl.

SYNOPSIS

    use JavaScript::Writer;

    my $js = JavaScript::Writer->new;

    # Call alert("Nihao")
    $js->call("alert", "Nihao");

    # Similar, but display Perl-localized message of "Nihao". (that might be "哈囉")
    $js->call("alert", _("Nihao") );

    # Overload

DESCRIPTION

As you can see, this module is trying to simulate what RJS does. It's meant to be used in some web app framework, or for those who are generate javascript code from perl data.

It requires you loaded several javascript librarys in advance, then use its call method to call a certain functions from your library.

INTERFACE

new()

Object constructor. Takes nothing, gives you an javascript writer object.

call( $function, $arg1, $arg2, $arg3, ...)

Call an javascript function with arguments. Arguments are given in perl's native form, you don't need to use JSON module to serialized it first. (Unless, of course, that's your purpose: to get a JSON string in JavaScript.)

var( $name, [ $value ] )

Declare a value named $name with a optional default value $value. $value could be an arrayref, hashref, or scalar.

object( $object )

Give the object name for next function call. The preferred usage is:

    $js->object("Widget.Lightbox")->show("Nihao")

Which will then generated this javascript code snippet:

    Widget.Lightbox.show("Nihao")

while( $condition => $code_ref )

$condition is a string (yes, just a string for now) of javascript code, and a $code_ref is used to generate the block required for this while block.

The output of 'while' statement look like this:

    while($condition) {
        $code
    }

if ( $codnition => $code_ref )

elsif ( $codnition => $code_ref )

else ( $code_ref )

These 3 methods forms a trinity to construct the if..elsif..else form of control structure. Of course, in JavaScript, it it's not called "elsif", but "else if". But hey, we're Perl people.

The arguements are pretty similar to while method. But these function use newline characters to deliminate them from others rather then using ";". That's the major difference between them and all other methods.

function( $code_ref )

This is a javascript function writer. It'll output something like this:

    function(){...}

The passed $code_ref is a callback to generate the function body. It'll be passed in a JavaScript::Writer object so you can use it to write more javascript statements. Here defines a function that simply slauts to you.

    my $js = JavaScript::Writer->new;
    my $f = $js->function(sub {
        my $js = shift;
        $js->alert("Nihao")
    })

The returned $f is a JavaScript::Writer::Function object that stringify to this string:

    function(){alert("Nihao")}

append( $statement )

Manually append a statement. With this function, you need to properly serialize everything to JSON. Make sure you now that what you're doing.

as_string()

Output your statements as a snippet of javascript code.

CONFIGURATION AND ENVIRONMENT

JavaScript::Writer requires no configuration files or environment variables.

DEPENDENCIES

Class::Accessor::Fast

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-javascript-writer@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Kang-min Liu <gugod@gugod.org>

LICENCE AND COPYRIGHT

Copyright (c) 2007, Kang-min Liu <gugod@gugod.org>.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.