Jonathan Druart
9d6d641d1f
On bug 17591 we discovered that there was something weird going on with the way we export and use subroutines/modules. This patch tries to standardize our EXPORT to use EXPORT_OK only. That way we will need to explicitely define the subroutine we want to use from a module. This patch is a squashed version of: Bug 17600: After export.pl Bug 17600: After perlimport Bug 17600: Manual changes Bug 17600: Other manual changes after second perlimports run Bug 17600: Fix tests And a lot of other manual changes. export.pl is a dirty script that can be found on bug 17600. "perlimport" is: git clone https://github.com/oalders/App-perlimports.git cd App-perlimports/ cpanm --installdeps . export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib" find . \( -name "*.pl" -o -name "*.pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \; The ideas of this patch are to: * use EXPORT_OK instead of EXPORT * perltidy the EXPORT_OK list * remove '&' before the subroutine names * remove some uneeded use statements * explicitely import the subroutines we need within the controllers or modules Note that the private subroutines (starting with _) should not be exported (and not used from outside of the module except from tests). EXPORT vs EXPORT_OK (from https://www.thegeekstuff.com/2010/06/perl-exporter-examples/) """ Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members. @EXPORT and @EXPORT_OK are the two main variables used during export operation. @EXPORT contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace. @EXPORT_OK does export of symbols on demand basis. """ If this patch caused a conflict with a patch you wrote prior to its push: * Make sure you are not reintroducing a "use" statement that has been removed * "$subroutine" is not exported by the C4::$MODULE module means that you need to add the subroutine to the @EXPORT_OK list * Bareword "$subroutine" not allowed while "strict subs" means that you didn't imported the subroutine from the module: - use $MODULE qw( $subroutine list ); You can also use the fully qualified namespace: C4::$MODULE::$subroutine Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
125 lines
3.1 KiB
Perl
125 lines
3.1 KiB
Perl
package Koha::MetadataRecord;
|
|
|
|
# Copyright 2013 C & P Bibliography Services
|
|
#
|
|
# This file is part of Koha.
|
|
#
|
|
# Koha is free software; you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Koha is distributed in the hope that it will be useful, but
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Koha; if not, see <http://www.gnu.org/licenses>.
|
|
|
|
=head1 NAME
|
|
|
|
Koha::MetadataRecord - base class for metadata records
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
my $record = new Koha::MetadataRecord({ 'record' => $record });
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Object-oriented class that encapsulates all metadata (i.e. bibliographic
|
|
and authority) records in Koha.
|
|
|
|
=cut
|
|
|
|
use Modern::Perl;
|
|
|
|
use Carp qw( carp );
|
|
use C4::Biblio;
|
|
use Koha::Util::MARC;
|
|
|
|
use base qw(Class::Accessor);
|
|
|
|
__PACKAGE__->mk_accessors(qw( record schema format id ));
|
|
|
|
|
|
=head2 new
|
|
|
|
my $metadata_record = new Koha::MetadataRecord({
|
|
record => $record,
|
|
schema => $schema,
|
|
format => $format,
|
|
id => $id
|
|
});
|
|
|
|
Returns a Koha::MetadataRecord object encapsulating record metadata.
|
|
|
|
C<$record> is expected to be a deserialized object (for example
|
|
a MARC::Record or XML::LibXML::Document object or JSON).
|
|
|
|
C<$schema> is used to describe the metadata schema (for example
|
|
marc21, unimarc, dc, mods, etc).
|
|
|
|
C<$format> is used to specify the serialization format. It is important
|
|
for Koha::RecordProcessor because it will pick the right Koha::Filter
|
|
implementation based on this parameter. Valid values are:
|
|
|
|
MARC (for MARC::Record objects)
|
|
XML (for XML::LibXML::Document objects)
|
|
JSON (for JSON objects)
|
|
|
|
(optional) C<$id> is used so the record carries its own id and Koha doesn't
|
|
need to look for it inside the record.
|
|
|
|
=cut
|
|
|
|
sub new {
|
|
|
|
my $class = shift;
|
|
my $params = shift;
|
|
|
|
if (!defined $params->{ record }) {
|
|
carp 'No record passed';
|
|
return;
|
|
}
|
|
|
|
if (!defined $params->{ schema }) {
|
|
carp 'No schema passed';
|
|
return;
|
|
}
|
|
|
|
$params->{format} //= 'MARC';
|
|
my $self = $class->SUPER::new($params);
|
|
|
|
bless $self, $class;
|
|
return $self;
|
|
}
|
|
|
|
=head2 createMergeHash
|
|
|
|
Create a hash for use when merging records. At the moment the only
|
|
metadata schema supported is MARC.
|
|
|
|
=cut
|
|
|
|
sub createMergeHash {
|
|
my ($self, $tagslib) = @_;
|
|
if ($self->schema =~ m/marc/) {
|
|
return Koha::Util::MARC::createMergeHash($self->record, $tagslib);
|
|
}
|
|
}
|
|
|
|
=head2 getKohaField
|
|
|
|
$metadata->{$key} = $record->getKohaField($kohafield);
|
|
|
|
=cut
|
|
|
|
sub getKohaField {
|
|
my ($self, $kohafield) = @_;
|
|
if ($self->schema =~ m/marc/) {
|
|
return C4::Biblio::TransformMarcToKohaOneField($kohafield, $self->record);
|
|
}
|
|
}
|
|
|
|
1;
|