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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
package Mixin::ExtraFields::Param 0.022;
# ABSTRACT: make your class provide a familiar "param" method
use warnings;
use strict;
use Mixin::ExtraFields 0.002 ();
use parent qw(Mixin::ExtraFields);
use Carp ();
#pod =head1 SYNOPSIS
#pod
#pod package Widget::Parametric;
#pod use Mixin::ExtraFields::Param -fields => { driver => 'HashGuts' };;
#pod
#pod ...
#pod
#pod my $widget = Widget::Parametric->new({ flavor => 'vanilla' });
#pod
#pod printf "%s: %s\n", $_, $widget->param($_) for $widget->param;
#pod
#pod =head1 DESCRIPTION
#pod
#pod This module mixes in to your class to provide a C<param> method like the ones
#pod provided by L<CGI>, L<CGI::Application>, and other classes. It uses
#pod Mixin::ExtraFields, which means it can use any Mixin::ExtraFields driver to
#pod store your data.
#pod
#pod By default, the methods provided are:
#pod
#pod =for :list
#pod * param
#pod * exists_param
#pod * delete_param
#pod
#pod These methods are imported by the C<fields> group, which must be requested. If
#pod a C<moniker> argument is supplied, the moniker is used instead of "param". For
#pod more information, see L<Mixin::ExtraFields>.
#pod
#pod =cut
sub default_moniker { 'param' }
sub methods { qw(param exists delete) }
sub method_name {
my ($self, $method, $moniker) = @_;
return $moniker if $method eq 'param';
return $self->SUPER::method_name($method, $moniker);
}
sub build_method {
my ($self, $method_name, $arg) = @_;
return $self->_build_param_method($arg) if $method_name eq 'param';
return $self->SUPER::build_method($method_name, $arg);
}
#pod =method param
#pod
#pod my @params = $object->param; # get names of existing params
#pod
#pod my $value = $object->param('name'); # get value of a param
#pod
#pod my $value = $object->param(name => $value); # set a param's value
#pod
#pod my @values = $object->param(n1 => $v1, n2 => $v2, ...); # set many values
#pod
#pod This method sets or retrieves parameters.
#pod
#pod =cut
sub _build_param_method {
my ($self, $arg) = @_;
my $id_method = $arg->{id_method};
my $driver = $arg->{driver};
my $names_method = $self->driver_method_name('get_all_names');
my $get_method = $self->driver_method_name('get');
my $set_method = $self->driver_method_name('set');
sub {
my $self = shift;
my $id = $self->$$id_method;
# If called as ->param, return all names.
return $$driver->$names_method($self, $id) unless @_;
# If given a hashref, as first arg, operate on its contents. In the
# future, we might want to complain if we get a hashref /and/ further
# arguments.
@_ = %{$_[0]} if @_ == 1 and ref $_[0] eq 'HASH';
Carp::croak "invalid call to param: odd, non-one number of params"
if @_ > 1 and @_ % 2 == 1;
# If called as ->param($name), return the value
return $$driver->$get_method($self, $id, $_[0]) if @_ == 1;
# Otherwise we're doing... BULK ASSIGNMENT!
my @assigned;
while (@_) {
# We don't put @_ into a hash because we guarantee processing (and more
# importantly return) order. -- rjbs, 2006-03-14
my ($key, $value) = splice @_, 0, 2;
$$driver->$set_method($self, $id, $key => $value);
push @assigned, $value;
}
return wantarray ? @assigned : $assigned[0];
};
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Mixin::ExtraFields::Param - make your class provide a familiar "param" method
=head1 VERSION
version 0.022
=head1 SYNOPSIS
package Widget::Parametric;
use Mixin::ExtraFields::Param -fields => { driver => 'HashGuts' };;
...
my $widget = Widget::Parametric->new({ flavor => 'vanilla' });
printf "%s: %s\n", $_, $widget->param($_) for $widget->param;
=head1 DESCRIPTION
This module mixes in to your class to provide a C<param> method like the ones
provided by L<CGI>, L<CGI::Application>, and other classes. It uses
Mixin::ExtraFields, which means it can use any Mixin::ExtraFields driver to
store your data.
By default, the methods provided are:
=over 4
=item *
param
=item *
exists_param
=item *
delete_param
=back
These methods are imported by the C<fields> group, which must be requested. If
a C<moniker> argument is supplied, the moniker is used instead of "param". For
more information, see L<Mixin::ExtraFields>.
=head1 PERL VERSION
This library should run on perls released even a long time ago. It should work
on any version of perl released in the last five years.
Although it may work on older versions of perl, no guarantee is made that the
minimum required version will not be increased. The version may be increased
for any reason, and there is no promise that patches will be accepted to lower
the minimum required perl.
=head1 METHODS
=head2 param
my @params = $object->param; # get names of existing params
my $value = $object->param('name'); # get value of a param
my $value = $object->param(name => $value); # set a param's value
my @values = $object->param(n1 => $v1, n2 => $v2, ...); # set many values
This method sets or retrieves parameters.
=head1 AUTHOR
Ricardo SIGNES <cpan@semiotic.systems>
=head1 CONTRIBUTORS
=for stopwords Ricardo SIGNES Signes
=over 4
=item *
Ricardo SIGNES <rjbs@codesimply.com>
=item *
Ricardo Signes <rjbs@semiotic.systems>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2005 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
