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
   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::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::ReadOnlyProperty' => {
  45         isa => 'Koha::Exceptions::Object',
  46         description => "Change of readonly property attempted",
  47         fields => [ 'property' ],
  48     },
  49     'Koha::Exceptions::Object::MethodNotCoveredByTests' => {
  50         isa => 'Koha::Exceptions::Object',
  51         description => "Method not covered by tests",
  52     },
  53     'Koha::Exceptions::Object::BadValue' => {
  54         isa         => 'Koha::Exceptions::Object',
  55         description => 'Invalid data passed',
  56         fields      => ['type', 'property', 'value'],
  57     },
  58     'Koha::Exceptions::Object::NotInstantiated' => {
  59         isa         => 'Koha::Exceptions::Object',
  60         description => 'Tried to access a method on an uninstantiated object',
  61         fields      => ['class','method']
  62     },
  63     'Koha::Exceptions::Object::NotInStorage' => {
  64         isa         => 'Koha::Exceptions::Object',
  65         description => 'The object is not in storage yet',
  66     },
  67 );
  68
  69 sub full_message {
  70     my $self = shift;
  71
  72     my $msg = $self->message;
  73
  74     unless ( $msg) {
  75         if ( $self->isa('Koha::Exceptions::Object::FKConstraint') ) {
  76             $msg = sprintf("Invalid parameter passed, %s=%s does not exist", $self->broken_fk, $self->value );
  77         }
  78         elsif ( $self->isa('Koha::Exceptions::Object::BadValue') ) {
  79             $msg = sprintf("Invalid value passed, %s=%s expected type is %s", $self->property, $self->value, $self->type );
  80         }
  81         elsif ( $self->isa('Koha::Exceptions::Object::ReadOnlyProperty') ) {
  82             $msg = sprintf("Invalid attempt to change readonly property: %s", $self->property );
  83         }
  84         elsif ( $self->isa('Koha::Exceptions::Object::NotInstantiated') ) {
  85             $msg = sprintf("Tried to access the '%s' method, but %s is not instantiated", $self->method, $self->class );
  86         }
  87     }
  88
  89     return $msg;
  90 }
  91
  92 =head1 NAME
  93
  94 Koha::Exceptions::Object - Base class for Object exceptions
  95
  96 =head1 Exceptions
  97
  98 =head2 Koha::Exceptions::Object
  99
 100 Generic Object exception
 101
 102 =head2 Koha::Exceptions::Object::DuplicateID
 103
 104 Exception to be used when a duplicate ID is passed.
 105
 106 =head2 Koha::Exceptions::Object::FKConstraint
 107
 108 Exception to be used when a foreign key constraint is broken.
 109
 110 =head2 Koha::Exceptions::Object::MethodNotFound
 111
 112 Exception to be used when an invalid class method has been invoked.
 113
 114 =head2 Koha::Exceptions::Object::PropertyNotFound
 115
 116 Exception to be used when an invalid object property has been requested.
 117
 118 =head2 Koha::Exceptions::Object::MethodNotCoveredByTests
 119
 120 Exception to be used when the invoked method is not covered by tests.
 121
 122 =head2 Koha::Exceptions::Object::BadValue
 123
 124 Exception to be used when a bad value has been passed for a property.
 125
 126 =head1 Class methods
 127
 128 =head2 full_message
 129
 130 Overloaded method for exception stringifying.
 131
 132 =cut
 133
 134 1;