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
|
=pod
=encoding utf-8
=head1 NAME
Sub::HandlesVia::Manual::WithClassTiny - using Sub::HandlesVia with Class::Tiny
=head1 SYNOPSIS
package Kitchen;
use Class::Tiny {
foods => sub { [] },
drinks => sub { [ 'water' ] },
};
use Sub::HandlesVia::Declare 'foods', Array => (
all_foods => 'all',
add_food => 'push',
);
use Sub::HandlesVia::Declare 'drinks', Array => (
all_drinks => 'all',
add_drink => 'push',
);
=head1 MANUAL
Sub::HandlesVia allows you to delegate methods from your class to the
values of your objects' attributes.
Conceptually, it allows you to define C<< $object->push_number($n) >>
to be a shortcut for C<< $object->numbers->push($n) >> except that
C<< $object->numbers >> is an arrayref, so doesn't have methods you
can call on it like C<push>.
=head2 Which Methods Can Be Delegated To?
The second parameter ("Array" in the synopsis) indicates which library
of methods should be available. Valid values include
L<Array|Sub::HandlesVia::HandlerLibrary::Array>,
L<Blessed|Sub::HandlesVia::HandlerLibrary::Blessed>,
L<Bool|Sub::HandlesVia::HandlerLibrary::Bool>,
L<Code|Sub::HandlesVia::HandlerLibrary::Code>,
L<Counter|Sub::HandlesVia::HandlerLibrary::Counter>,
L<Enum|Sub::HandlesVia::HandlerLibrary::Enum>,
L<Hash|Sub::HandlesVia::HandlerLibrary::Hash>,
L<Number|Sub::HandlesVia::HandlerLibrary::Number>,
L<Scalar|Sub::HandlesVia::HandlerLibrary::Scalar>, and
L<String|Sub::HandlesVia::HandlerLibrary::String>.
An arrayref can be provided, though many of the options are conceptually
contradictory.
use Sub::HandlesVia::Declare 'num', [ 'Number', 'Scalar' ] => (
...,
);
=head2 Run-Time Delegation
Rather than using L<Sub::HandlesVia::Declare> which operates at compile time,
you can use the C<delegations> function at run time. Which you choose is
largely down to style and personal preference.
package Kitchen;
use Class::Tiny {
foods => sub { [] },
drinks => sub { [ 'water' ] },
};
use Sub::HandlesVia qw( delegations );
delegations(
attribute => 'foods',
handles_via => 'Array',
handles => {
all_foods => 'all',
add_food => 'push',
},
);
delegations(
attribute => 'drinks',
handles_via => 'Array',
handles => {
all_drinks => 'all',
add_drink => 'push',
},
);
=head1 BUGS
Please report any bugs to
L<https://github.com/tobyink/p5-sub-handlesvia/issues>.
=head1 SEE ALSO
Misc advanced documentation:
L<Sub::HandlesVia::Manual::Advanced>.
L<Sub::HandlesVia>.
Documentation for delegatable methods:
L<Sub::HandlesVia::HandlerLibrary::Array>,
L<Sub::HandlesVia::HandlerLibrary::Blessed>,
L<Sub::HandlesVia::HandlerLibrary::Bool>,
L<Sub::HandlesVia::HandlerLibrary::Code>,
L<Sub::HandlesVia::HandlerLibrary::Counter>,
L<Sub::HandlesVia::HandlerLibrary::Enum>,
L<Sub::HandlesVia::HandlerLibrary::Hash>,
L<Sub::HandlesVia::HandlerLibrary::Number>,
L<Sub::HandlesVia::HandlerLibrary::Scalar>, and
L<Sub::HandlesVia::HandlerLibrary::String>.
=head1 AUTHOR
Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
=head1 COPYRIGHT AND LICENCE
This software is copyright (c) 2022 by Toby Inkster.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 DISCLAIMER OF WARRANTIES
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|
