From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

NHORNE / Params-Get-0.02 / lib / Params / Get.pm 

            

              
1
2
3
4
5
6
7
8
—
9
10
11
12
13
14
15
16
17
18
19
20
—
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
—
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

              
package Params::Get;
use strict;
use warnings;
use Carp;
our @ISA = qw(Exporter);
our @EXPORT_OK = qw(get_params);
=head1 NAME
Params::Get - Get the parameters to a subroutine in any way you want
=head1 VERSION
Version 0.02
=cut
our $VERSION = '0.02';
=head1 SYNOPSIS
    use Params::Get;
    use Params::Validate::Strict;
    sub where_am_i
    {
        my $params = Params::Validate::Strict::validate_strict({
            args => Params::Get::get_params(undef, @_),
            schema => {
                'latitude' => {
                    type => 'number',
                    min => -180,
                    max => 180
                }, 'longitude' => {
                    type => 'number',
                    min => -180,
                    max => 180
                }
            }
        });
        print 'You are at ', $params->{'latitude'}, ', ', $params->{'longitude'}, "\n";
    }
    where_am_i(latitude => 0.3, longitude => 124);
    where_am_i({ latitude => 3.14, longitude => -155 });
=head1  METHODS
=head2 get_params
Parse the arguments given to a function.
Processes arguments passed to methods and ensures they are in a usable format,
allowing the caller to call the function in any way that they want
e.g. `foo('bar')`, `foo(arg => 'bar')`, `foo({ arg => 'bar' })` all mean the same
when called get_params('arg', @_);
=cut
sub get_params
{
        my $default = shift;
        # Directly return hash reference if the first parameter is a hash reference
        return $_[0] if(ref($_[0]) eq 'HASH');
        my $num_args = scalar(@_);
        # Populate %rc based on the number and type of arguments
        if($num_args == 1) {
                if(defined($default)) {
                        # %rc = ($default => shift);
                        return { $default => shift };
                }
                Carp::croak('Usage: ', __PACKAGE__, '->', (caller(1))[3], '()');
        }
        if($num_args == 0) {
                if(defined($default)) {
                        # No means to say that the default is optional
                        Carp::croak('Usage: ', __PACKAGE__, '->', (caller(1))[3], "($default => \$val)");
                }
                return;
        }
        if(($num_args % 2) == 0) {
                my %rc = @_;
                return \%rc;
        }
        Carp::croak('Usage: ', __PACKAGE__, '->', (caller(1))[3], '()');
}
=head1 AUTHOR
Nigel Horne, C<< <njh at nigelhorne.com> >>
=head1 BUGS
=head1 SEE ALSO
=over 4
=item * L<Params::Validate::Strict>
=back
=head1 SUPPORT
This module is provided as-is without any warranty.
Please report any bugs or feature requests to C<bug-params-get at rt.cpan.org>,
or through the web interface at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Params-Get>.
I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
    perldoc Params::Get
You can also look for information at:
=over 4
=item * MetaCPAN
L<https://metacpan.org/dist/Params-Get>
=item * RT: CPAN's request tracker
L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=Params-Get>
=item * CPAN Testers' Matrix
L<http://matrix.cpantesters.org/?dist=Params-Get>
=item * CPAN Testers Dependencies
L<http://deps.cpantesters.org/?module=Params::Get>
=back
=head1 LICENSE AND COPYRIGHT
Copyright 2025 Nigel Horne.
This program is released under the following licence: GPL2
=cut
1;
__END__