Bug 31378: Add Koha::Auth::Client* modules
[koha.git] / Koha / Auth / Provider.pm
1 package Koha::Auth::Provider;
2
3 # Copyright Theke Solutions 2022
4 #
5 # This file is part of Koha.
6 #
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
19
20 use Modern::Perl;
21
22 use base qw(Koha::Object);
23
24 use Koha::Auth::Provider::Domains;
25
26 =head1 NAME
27
28 Koha::Auth::Provider - Koha Auth Provider Object class
29
30 =head1 API
31
32 =head2 Class methods
33
34 =head3 domains
35
36     my $domains = $provider->domains;
37
38 Returns the related I<Koha::Auth::Provider::Domains> iterator.
39
40 =cut
41
42 sub domains {
43     my ($self) = @_;
44
45     return Koha::Auth::Provider::Domains->_new_from_dbic( scalar $self->_result->domains );
46 }
47
48 =head2 Internal methods
49
50 =head3 _type
51
52 =cut
53
54 sub _type {
55     return 'AuthProvider';
56 }
57
58 1;