1. Manuals
  2. Tumbleweed
  3. perl-Template-Plugin-JSON-Escape
  4. Template::Plugin::JSON::Escape(3pm)

Scroll to navigation

Template::Plugin::JSON::Escape(3) User Contributed Perl Documentation Template::Plugin::JSON::Escape(3)

NAME

Template::Plugin::JSON::Escape - Adds a .json vmethod and a json filter.

SYNOPSIS

    [% USE JSON.Escape( pretty => 1 ) %];
    <script type="text/javascript">
        var foo = [% foo.json %];
        var bar = [% json_string | json %]
    </script>
    or read in JSON
    [% USE JSON.Escape %]
    [% data = JSON.Escape.json_decode(json) %]
    [% data.thing %]

DESCRIPTION

This plugin allows you to embed JSON strings in HTML. In the output, special characters such as "<" and "&" are escaped as "\uxxxx" to prevent XSS attacks.

It also provides decoding function to keep compatibility with Template::Plugin::JSON.

FEATURES

USE JSON.Escape

Any options on the USE line are passed through to the JSON object, much like "to_json" in JSON.

json vmethod

A ".json" vmethod converts scalars, arrays and hashes into corresponding JSON strings.

    [% json_stuct = { foo => 42, bar => [ 1, 2, 3 ] } %]
    
    <script>
        var json = [% json_struct.json %];
    </script>
    
    <span onclick="doSomething([% json_struct.json %]);">

json filter

A "json" filter escapes "<", ">", "&", "+", "U+2028" and "U+2029" as "\uxxxx". In the attribute, you may just use an "html" filter.

    [% json_string = '{ "foo": 42, "bar": [ 1, 2, 3 ] }' %]
    
    <script>
        var json = [% json_string | json %];
    </script>
    
    <span onclick="doSomething([% json_string | html %]);">

json_decode method

A "json_decode" method allow you to convert from a JSON string into a corresponding data structure.

    [% SET json_struct = JSON.Escape.json_decode(json_string) %]
    [% json_struct.foo | html %]

SEE ALSO

Template::Plugin::JSON, JSON, Template::Plugin

VERSION CONTROL

<https://github.com/nanto/perl-Template-Plugin-JSON-Escape>

AUTHOR

nanto_vi (TOYAMA Nao) <nanto@moon.email.ne.jp>

COPYRIGHT & LICENSE

Copyright (c) 2011 nanto_vi (TOYAMA Nao).

Copyright (c) 2006, 2008 Infinity Interactive, Yuval Kogman.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

2020-11-24 perl v5.40.0