Koha/Filter/MARC/EmbedItems.pm

   1 package Koha::Filter::MARC::EmbedItems;
   2
   3 # Copyright 2019  Theke Solutions
   4
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 =head1 NAME
  21
  22 Koha::Filter::MARC::EmbedItems - Appends item information on MARC::Record objects.
  23
  24 =head1 SYNOPSIS
  25
  26 my $biblio = Koha::Biblios->find(
  27     $biblio_id,
  28     { prefetch => [ items, metadata ] }
  29 );
  30
  31 my $opachiddenitems_rules;
  32 eval {
  33     my $yaml = C4::Context->preference('OpacHiddenItems') . "\n\n";
  34     $opachiddenitems_rules = YAML::XS::Load($yaml);
  35 };
  36
  37 my @items  = grep { !$_->hidden_in_opac({ rules => $opachiddenitems_rules }) @{$biblio->items};
  38 my $record = $biblio->metadata->record;
  39
  40 my $processor = Koha::RecordProcessor->new(
  41     {
  42         filters => ('EmbedItems'),
  43         options => {
  44             items        => \@items
  45         }
  46     }
  47 );
  48
  49 $processor->process( $record );
  50
  51 =head1 DESCRIPTION
  52
  53 Filter to embed items information into MARC::Record objects.
  54
  55 =cut
  56
  57 use Modern::Perl;
  58
  59 use C4::Biblio;
  60
  61 use base qw(Koha::RecordProcessor::Base);
  62 our $NAME = 'EmbedItems';
  63
  64 =head2 filter
  65
  66 Embed items into the MARC::Record object.
  67
  68 =cut
  69
  70 sub filter {
  71     my $self   = shift;
  72     my $record = shift;
  73
  74     return unless defined $record and ref($record) eq 'MARC::Record';
  75
  76     my $items = $self->{params}->{options}->{items};
  77     my $mss   = $self->{params}->{options}->{mss}
  78       // C4::Biblio::GetMarcSubfieldStructure( '', { unsafe => 1 } );
  79
  80     my @item_fields;
  81
  82     foreach my $item ( @{$items} ) {
  83         push @item_fields, $item->as_marc_field( { mss => $mss } );
  84     }
  85
  86     $record->append_fields(@item_fields);
  87
  88     return $record;
  89 }
  90
  91 1;