/ 
Wikibase-Datatype-Struct-0.12
River stage one • 1 direct dependent • 3 total dependents
/ Wikibase::Datatype::Struct::Snak

NAME

Wikibase::Datatype::Struct::Snak - Wikibase snak structure serialization.

SYNOPSIS

use Wikibase::Datatype::Struct::Snak 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::Snak 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 snak to object.

Returns Wikibase::Datatype::Snak instance.

ERRORS

obj2struct():
        Base URI is required.
        Object doesn't exist.
        Object isn't 'Wikibase::Datatype::Snak'.

EXAMPLE1

use strict;
use warnings;

use Data::Printer;
use Wikibase::Datatype::Snak;
use Wikibase::Datatype::Struct::Snak qw(obj2struct);
use Wikibase::Datatype::Value::Item;

# Object.
# instance of (P31) human (Q5)
my $obj = Wikibase::Datatype::Snak->new(
         'datatype' => 'wikibase-item',
         'datavalue' => Wikibase::Datatype::Value::Item->new(
                 'value' => 'Q5',
         ),
         'property' => 'P31',
);

# Get structure.
my $struct_hr = obj2struct($obj, 'http://test.wikidata.org/entity/');

# Dump to output.
p $struct_hr;

# Output:
# \ {
#     datatype    "wikibase-item",
#     datavalue   {
#         type    "wikibase-entityid",
#         value   {
#             entity-type   "item",
#             id            "Q5",
#             numeric-id    5
#         }
#     },
#     property    "P31",
#     snaktype    "value"
# }

EXAMPLE2

use strict;
use warnings;

use Wikibase::Datatype::Struct::Snak qw(struct2obj);

# Item structure.
my $struct_hr = {
        'datatype' => 'wikibase-item',
        'datavalue' => {
                'type' => 'wikibase-entityid',
                'value' => {
                        'entity-type' => 'item',
                        'id' => 'Q5',
                        'numeric-id' => 5,
                },
        },
        'property' => 'P31',
        'snaktype' => 'value',
};

# Get object.
my $obj = struct2obj($struct_hr);

# Get value.
my $datavalue = $obj->datavalue->value;

# Get datatype.
my $datatype = $obj->datatype;

# Get property.
my $property = $obj->property;

# Print out.
print "Property: $property\n";
print "Type: $datatype\n";
print "Value: $datavalue\n";

# Output:
# Property: P31
# Type: wikibase-item
# Value: Q5

DEPENDENCIES

Error::Pure, Exporter, Readonly, Wikibase::Datatype::Snak, Wikibase::Datatype::Struct::Value.

SEE ALSO

Wikibase::Datatype::Struct

Wikibase structure serialization.

Wikibase::Datatype::Snak

Wikibase snak datatype.

REPOSITORY

https://github.com/michal-josef-spacek/Wikibase-Datatype-Struct

AUTHOR

Michal Josef Špaček mailto:skim@cpan.org

http://skim.cz

LICENSE AND COPYRIGHT

© 2020-2023 Michal Josef Špaček

BSD 2-Clause License

VERSION

0.12