Jifty::JSON(3pm) User Contributed Perl Documentation Jifty::JSON(3pm)NAME
Jifty::JSON -- Wrapper around JSON
SYNOPSIS
use Jifty::JSON qw/decode_json encode_json/;
my $obj = decode_json(q! { "x": "1", "y": "2", "z": "3" } !);
my $json = encode_json($obj);
DESCRIPTION
Provides a thin wrapper around the JSON 2.xx library, which provides a frontend for JSON::XS and JSON::PP.
This module used to wrap JSON::Syck and JSON 1.xx with special-casing for outputting JSON with single quoted values. Single quotes make it
easy to simply plop JSON into HTML attributes but are in violation of the JSON spec which mandates only double quoted strings.
The old behavior is now unsupported and it is recommended that you simply HTML escape your entire blob of JSON if you are sticking it in an
HTML attribute. You can use Jifty->web->escape() to properly escape problematic characters for HTML.
FUNCTIONS
decode_json JSON, [ARGUMENT HASHREF]
encode_json JSON, [ARGUMENT HASHREF]
These functions are just like JSON's, except that you can pass options to them like you can with JSON's "from_json" and "to_json"
functions.
By default they encode/decode using UTF8 (like JSON's functions of the same name), but you can turn that off by passing "utf8 => 0" in the
options. The allow_nonref flag is also enabled for backwards compatibility with earlier versions of this module. It allows
encoding/decoding of values that are not references.
JSON is imported with the "-support_by_pp" flag in order to support all options that JSON::PP provides when using JSON::XS as the backend.
If you are concerned with speed, be careful what options you specify as it may cause the pure Perl backend to be used. Read "JSON::PP
SUPPORT METHODS" in JSON for more information.
DEPRECATED FUNCTIONS
jsonToObj JSON, [ARGUMENTS]
objToJson JSON, [ARGUMENTS]
These functions are deprecated and provided for backwards compatibility. They wrap the appropriate function above, but "croak" in Carp if
you try to set the "singlequote" option.
LICENSE
Jifty is Copyright 2005-2010 Best Practical Solutions, LLC. Jifty is distributed under the same terms as Perl itself.
perl v5.14.2 2010-12-08 Jifty::JSON(3pm)
Check Out this Related Man Page
JSON::Any(3pm) User Contributed Perl Documentation JSON::Any(3pm)NAME
JSON::Any - Wrapper Class for the various JSON classes.
VERSION
Version 1.28
SYNOPSIS
This module tries to provide a coherent API to bring together the various JSON modules currently on CPAN. This module will allow you to
code to any JSON API and have it work regardless of which JSON module is actually installed.
use JSON::Any;
my $j = JSON::Any->new;
$json = $j->objToJson({foo=>'bar', baz=>'quux'});
$obj = $j->jsonToObj($json);
or
$json = $j->encode({foo=>'bar', baz=>'quux'});
$obj = $j->decode($json);
or
$json = $j->Dump({foo=>'bar', baz=>'quux'});
$obj = $j->Load($json);
or
$json = $j->to_json({foo=>'bar', baz=>'quux'});
$obj = $j->from_json($json);
or without creating an object:
$json = JSON::Any->objToJson({foo=>'bar', baz=>'quux'});
$obj = JSON::Any->jsonToObj($json);
On load, JSON::Any will find a valid JSON module in your @INC by looking for them in this order:
JSON::XS
JSON
JSON::DWIW
And loading the first one it finds.
You may change the order by specifying it on the "use JSON::Any" line:
use JSON::Any qw(DWIW XS JSON);
Specifying an order that is missing one of the modules will prevent that module from being used:
use JSON::Any qw(DWIW XS JSON);
This will check in that order, and will never attempt to load JSON::Syck. This can also be set via the $ENV{JSON_ANY_ORDER} environment
variable.
JSON::Syck has been deprecated by it's author, but in the attempt to still stay relevant as a "Compat Layer" JSON::Any still supports it.
This support however has been made optional starting with JSON::Any 1.19. In deference to a bug request starting with JSON 1.20 JSON::Syck
and other deprecated modules will still be installed, but only as a last resort and will now include a warning.
use JSON::Any qw(Syck XS JSON);
or
$ENV{JSON_ANY_ORDER} = 'Syck XS JSON';
WARNING: If you call JSON::Any with an empty list
use JSON::Any ();
It will skip the JSON package detection routines and will die loudly that it couldn't find a package.
DEPRECATION
The original need for JSON::Any has been solved (quite some time ago actually). If you're producing new code it is recommended to use
JSON.pm which will optionally use JSON::XS for speed purposes.
JSON::Any will continue to be maintained for compatibility with existing code, and frankly because the maintainer prefers the JSON::Any
API.
METHODS
"new"
Will take any of the parameters for the underlying system and pass them through. However these values don't map between JSON modules,
so, from a portability standpoint this is really only helpful for those parameters that happen to have the same name. This will be
addressed in a future release.
The one parameter that is universally supported (to the extent that is supported by the underlying JSON modules) is "utf8". When this
parameter is enabled all resulting JSON will be marked as unicode, and all unicode strings in the input data structure will be
preserved as such.
Also note that the "allow_blessed" parameter is recognised by all the modules that throw exceptions when a blessed reference is given
them meaning that setting it to true works for all modules. Of course, that means that you cannot set it to false intentionally in
order to always get such exceptions.
The actual output will vary, for example JSON will encode and decode unicode chars (the resulting JSON is not unicode) whereas JSON::XS
will emit unicode JSON.
"handlerType"
Takes no arguments, returns a string indicating which JSON Module is in use.
"handler"
Takes no arguments, if called on an object returns the internal JSON::* object in use. Otherwise returns the JSON::* package we are
using for class methods.
"true"
Takes no arguments, returns the special value that the internal JSON object uses to map to a JSON "true" boolean.
"false"
Takes no arguments, returns the special value that the internal JSON object uses to map to a JSON "false" boolean.
"objToJson"
Takes a single argument, a hashref to be converted into JSON. It returns the JSON text in a scalar.
"to_json"
"Dump"
"encode"
Aliases for objToJson, can be used interchangeably, regardless of the underlying JSON module.
"jsonToObj"
Takes a single argument, a string of JSON text to be converted back into a hashref.
"from_json"
"Load"
"decode"
Aliases for jsonToObj, can be used interchangeably, regardless of the underlying JSON module.
AUTHORS
Chris Thompson "cthom at cpan.org"
Chris Prather "chris at prather.org"
Robin Berjon "robin at berjon.com"
Marc Mims "marc at questright.com"
Tomas Doran "bobtfish at bobtfish.net"
BUGS
Please report any bugs or feature requests to "bug-json-any at rt.cpan.org", or through the web interface at
http://rt.cpan.org/NoAuth/ReportBug.html?Queue=JSON-Any <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=JSON-Any>. I will be notified, and
then you'll automatically be notified of progress on your bug as I make changes.
ACKNOWLEDGEMENTS
This module came about after discussions on irc.perl.org about the fact that there were now six separate JSON perl modules with different
interfaces.
In the spirit of Class::Any, JSON::Any was created with the considerable help of Matt 'mst' Trout.
Simon Wistow graciously supplied a patch for backwards compat with JSON::XS versions previous to 2.01
San Dimas High School Football Rules!
COPYRIGHT &; LICENSE
Copyright 2007-2009 Chris Thompson, some rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
perl v5.12.3 2011-05-09 JSON::Any(3pm)