Koha-clms/Koha/Patron/MessagePreferences.pm

155 lines
4.1 KiB
Perl

package Koha::Patron::MessagePreferences;
# Copyright Koha-Suomi Oy 2016
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <https://www.gnu.org/licenses>.
use Modern::Perl;
use Koha::Database;
use Koha::Patron::MessagePreference::Attributes;
use Koha::Patron::MessagePreference;
use Koha::Patron::MessagePreference::Transports;
use base qw(Koha::Objects);
=head1 NAME
Koha::Patron::MessagePreferences - Koha Patron Message Preferences object class
=head1 API
=head2 Class Methods
=cut
=head3 find_with_message_name
Koha::Patron::MessagePreferences->find_with_message_name({
borrowernumber => 123,
message_name => 'Hold_Filled',
});
Converts C<message_name> into C<message_attribute_id> and continues find.
=cut
sub find_with_message_name {
my ( $self, $id ) = @_;
if ( ref($id) eq "HASH" && $id->{'message_name'} ) {
my $attr = Koha::Patron::MessagePreference::Attributes->find(
{
message_name => $id->{'message_name'},
}
);
$id->{'message_attribute_id'} = ($attr) ? $attr->message_attribute_id : undef;
delete $id->{'message_name'};
}
return $self->SUPER::find($id);
}
=head3 get_options
my $messaging_options = Koha::Patron::MessagePreferences->get_options
Returns an ARRAYref of HASHrefs on available messaging options.
=cut
sub get_options {
my ($self) = @_;
my $transports = Koha::Patron::MessagePreference::Transports->search(
undef,
{
join => ['message_attribute'],
'+select' => [ 'message_attribute.message_name', 'message_attribute.takes_days' ],
'+as' => [ 'message_name', 'takes_days' ],
}
);
my $choices;
while ( my $transport = $transports->next ) {
my $name = $transport->get_column('message_name');
$choices->{$name}->{'message_attribute_id'} = $transport->message_attribute_id;
$choices->{$name}->{'message_name'} = $name;
$choices->{$name}->{'takes_days'} = $transport->get_column('takes_days');
$choices->{$name}->{'has_digest'} ||= 1 if $transport->is_digest;
$choices->{$name}->{'has_digest_off'} ||= 1 if !$transport->is_digest;
$choices->{$name}->{ 'transport_' . $transport->get_column('message_transport_type') } = ' ';
}
my @return = values %$choices;
@return = sort { $a->{message_attribute_id} <=> $b->{message_attribute_id} } @return;
return \@return;
}
=head3 search_with_message_name
Koha::Patron::MessagePreferences->search_with_message_name({
borrowernumber => 123,
message_name => 'Hold_Filled',
});
Converts C<message_name> into C<message_attribute_id> and continues search. Use
Koha::Patron::MessagePreferences->search with a proper join for more complicated
searches.
=cut
sub search_with_message_name {
my ( $self, $params, $attributes ) = @_;
if ( ref($params) eq "HASH" && $params->{'message_name'} ) {
my $attr = Koha::Patron::MessagePreference::Attributes->find(
{
message_name => $params->{'message_name'},
}
);
$params->{'message_attribute_id'} = ($attr) ? $attr->message_attribute_id : undef;
delete $params->{'message_name'};
}
return $self->SUPER::search( $params, $attributes );
}
=head3 _type
=cut
sub _type {
return 'BorrowerMessagePreference';
}
=head3 object_class
=cut
sub object_class {
return 'Koha::Patron::MessagePreference';
}
=head1 AUTHOR
Lari Taskula <lari.taskula@hypernova.fi>
=cut
1;