1 package Koha::Exceptions::Plugin;
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 use Exception::Class (
23 'Koha::Exceptions::Plugin' => {
24 isa => 'Koha::Exception',
26 'Koha::Exceptions::Plugin::ForbiddenAction' => {
27 isa => 'Koha::Exceptions::Plugin',
28 description => 'The plugin is trying to do something it is not allowed to'
30 'Koha::Exceptions::Plugin::MissingMethod' => {
31 isa => 'Koha::Exceptions::Plugin',
32 description => 'Required method is missing',
33 fields => ['plugin_name','method']
35 'Koha::Exceptions::Plugin::InstallDied' => {
36 isa => 'Koha::Exceptions::Plugin',
37 description => 'The plugin died on install',
38 fields => ['plugin_class'],
40 'Koha::Exceptions::Plugin::UpgradeDied' => {
41 isa => 'Koha::Exceptions::Plugin',
42 description => 'The plugin died on upgrade',
43 fields => ['plugin_class'],
50 my $msg = $self->message;
53 if ( $self->isa('Koha::Exceptions::Plugin::MissingMethod') ) {
54 $msg = sprintf("Cannot use plugin (%s) because the it doesn't implement the '%s' method which is required.", $self->plugin_name, $self->method );
56 elsif ( $self->isa('Koha::Exceptions::Plugin::InstallDied') ) {
57 $msg = sprintf("Calling 'install' died for plugin %s", $self->plugin_class);
59 elsif ( $self->isa('Koha::Exceptions::Plugin::UpgradeDied') ) {
60 $msg = sprintf("Calling 'upgrade' died for plugin %s", $self->plugin_class);
69 Koha::Exceptions::Plugin - Base class for Plugin exceptions
73 =head2 Koha::Exceptions::Plugin
75 Generic Plugin exception
77 =head2 Koha::Exceptions::Plugin::MissingMethod
79 Exception to be used when a plugin is required to implement a specific
80 method and it doesn't.
86 =item plugin_name: the plugin name for display purposes
88 =item method: the missing method
92 =head2 Koha::Exceptions::Plugin::InstallDied
94 Exception to be used when a plugin 'install' method explodes.
100 =item plugin_class: the plugin class
104 =head2 Koha::Exceptions::Plugin::UpgradeDied
106 Exception to be used when a plugin 'upgrade' method explodes.
112 =item plugin_class: the plugin class
120 Overloaded method for exception stringifying.