koha-dev.rot13.org Git - srvgit/blob - Koha/Exceptions/Plugin.pm

   1 package Koha::Exceptions::Plugin;
   2
   3 # This file is part of Koha.
   4 #
   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.
   9 #
  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.
  14 #
  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>.
  17
  18 use Modern::Perl;
  19
  20 use Koha::Exception;
  21
  22 use Exception::Class (
  23     'Koha::Exceptions::Plugin' => {
  24         isa         => 'Koha::Exception',
  25     },
  26     'Koha::Exceptions::Plugin::ForbiddenAction' => {
  27         isa         => 'Koha::Exceptions::Plugin',
  28         description => 'The plugin is trying to do something it is not allowed to'
  29     },
  30     'Koha::Exceptions::Plugin::MissingMethod' => {
  31         isa         => 'Koha::Exceptions::Plugin',
  32         description => 'Required method is missing',
  33         fields      =>  ['plugin_name','method']
  34     },
  35     'Koha::Exceptions::Plugin::InstallDied' => {
  36         isa         => 'Koha::Exceptions::Plugin',
  37         description => 'The plugin died on install',
  38         fields      => ['plugin_class'],
  39     },
  40     'Koha::Exceptions::Plugin::UpgradeDied' => {
  41         isa         => 'Koha::Exceptions::Plugin',
  42         description => 'The plugin died on upgrade',
  43         fields      => ['plugin_class'],
  44     },
  45 );
  46
  47 sub full_message {
  48     my $self = shift;
  49
  50     my $msg = $self->message;
  51
  52     unless ( $msg) {
  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 );
  55         }
  56         elsif ( $self->isa('Koha::Exceptions::Plugin::InstallDied') ) {
  57             $msg = sprintf("Calling 'install' died for plugin %s", $self->plugin_class);
  58         }
  59         elsif ( $self->isa('Koha::Exceptions::Plugin::UpgradeDied') ) {
  60             $msg = sprintf("Calling 'upgrade' died for plugin %s", $self->plugin_class);
  61         }
  62     }
  63
  64     return $msg;
  65 }
  66
  67 =head1 NAME
  68
  69 Koha::Exceptions::Plugin - Base class for Plugin exceptions
  70
  71 =head1 Exceptions
  72
  73 =head2 Koha::Exceptions::Plugin
  74
  75 Generic Plugin exception
  76
  77 =head2 Koha::Exceptions::Plugin::MissingMethod
  78
  79 Exception to be used when a plugin is required to implement a specific
  80 method and it doesn't.
  81
  82 =head3 Parameters
  83
  84 =over
  85
  86 =item plugin_name: the plugin name for display purposes
  87
  88 =item method: the missing method
  89
  90 =back
  91
  92 =head2 Koha::Exceptions::Plugin::InstallDied
  93
  94 Exception to be used when a plugin 'install' method explodes.
  95
  96 =head3 Parameters
  97
  98 =over
  99
 100 =item plugin_class: the plugin class
 101
 102 =back
 103
 104 =head2 Koha::Exceptions::Plugin::UpgradeDied
 105
 106 Exception to be used when a plugin 'upgrade' method explodes.
 107
 108 =head3 Parameters
 109
 110 =over
 111
 112 =item plugin_class: the plugin class
 113
 114 =back
 115
 116 =head1 Class methods
 117
 118 =head2 full_message
 119
 120 Overloaded method for exception stringifying.
 121
 122 =cut
 123
 124 1;