| … | |
… | |
| 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 | |
| … | |
… | |
| 1154 | my ($self, $serialiser) = @_; |
1154 | my ($self, $serialiser) = @_; |
| 1155 | |
1155 | |
| 1156 | ($self->{type}, $self->{id}) |
1156 | ($self->{type}, $self->{id}) |
| 1157 | } |
1157 | } |
| 1158 | |
1158 | |
| 1159 | =item 2. C<convert_blessed> is enabled and object has a C<TO_JSON> method. |
1159 | =item 2. C<convert_blessed> is enabled and the object has a C<TO_JSON> method. |
| 1160 | |
1160 | |
| 1161 | In this case, the C<TO_JSON> method of the object is invoked in scalar |
1161 | 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 |
1162 | context. It must return a single scalar that can be directly encoded into |
| 1163 | JSON. This scalar replaces the object in the JSON text. |
1163 | JSON. This scalar replaces the object in the JSON text. |
| 1164 | |
1164 | |
