Koha/Plugins/Tab.pm

   1 package Koha::Plugins::Tab;
   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
  19 use Modern::Perl;
  20
  21 use Koha::Exceptions;
  22
  23 use base qw(Class::Accessor);
  24
  25 __PACKAGE__->mk_accessors(qw( title content id ));
  26
  27 =head1 NAME
  28
  29 Koha::Plugins::Tab - Simple base to abstract tabs to be generated by plugins
  30
  31 =head1 DESCRIPTION
  32
  33 Object-oriented class that represents tabs generated by plugins. Error handling on
  34 mandatory fields is handled here.
  35
  36 =head1 API
  37
  38 =head2 Class methods
  39
  40 =head3 new
  41
  42     my $tab = Koha::Plugins::Tab->new(
  43         {
  44             title   => 'A title',
  45             content => 'Some content'
  46         }
  47     );
  48
  49 Returns a Koha::Plugins::Tab object representing a plugin-generated tab.
  50
  51 =cut
  52
  53 sub new {
  54
  55     my ( $class, $params )  = @_;
  56
  57     Koha::Exceptions::MissingParameter->throw( "Mandatory parameter 'title' missing" )
  58         unless defined $params->{ title };
  59
  60     Koha::Exceptions::MissingParameter->throw( "Mandatory parameter 'content' missing")
  61       unless defined $params->{content};
  62
  63     my $self = {
  64         title   => $params->{title},
  65         content => $params->{content}
  66     };
  67
  68     bless $self, $class;
  69     return $self;
  70 }
  71
  72 1;