Koha/Object/Message.pm

   1 package Koha::Object::Message;
   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 base qw(Class::Accessor);
  21
  22 use Koha::Exceptions;
  23
  24 __PACKAGE__->mk_ro_accessors(qw( message payload type ));
  25
  26 =head1 NAME
  27
  28 Koha::Object::Message - Class encapsulating action feedback messages in Koha::Object-derived classes
  29
  30 =head1 SYNOPSIS
  31
  32   my ($self, $params) = @_;
  33   push @{$self->{_messages}} = Koha::Object::Message->new($params);
  34
  35 =head1 API
  36
  37 =head2 Class methods
  38
  39 =head3 new
  40
  41     my $message = Koha::Object::Message->new(
  42         {
  43             message => $some_message,
  44           [ type    => 'error',
  45             payload => $payload ]
  46         }
  47     );
  48
  49 Create a new Koha::Object::Message object.
  50
  51 =cut
  52
  53 sub new {
  54     my ( $class, $params ) = @_;
  55
  56     my $message = $params->{message};
  57     my $type    = $params->{type} // 'error';
  58     my $payload = $params->{payload};
  59
  60     Koha::Exceptions::MissingParameter->throw( "Mandatory parameter missing: 'message'" )
  61         unless $message;
  62
  63     my $self = $class->SUPER::new(
  64         {
  65             message => $message,
  66             type    => $type,
  67             payload => $payload,
  68         }
  69     );
  70
  71     return $self;
  72 }
  73
  74 =head1 AUTHOR
  75
  76 Tomas Cohen Arazi, E<lt>tomascohen@theke.ioE<gt>
  77
  78 =cut
  79
  80 1;