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::Exceptions::Exception;
  21
  22 use Exception::Class (
  23     'Koha::Exceptions::Plugin' => {
  24         isa         => 'Koha::Exceptions::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 );
  36
  37 sub full_message {
  38     my $self = shift;
  39
  40     my $msg = $self->message;
  41
  42     unless ( $msg) {
  43         if ( $self->isa('Koha::Exceptions::Plugin::MissingMethod') ) {
  44             $msg = sprintf("Cannot use plugin (%s) because the it doesn't implement the '%s' method which is required.", $self->plugin_name, $self->method );
  45         }
  46     }
  47
  48     return $msg;
  49 }
  50
  51 =head1 NAME
  52
  53 Koha::Exceptions::Plugin - Base class for Plugin exceptions
  54
  55 =head1 Exceptions
  56
  57 =head2 Koha::Exceptions::Plugin
  58
  59 Generic Plugin exception
  60
  61 =head2 Koha::Exceptions::Plugin::MissingMethod
  62
  63 Exception to be used when a plugin is required to implement a specific
  64 method and it doesn't.
  65
  66 =head3 Parameters
  67
  68 =over
  69
  70 =item plugin_name: the plugin name for display purposes
  71
  72 =item method: the missing method
  73
  74 =back
  75
  76 =head1 Class methods
  77
  78 =head2 full_message
  79
  80 Overloaded method for exception stringifying.
  81
  82 =cut
  83
  84 1;