C4::Installer::PerlModules
A module for manipulating Koha Perl dependency list objects.
Creates a new PerlModules object
example:
C<my $perl_modules = C4::Installer::PerlModules->new;>
Returns a hashref of a hash of module information suitable for use in Makefile.PL
example:
C<my $perl_modules = C4::Installer::PerlModules->new;
...
PREREQ_PM => $perl_modules->prereq_pm,>
This method accepts a single parameter with three possible values: a module name, the keyword 'required,' the keyword 'optional.' If passed the name of a module, a boolean value is returned indicating whether the module is required (1) or not (0). If on of the two keywords is passed in, it returns an arrayref to an array who's elements are the names of the modules specified either required or optional.
example:
C<my $is_required = $perl_modules->required(module => 'CGI::Carp');>
C<my $optional_pm_names = $perl_modules->required(optional => 1);>
Depending on the parameters passed when invoking, this method will give the current status of modules currently used in Koha as well as the currently installed version if the module is installed, the current minimum required version, and the upgrade status. If passed C<module => module_name>, the method evaluates only that module. If passed C<all => 1>, all modules are evaluated.
example:
C<my $module_status = $perl_modules->version_info(module => 'foo');>
This usage returns a hashref with a single key/value pair. The key is the module name. The value is an anonymous hash with the following keys:
cur_ver = version number of the currently installed version (This is 0 if the module is not currently installed.)
min_ver = minimum version required by Koha
upgrade = upgrade status of the module relative to Koha's requirements (0 if the installed module does not need upgrading; 1 if it does)
required = 0 of the module is optional; 1 if required
{
'CGI::Carp' => {
'required' => 1,
'cur_ver' => '1.30_01',
'upgrade' => 0,
'min_ver' => '1.29'
}
};
C<$perl_modules->version_info;>
This usage loads the same basic data as the previous usage into three accessors: missing_pm, upgrade_pm, and current_pm. Each of these may be accessed by using the C<get_attr> method. Each accessor returns an anonymous array who's elements are anonymous hashes. They follow this format (NOTE: Upgrade status is indicated by the accessor name.):
[
{
'Text::CSV::Encoded' => {
'required' => 1,
'cur_ver' => 0.09,
'min_ver' => '0.09'
}
},
{
'Biblio::EndnoteStyle' => {
'required' => 1,
'cur_ver' => 0,
'min_ver' => '0.05'
}
},
}
Returns an anonymous array containing the contents of the passed in accessor. Valid accessors are:
missing_pm - Perl modules used by Koha but not currently installed.
upgrade_pm - Perl modules currently installed but below the minimum version required by Koha.
current_pm - Perl modules currently installed and up to date as required by Koha.
example:
C<my $missing_pm = $perl_modules->get_attr('missing_pm');>
Returns a scalar value representing the current number of Perl modules used by Koha.
example:
C<my $module_count = $perl_modules->module_count;>
Returns an array who's elements are the names of the Perl modules used by Koha.
example:
C<my @module_list = $perl_modules->module_list;>
This is useful for commandline exercises such as:
perl -MC4::Installer::PerlModules -e 'my $deps = C4::Installer::PerlModule->new; print (join("\n",$deps->module_list));'
Chris Nighswonger <cnighswonger AT foundations DOT edu>
Copyright 2010 Foundations Bible College.
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 2 of the License, or (at your option) any later version.
You should have received a copy of the GNU General Public License along with Koha; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
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.