Bug 14402: Make purge_zero_balance_fees() delete fees with NULL balance.
[koha.git] / Koha / MetadataRecord.pm
blob1577cd04d507634a27f18a62b717e13fc8d8b11f
1 package Koha::MetadataRecord;
3 # Copyright 2013 C & P Bibliography Services
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 3 of the License, or (at your option) any later
10 # version.
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 =head1 NAME
22 Koha::MetadataRecord - base class for metadata records
24 =head1 SYNOPSIS
26 my $record = new Koha::MetadataRecord({ 'record' => $record });
28 =head1 DESCRIPTION
30 Object-oriented class that encapsulates all metadata (i.e. bibliographic
31 and authority) records in Koha.
33 =cut
35 use Modern::Perl;
37 use Carp;
38 use Koha::Util::MARC;
40 use base qw(Class::Accessor);
42 __PACKAGE__->mk_accessors(qw( record schema format id ));
45 =head2 new
47 my $metadata_record = new Koha::MetadataRecord({
48 record => $record,
49 schema => $schema,
50 format => $format,
51 id => $id
52 });
54 Returns a Koha::MetadataRecord object encapsulating record metadata.
56 C<$record> is expected to be a deserialized object (for example
57 a MARC::Record or XML::LibXML::Document object or JSON).
59 C<$schema> is used to describe the metadata schema (for example
60 marc21, unimarc, dc, mods, etc).
62 C<$format> is used to specify the serialization format. It is important
63 for Koha::RecordProcessor because it will pick the right Koha::Filter
64 implementation based on this parameter. Valid values are:
66 MARC (for MARC::Record objects)
67 XML (for XML::LibXML::Document objects)
68 JSON (for JSON objects)
70 (optional) C<$id> is used so the record carries its own id and Koha doesn't
71 need to look for it inside the record.
73 =cut
75 sub new {
77 my $class = shift;
78 my $params = shift;
80 if (!defined $params->{ record }) {
81 carp 'No record passed';
82 return;
85 if (!defined $params->{ schema }) {
86 carp 'No schema passed';
87 return;
90 my $record = $params->{ record };
91 my $schema = $params->{ schema };
92 my $format = $params->{ format } // 'MARC';
93 my $id = $params->{ id };
95 my $self = $class->SUPER::new({
96 record => $record,
97 schema => $schema,
98 format => $format,
99 id => $id
102 bless $self, $class;
103 return $self;
106 =head2 createMergeHash
108 Create a hash for use when merging records. At the moment the only
109 metadata schema supported is MARC.
111 =cut
113 sub createMergeHash {
114 my ($self, $tagslib) = @_;
115 if ($self->schema =~ m/marc/) {
116 return Koha::Util::MARC::createMergeHash($self->record, $tagslib);
120 sub getKohaField {
121 my ($self, $kohafield) = @_;
123 if ($self->schema =~ m/marc/) {
124 my $relations = C4::Context->marcfromkohafield->{''};
125 my $tagfield = $relations->{$kohafield};
127 return '' if ref($tagfield) ne 'ARRAY';
129 my ($tag, $subfield) = @$tagfield;
130 my @kohafield;
131 foreach my $field ( $self->record->field($tag) ) {
132 if ( $field->tag() < 10 ) {
133 push @kohafield, $field->data();
134 } else {
135 foreach my $contents ( $field->subfield($subfield) ) {
136 push @kohafield, $contents;
141 return join ' | ', @kohafield;