Koha/Exceptions/SysPref.pm

   1 package Koha::Exceptions::SysPref;
   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::SysPref' => {
  24         isa => 'Koha::Exception',
  25     },
  26     'Koha::Exceptions::SysPref::NotSet' => {
  27         isa         => 'Koha::Exceptions::SysPref',
  28         description => 'Required syspref is not set',
  29         fields      =>  ['syspref']
  30     }
  31 );
  32
  33 =head1 NAME
  34
  35 Koha::Exceptions::SysPref - Base class for syspref-related exceptions
  36
  37 =head1 Exceptions
  38
  39 =head2 Koha::Exceptions::SysPref
  40
  41 Generic syspref-related exception
  42
  43 =head2 Koha::Exceptions::SysPref::NotSet
  44
  45 Exception to be used when a required syspref is not set.
  46
  47 =cut
  48
  49 1;