Scroll to navigation

Sub::HandlesVia::Manual::WithClassTiny(3) User Contributed Perl Documentation Sub::HandlesVia::Manual::WithClassTiny(3)

NAME

Sub::HandlesVia::Manual::WithClassTiny - using Sub::HandlesVia with Class::Tiny

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',
 );

MANUAL

Sub::HandlesVia allows you to delegate methods from your class to the values of your objects' attributes.

Conceptually, it allows you to define "$object->push_number($n)" to be a shortcut for "$object->numbers->push($n)" except that "$object->numbers" is an arrayref, so doesn't have methods you can call on it like "push".

Which Methods Can Be Delegated To?

The second parameter ("Array" in the synopsis) indicates which library of methods should be available. Valid values include Array, Blessed, Bool, Code, Counter, Enum, Hash, Number, Scalar, and String.

An arrayref can be provided, though many of the options are conceptually contradictory.

 use Sub::HandlesVia::Declare 'num', [ 'Number', 'Scalar' ] => (
   ...,
 );

Run-Time Delegation

Rather than using Sub::HandlesVia::Declare which operates at compile time, you can use the "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',
   },
 );

BUGS

Please report any bugs to <https://github.com/tobyink/p5-sub-handlesvia/issues>.

SEE ALSO

Misc advanced documentation: Sub::HandlesVia::Manual::Advanced.

Sub::HandlesVia.

Documentation for delegatable methods: Sub::HandlesVia::HandlerLibrary::Array, Sub::HandlesVia::HandlerLibrary::Blessed, Sub::HandlesVia::HandlerLibrary::Bool, Sub::HandlesVia::HandlerLibrary::Code, Sub::HandlesVia::HandlerLibrary::Counter, Sub::HandlesVia::HandlerLibrary::Enum, Sub::HandlesVia::HandlerLibrary::Hash, Sub::HandlesVia::HandlerLibrary::Number, Sub::HandlesVia::HandlerLibrary::Scalar, and Sub::HandlesVia::HandlerLibrary::String.

AUTHOR

Toby Inkster <tobyink@cpan.org>.

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.

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.

2023-04-06 perl v5.38.2