… | |
… | |
101 | |
101 | |
102 | package JSON::XS; |
102 | package JSON::XS; |
103 | |
103 | |
104 | use common::sense; |
104 | use common::sense; |
105 | |
105 | |
106 | our $VERSION = '3.0'; |
106 | our $VERSION = 3.01; |
107 | our @ISA = qw(Exporter); |
107 | our @ISA = qw(Exporter); |
108 | |
108 | |
109 | our @EXPORT = qw(encode_json decode_json); |
109 | our @EXPORT = qw(encode_json decode_json); |
110 | |
110 | |
111 | use Exporter; |
111 | use Exporter; |
… | |
… | |
483 | |
483 | |
484 | =item $json = $json->convert_blessed ([$enable]) |
484 | =item $json = $json->convert_blessed ([$enable]) |
485 | |
485 | |
486 | =item $enabled = $json->get_convert_blessed |
486 | =item $enabled = $json->get_convert_blessed |
487 | |
487 | |
488 | See "OBJECT SERIALISATION" for details. |
488 | See L<OBJECT SERIALISATION> for details. |
489 | |
489 | |
490 | If C<$enable> is true (or missing), then C<encode>, upon encountering a |
490 | If C<$enable> is true (or missing), then C<encode>, upon encountering a |
491 | blessed object, will check for the availability of the C<TO_JSON> method |
491 | blessed object, will check for the availability of the C<TO_JSON> method |
492 | on the object's class. If found, it will be called in scalar context and |
492 | on the object's class. If found, it will be called in scalar context and |
493 | the resulting scalar will be encoded instead of the object. |
493 | the resulting scalar will be encoded instead of the object. |
… | |
… | |
507 | |
507 | |
508 | =item $json = $json->allow_tags ([$enable]) |
508 | =item $json = $json->allow_tags ([$enable]) |
509 | |
509 | |
510 | =item $enabled = $json->allow_tags |
510 | =item $enabled = $json->allow_tags |
511 | |
511 | |
512 | See "OBJECT SERIALISATION" for details. |
512 | See L<OBJECT SERIALISATION> for details. |
513 | |
513 | |
514 | If C<$enable> is true (or missing), then C<encode>, upon encountering a |
514 | If C<$enable> is true (or missing), then C<encode>, upon encountering a |
515 | blessed object, will check for the availability of the C<FREEZE> method on |
515 | blessed object, will check for the availability of the C<FREEZE> method on |
516 | the object's class. If found, it will be used to serialise the object into |
516 | the object's class. If found, it will be used to serialise the object into |
517 | a nonstandard tagged JSON value (that JSON decoders cannot decode). |
517 | a nonstandard tagged JSON value (that JSON decoders cannot decode). |
… | |
… | |
1017 | Another nonstandard extension to the JSON syntax, enabled with the |
1017 | Another nonstandard extension to the JSON syntax, enabled with the |
1018 | C<allow_tags> setting, are tagged values. In this implementation, the |
1018 | C<allow_tags> setting, are tagged values. In this implementation, the |
1019 | I<tag> must be a perl package/class name encoded as a JSON string, and the |
1019 | I<tag> must be a perl package/class name encoded as a JSON string, and the |
1020 | I<value> must be a JSON array encoding optional constructor arguments. |
1020 | I<value> must be a JSON array encoding optional constructor arguments. |
1021 | |
1021 | |
1022 | See "OBJECT SERIALISATION", below, for details. |
1022 | See L<OBJECT SERIALISATION>, below, for details. |
1023 | |
1023 | |
1024 | =back |
1024 | =back |
1025 | |
1025 | |
1026 | |
1026 | |
1027 | =head2 PERL -> JSON |
1027 | =head2 PERL -> JSON |
… | |
… | |
1066 | directly if you want. |
1066 | directly if you want. |
1067 | |
1067 | |
1068 | =item blessed objects |
1068 | =item blessed objects |
1069 | |
1069 | |
1070 | Blessed objects are not directly representable in JSON, but C<JSON::XS> |
1070 | Blessed objects are not directly representable in JSON, but C<JSON::XS> |
1071 | allows various ways of handling objects. See "OBJECT SERIALISATION", |
1071 | allows various ways of handling objects. See L<OBJECT SERIALISATION>, |
1072 | below, for details. |
1072 | below, for details. |
1073 | |
1073 | |
1074 | =item simple scalars |
1074 | =item simple scalars |
1075 | |
1075 | |
1076 | Simple Perl scalars (any scalar that is not a reference) are the most |
1076 | Simple Perl scalars (any scalar that is not a reference) are the most |
… | |
… | |
1129 | C<allow_blessed>, C<convert_blessed> and C<allow_tags> settings, which are |
1129 | C<allow_blessed>, C<convert_blessed> and C<allow_tags> settings, which are |
1130 | used in this order: |
1130 | used in this order: |
1131 | |
1131 | |
1132 | =over 4 |
1132 | =over 4 |
1133 | |
1133 | |
1134 | =item 1. C<allow_tags> is enabled and object has a C<FREEZE> method. |
1134 | =item 1. C<allow_tags> is enabled and the object has a C<FREEZE> method. |
1135 | |
1135 | |
1136 | In this case, C<JSON::XS> uses the L<Types::Serialiser> object |
1136 | In this case, C<JSON::XS> uses the L<Types::Serialiser> object |
1137 | serialisation protocol to create a tagged JSON value, using a nonstandard |
1137 | serialisation protocol to create a tagged JSON value, using a nonstandard |
1138 | extension to the JSON syntax. |
1138 | extension to the JSON syntax. |
1139 | |
1139 | |
… | |
… | |
1145 | more). These values and the paclkage/classname of the object will then be |
1145 | more). These values and the paclkage/classname of the object will then be |
1146 | encoded as a tagged JSON value in the following format: |
1146 | encoded as a tagged JSON value in the following format: |
1147 | |
1147 | |
1148 | ("classname")[FREEZE return values...] |
1148 | ("classname")[FREEZE return values...] |
1149 | |
1149 | |
|
|
1150 | e.g.: |
|
|
1151 | |
|
|
1152 | ("URI")["http://www.google.com/"] |
|
|
1153 | ("MyDate")[2013,10,29] |
|
|
1154 | ("ImageData::JPEG")["Z3...VlCg=="] |
|
|
1155 | |
1150 | For example, the hypothetical C<My::Object> C<FREEZE> method might use the |
1156 | For example, the hypothetical C<My::Object> C<FREEZE> method might use the |
1151 | objects C<type> and C<id> members to encode the object: |
1157 | objects C<type> and C<id> members to encode the object: |
1152 | |
1158 | |
1153 | sub My::Object::FREEZE { |
1159 | sub My::Object::FREEZE { |
1154 | my ($self, $serialiser) = @_; |
1160 | my ($self, $serialiser) = @_; |
1155 | |
1161 | |
1156 | ($self->{type}, $self->{id}) |
1162 | ($self->{type}, $self->{id}) |
1157 | } |
1163 | } |
1158 | |
1164 | |
1159 | =item 2. C<convert_blessed> is enabled and object has a C<TO_JSON> method. |
1165 | =item 2. C<convert_blessed> is enabled and the object has a C<TO_JSON> method. |
1160 | |
1166 | |
1161 | In this case, the C<TO_JSON> method of the object is invoked in scalar |
1167 | In this case, the C<TO_JSON> method of the object is invoked in scalar |
1162 | context. It must return a single scalar that can be directly encoded into |
1168 | context. It must return a single scalar that can be directly encoded into |
1163 | JSON. This scalar replaces the object in the JSON text. |
1169 | JSON. This scalar replaces the object in the JSON text. |
1164 | |
1170 | |