NAME
Wikibase::Datatype::Struct::Reference - Wikibase reference structure serialization.
SYNOPSIS
use Wikibase::Datatype::Struct::Reference qw(obj2struct struct2obj);
my $struct_hr = obj2struct($obj, $base_uri);
my $obj = struct2obj($struct_hr);DESCRIPTION
This conversion is between objects defined in Wikibase::Datatype and structures serialized via JSON to MediaWiki.
SUBROUTINES
obj2struct
my $struct_hr = obj2struct($obj, $base_uri);Convert Wikibase::Datatype::Reference instance to structure. $base_uri is base URI of Wikibase system (e.g. http://test.wikidata.org/entity/).
Returns reference to hash with structure.
struct2obj
my $obj = struct2obj($struct_hr);Convert structure of reference to object.
Returns Wikibase::Datatype::Reference instance.
ERRORS
obj2struct():
Base URI is required.
Object doesn't exist.
Object isn't 'Wikibase::Datatype::Reference'.EXAMPLE1
use strict;
use warnings;
use Data::Printer;
use Wikibase::Datatype::Reference;
use Wikibase::Datatype::Snak;
use Wikibase::Datatype::Struct::Reference qw(obj2struct);
use Wikibase::Datatype::Value::Item;
use Wikibase::Datatype::Value::String;
use Wikibase::Datatype::Value::Time;
# Object.
# instance of (P31) human (Q5)
my $obj = Wikibase::Datatype::Reference->new(
'snaks' => [
# stated in (P248) Virtual International Authority File (Q53919)
Wikibase::Datatype::Snak->new(
'datatype' => 'wikibase-item',
'datavalue' => Wikibase::Datatype::Value::Item->new(
'value' => 'Q53919',
),
'property' => 'P248',
),
# VIAF ID (P214) 113230702
Wikibase::Datatype::Snak->new(
'datatype' => 'external-id',
'datavalue' => Wikibase::Datatype::Value::String->new(
'value' => '113230702',
),
'property' => 'P214',
),
# retrieved (P813) 7 December 2013
Wikibase::Datatype::Snak->new(
'datatype' => 'time',
'datavalue' => Wikibase::Datatype::Value::Time->new(
'value' => '+2013-12-07T00:00:00Z',
),
'property' => 'P813',
),
],
);
# Get structure.
my $struct_hr = obj2struct($obj, 'http://test.wikidata.org/entity/');
# Dump to output.
p $struct_hr;
# Output:
# \ {
# snaks {
# P214 [
# [0] {
# datatype "external-id",
# datavalue {
# type "string",
# value 113230702
# },
# property "P214",
# snaktype "value"
# }
# ],
# P248 [
# [0] {
# datatype "wikibase-item",
# datavalue {
# type "wikibase-entityid",
# value {
# entity-type "item",
# id "Q53919",
# numeric-id 53919
# }
# },
# property "P248",
# snaktype "value"
# }
# ],
# P813 [
# [0] {
# datatype "time",
# datavalue {
# type "time",
# value {
# after 0,
# before 0,
# calendarmodel "http://test.wikidata.org/entity/Q1985727",
# precision 11,
# time "+2013-12-07T00:00:00Z",
# timezone 0
# }
# },
# property "P813",
# snaktype "value"
# }
# ]
# },
# snaks-order [
# [0] "P248",
# [1] "P214",
# [2] "P813"
# ]
# }EXAMPLE2
use strict;
use warnings;
use Wikibase::Datatype::Struct::Reference qw(struct2obj);
# Item structure.
my $struct_hr = {
'snaks' => {
'P214' => [{
'datatype' => 'external-id',
'datavalue' => {
'type' => 'string',
'value' => '113230702',
},
'property' => 'P214',
'snaktype' => 'value',
}],
'P248' => [{
'datatype' => 'wikibase-item',
'datavalue' => {
'type' => 'wikibase-entityid',
'value' => {
'entity-type' => 'item',
'id' => 'Q53919',
'numeric-id' => 53919,
},
},
'property' => 'P248',
'snaktype' => 'value',
}],
'P813' => [{
'datatype' => 'time',
'datavalue' => {
'type' => 'time',
'value' => {
'after' => 0,
'before' => 0,
'calendarmodel' => 'http://test.wikidata.org/entity/Q1985727',
'precision' => 11,
'time' => '+2013-12-07T00:00:00Z',
'timezone' => 0,
},
},
'property' => 'P813',
'snaktype' => 'value',
}],
},
'snaks-order' => [
'P248',
'P214',
'P813',
],
};
# Get object.
my $obj = struct2obj($struct_hr);
# Get value.
my $snaks_ar = $obj->snaks;
# Print out number of snaks.
print "Number of snaks: ".@{$snaks_ar}."\n";
# Output:
# Number of snaks: 3DEPENDENCIES
Error::Pure, Exporter, Readonly, Wikibase::Datatype::Reference, Wikibase::Datatype::Struct::Utils.
SEE ALSO
- Wikibase::Datatype::Struct
-
Wikibase structure serialization.
- Wikibase::Datatype::Reference
-
Wikibase reference datatype.
REPOSITORY
https://github.com/michal-josef-spacek/Wikibase-Datatype-Struct
AUTHOR
Michal Josef Špaček mailto:skim@cpan.org
LICENSE AND COPYRIGHT
© 2020-2023 Michal Josef Špaček
BSD 2-Clause License
VERSION
0.12