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>
123 lines
3 KiB
Perl
123 lines
3 KiB
Perl
package C4::Linker;
|
|
|
|
# Copyright 2011 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
|
|
|
|
C4::Linker - Base class for linking authorities to bibliographic records
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use C4::Linker (%params );
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Base class for C4::Linker::X. Subclasses need to provide the following methods
|
|
|
|
B<get_link ($field)> - return the authid for the authority that should be
|
|
linked to the provided MARC::Field object, and a boolean to indicate whether
|
|
the match is "fuzzy" (the semantics of "fuzzy" are up to the individual plugin).
|
|
In order to handle authority limits, get_link should always end with:
|
|
return $self->SUPER::_handle_auth_limit($authid), $fuzzy;
|
|
|
|
B<update_cache ($heading, $authid)> - updates internal linker cache for
|
|
$heading with $authid of a new created authotiry record
|
|
|
|
B<flip_heading ($field)> - return a MARC::Field object with the heading flipped
|
|
to the preferred form.
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
=cut
|
|
|
|
use strict;
|
|
use warnings;
|
|
use C4::Context;
|
|
|
|
use base qw(Class::Accessor);
|
|
|
|
__PACKAGE__->mk_accessors(qw( ));
|
|
|
|
sub new {
|
|
my $class = shift;
|
|
my $param = shift;
|
|
|
|
my $self = {};
|
|
|
|
while ( my ( $key, $value ) = each %$param ) {
|
|
if ( $key eq 'auth_limit' && $value ) {
|
|
my $dbh = C4::Context->dbh;
|
|
my $sql =
|
|
"SELECT authid FROM auth_header WHERE $value ORDER BY authid ASC";
|
|
my $sth = $dbh->prepare($sql);
|
|
$sth->execute();
|
|
while ( my ($authid) = $sth->fetchrow_array() ) {
|
|
push @{ $self->{'auths_to_link'} }, $authid;
|
|
}
|
|
}
|
|
elsif ( $key eq 'options' && $value ) {
|
|
foreach my $opt ( split( /\|/, $value ) ) {
|
|
$self->{$opt} = 1;
|
|
}
|
|
}
|
|
elsif ($value) {
|
|
$self->{$key} = $value;
|
|
}
|
|
}
|
|
|
|
bless $self, $class;
|
|
return $self;
|
|
}
|
|
|
|
=head2 _handle_auth_limit
|
|
|
|
return $self->SUPER::_handle_auth_limit($authid), $fuzzy;
|
|
|
|
Function to be called by subclasses to handle authority record limits.
|
|
|
|
=cut
|
|
|
|
sub _handle_auth_limit {
|
|
my $self = shift;
|
|
my $authid = shift;
|
|
|
|
if ( defined $self->{'auths_to_link'} && defined $authid && !grep { $_ == $authid }
|
|
@{ $self->{'auths_to_link'} } )
|
|
{
|
|
undef $authid;
|
|
}
|
|
return $authid;
|
|
}
|
|
|
|
=head2 EXPORT
|
|
|
|
None by default.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
C4::Linker::Default
|
|
|
|
=head1 AUTHOR
|
|
|
|
Jared Camins-Esakov, C & P Bibliography Services, E<lt>jcamins@cpbibliography.comE<gt>
|
|
|
|
=cut
|
|
|
|
1;
|
|
|
|
__END__
|