Browse Source
This minimal class encapsulates the tabs to be passed around to the templates, so error checking on missing bits is done in a single place. It throws exceptions on errors Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>remotes/origin/19.11.x
4 changed files with 170 additions and 6 deletions
@ -0,0 +1,72 @@ |
|||
package Koha::Plugins::Tab; |
|||
|
|||
# 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, write to the Free Software Foundation, Inc., |
|||
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
|||
|
|||
|
|||
use Modern::Perl; |
|||
|
|||
use Koha::Exceptions; |
|||
|
|||
use base qw(Class::Accessor); |
|||
|
|||
__PACKAGE__->mk_accessors(qw( title content id )); |
|||
|
|||
=head1 NAME |
|||
|
|||
Koha::Plugins::Tab - Simple base to abstract tabs to be generated by plugins |
|||
|
|||
=head1 DESCRIPTION |
|||
|
|||
Object-oriented class that represents tabs generated by plugins. Error handling on |
|||
mandatory fields is handled here. |
|||
|
|||
=head1 API |
|||
|
|||
=head2 Class methods |
|||
|
|||
=head3 new |
|||
|
|||
my $tab = Koha::Plugins::Tab->new( |
|||
{ |
|||
title => 'A title', |
|||
content => 'Some content' |
|||
} |
|||
); |
|||
|
|||
Returns a Koha::Plugins::Tab object representing a plugin-generated tab. |
|||
|
|||
=cut |
|||
|
|||
sub new { |
|||
|
|||
my ( $class, $params ) = @_; |
|||
|
|||
Koha::Exceptions::MissingParameter->throw( "Mandatory parameter 'title' missing" ) |
|||
unless defined $params->{ title }; |
|||
|
|||
Koha::Exceptions::MissingParameter->throw( "Mandatory parameter 'content' missing") |
|||
unless defined $params->{content}; |
|||
|
|||
my $self = { |
|||
title => $params->{title}, |
|||
content => $params->{content} |
|||
}; |
|||
|
|||
bless $self, $class; |
|||
return $self; |
|||
} |
|||
|
|||
1; |
@ -0,0 +1,62 @@ |
|||
#!/usr/bin/perl |
|||
|
|||
# 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 <http://www.gnu.org/licenses>. |
|||
|
|||
use Modern::Perl; |
|||
|
|||
use Test::More tests => 1; |
|||
use Test::Exception; |
|||
|
|||
use Koha::Plugins::Tab; |
|||
|
|||
subtest 'new() tests' => sub { |
|||
plan tests => 7; |
|||
|
|||
throws_ok { Koha::Plugins::Tab->new( { title => 'A title' } ); } |
|||
'Koha::Exceptions::MissingParameter', |
|||
'Exception is thrown on missing content'; |
|||
|
|||
is( |
|||
"$@", |
|||
"Mandatory parameter 'content' missing", |
|||
'Exception message is correct' |
|||
); |
|||
|
|||
throws_ok { Koha::Plugins::Tab->new( { content => 'Some content' } ); } |
|||
'Koha::Exceptions::MissingParameter', |
|||
'Exception is thrown on missing title'; |
|||
|
|||
is( |
|||
"$@", |
|||
"Mandatory parameter 'title' missing", |
|||
'Exception message is correct' |
|||
); |
|||
|
|||
my $tab = Koha::Plugins::Tab->new( |
|||
{ |
|||
title => 'A title', |
|||
content => 'Some content' |
|||
} |
|||
); |
|||
|
|||
is( $tab->title, 'A title', 'title accessor is correct' ); |
|||
is( $tab->content, 'Some content', 'content accessor is correct' ); |
|||
|
|||
my $id = 'calculated-id'; |
|||
$tab->id($id); |
|||
|
|||
is( $tab->id, $id, 'The id can be calculated and set on runtime' ); |
|||
}; |
Loading…
Reference in new issue