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

NAME

Wikibase::Datatype::Struct::Value - Wikibase value structure serialization.

SYNOPSIS

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

Returns Wikibase::Datatype::Value instance.

ERRORS

obj2struct():
        Object doesn't exist.
        Object isn't 'Wikibase::Datatype::Value'.
        Type '%s' is unsupported.

struct2obj():
        Entity type '%s' is unsupported.
        Type doesn't exist.
        Type '%s' is unsupported.

EXAMPLE1

use strict;
use warnings;

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

# Object.
my $obj = Wikibase::Datatype::Value::Time->new(
        'precision' => 10,
        'value' => '+2020-09-01T00:00:00Z',
);

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

# Dump to output.
p $struct_hr;

# Output:
# \ {
#     type    "time",
#     value   {
#         after           0,
#         before          0,
#         calendarmodel   "http://test.wikidata.org/entity/Q1985727",
#         precision       10,
#         time            "+2020-09-01T00:00:00Z",
#         timezone        0
#     }
# }

EXAMPLE2

use strict;
use warnings;

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

# Time structure.
my $struct_hr = {
        'type' => 'time',
        'value' => {
                'after' => 0,
                'before' => 0,
                'calendarmodel' => 'http://test.wikidata.org/entity/Q1985727',
                'precision' => 10,
                'time' => '+2020-09-01T00:00:00Z',
                'timezone' => 0,
        },
};

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

# Get calendar model.
my $calendarmodel = $obj->calendarmodel;

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

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

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

# Print out.
print "Calendar model: $calendarmodel\n";
print "Precision: $precision\n";
print "Type: $type\n";
print "Value: $value\n";

# Output:
# Calendar model: Q1985727
# Precision: 10
# Type: time
# Value: +2020-09-01T00:00:00Z

DEPENDENCIES

Error::Pure, Exporter, Readonly, Wikibase::Datatype::Value, Wikibase::Datatype::Struct::Value::Globecoordinate, Wikibase::Datatype::Struct::Value::Item, Wikibase::Datatype::Struct::Value::Lexeme, Wikibase::Datatype::Struct::Value::Monolingual, Wikibase::Datatype::Struct::Value::Property, Wikibase::Datatype::Struct::Value::Quantity, Wikibase::Datatype::Struct::Value::String, Wikibase::Datatype::Struct::Value::Time.

SEE ALSO

Wikibase::Datatype::Struct

Wikibase structure serialization.

Wikibase::Datatype::Value::Globecoordinate

Wikibase globe coordinate value datatype.

Wikibase::Datatype::Value::Item

Wikibase item value datatype.

Wikibase::Datatype::Value::Lexeme

Wikibase lexeme value datatype.

Wikibase::Datatype::Value::Monolingual

Wikibase monolingual value datatype.

Wikibase::Datatype::Value::Property

Wikibase property value datatype.

Wikibase::Datatype::Value::Quantity

Wikibase quantity value datatype.

Wikibase::Datatype::Value::String

Wikibase string value datatype.

Wikibase::Datatype::Value::Time

Wikibase time value 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-2024 Michal Josef Špaček

BSD 2-Clause License

VERSION

0.13