Koha/Exceptions/Object.pm

   1 package Koha::Exceptions::Object;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation; either version 3 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along
  15 # with Koha; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17
  18 use Modern::Perl;
  19
  20 use Koha::Exceptions::Exception;
  21
  22 use Exception::Class (
  23     'Koha::Exceptions::Object' => {
  24         isa         => 'Koha::Exceptions::Exception',
  25     },
  26     'Koha::Exceptions::Object::DuplicateID' => {
  27         isa         => 'Koha::Exceptions::Object',
  28         description => "Duplicate ID passed",
  29         fields      =>  ['duplicate_id']
  30     },
  31     'Koha::Exceptions::Object::FKConstraint' => {
  32         isa         => 'Koha::Exceptions::Object',
  33         description => "Foreign key constraint broken",
  34         fields      =>  ['broken_fk', 'value'],
  35     },
  36     'Koha::Exceptions::Object::MethodNotFound' => {
  37         isa => 'Koha::Exceptions::Object',
  38         description => "Invalid method",
  39     },
  40     'Koha::Exceptions::Object::PropertyNotFound' => {
  41         isa => 'Koha::Exceptions::Object',
  42         description => "Invalid property",
  43     },
  44     'Koha::Exceptions::Object::MethodNotCoveredByTests' => {
  45         isa => 'Koha::Exceptions::Object',
  46         description => "Method not covered by tests",
  47     },
  48 );
  49
  50 sub full_message {
  51     my $self = shift;
  52
  53     my $msg = $self->message;
  54
  55     unless ( $msg) {
  56         if ( $self->isa('Koha::Exceptions::Object::FKConstraint') ) {
  57             $msg = sprintf("Invalid parameter passed, %s=%s does not exist", $self->broken_fk, $self->value );
  58         }
  59     }
  60
  61     return $msg;
  62 }
  63
  64 =head1 NAME
  65
  66 Koha::Exceptions::Object - Base class for Object exceptions
  67
  68 =head1 Exceptions
  69
  70 =head2 Koha::Exceptions::Object
  71
  72 Generic Object exception
  73
  74 =head2 Koha::Exceptions::Object::DuplicateID
  75
  76 Exception to be used when a duplicate ID is passed.
  77
  78 =head2 Koha::Exceptions::Object::FKConstraint
  79
  80 Exception to be used when a foreign key constraint is broken.
  81
  82 =head2 Koha::Exceptions::Object::MethodNotFound
  83
  84 Exception to be used when an invalid class method has been invoked.
  85
  86 =head2 Koha::Exceptions::Object::PropertyNotFound
  87
  88 Exception to be used when an invalid object property has been requested.
  89
  90 =head2 Koha::Exceptions::Object::MethodNotCoveredByTests
  91
  92 Exception to be used when the invoked method is not covered by tests.
  93
  94 =head1 Class methods
  95
  96 =head2 full_message
  97
  98 Overloaded method for exception stringifying.
  99
 100 =cut
 101
 102 1;