Koha/Object/Mixin/AdditionalFields.pm

   1 package Koha::Object::Mixin::AdditionalFields;
   2
   3 use Modern::Perl;
   4
   5 =head1 NAME
   6
   7 Koha::Object::Mixin::AdditionalFields
   8
   9 =head1 SYNOPSIS
  10
  11     package Koha::Foo;
  12
  13     use parent qw( Koha::Object Koha::Object::Mixin::AdditionalFields );
  14
  15     sub _type { 'Foo' }
  16
  17
  18     package main;
  19
  20     use Koha::Foo;
  21
  22     Koha::Foos->find($id)->set_additional_fields(...);
  23
  24 =head1 API
  25
  26 =head2 Public methods
  27
  28 =head3 set_additional_fields
  29
  30     $foo->set_additional_fields([
  31         {
  32             id => 1,
  33             value => 'foo',
  34         },
  35         {
  36             id => 2,
  37             value => 'bar',
  38         }
  39     ]);
  40
  41 =cut
  42
  43 sub set_additional_fields {
  44     my ($self, $additional_fields) = @_;
  45
  46     my $rs = Koha::Database->new->schema->resultset('AdditionalFieldValue');
  47
  48     foreach my $additional_field (@$additional_fields) {
  49         my $field_value = $rs->find_or_new({
  50             field_id => $additional_field->{id},
  51             record_id => $self->id,
  52         });
  53         my $value = $additional_field->{value};
  54         if (defined $value) {
  55             $field_value->set_columns({ value => $value })->update_or_insert;
  56         } elsif ($field_value->in_storage) {
  57             $field_value->delete;
  58         }
  59     }
  60 }
  61
  62 =head3 additional_field_values
  63
  64 Returns additional field values
  65
  66     my @values = $foo->additional_field_values;
  67
  68 =cut
  69
  70 sub additional_field_values {
  71     my ($self) = @_;
  72
  73     return $self->_result->additional_field_values;
  74 }
  75
  76 =head1 AUTHOR
  77
  78 Koha Development Team <http://koha-community.org/>
  79
  80 =head1 COPYRIGHT AND LICENSE
  81
  82 Copyright 2018 BibLibre
  83
  84 This file is part of Koha.
  85
  86 Koha is free software; you can redistribute it and/or modify it under the
  87 terms of the GNU General Public License as published by the Free Software
  88 Foundation; either version 3 of the License, or (at your option) any later
  89 version.
  90
  91 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  92 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  93 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  94
  95 You should have received a copy of the GNU General Public License along
  96 with Koha; if not, see <http://www.gnu.org/licenses>.
  97
  98 =cut
  99
 100 1;