158 lines
2.8 KiB
Perl
158 lines
2.8 KiB
Perl
package Moose::Meta::Attribute::Native::Trait::Counter;
|
|
our $VERSION = '2.2207';
|
|
|
|
use Moose::Role;
|
|
with 'Moose::Meta::Attribute::Native::Trait';
|
|
|
|
sub _helper_type { 'Num' }
|
|
sub _root_types { 'Num', 'Int' }
|
|
|
|
no Moose::Role;
|
|
|
|
1;
|
|
|
|
# ABSTRACT: Helper trait for Int attributes which represent counters
|
|
|
|
__END__
|
|
|
|
=pod
|
|
|
|
=encoding UTF-8
|
|
|
|
=head1 NAME
|
|
|
|
Moose::Meta::Attribute::Native::Trait::Counter - Helper trait for Int attributes which represent counters
|
|
|
|
=head1 VERSION
|
|
|
|
version 2.2207
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
package MyHomePage;
|
|
use Moose;
|
|
|
|
has 'counter' => (
|
|
traits => ['Counter'],
|
|
is => 'ro',
|
|
isa => 'Num',
|
|
default => 0,
|
|
handles => {
|
|
inc_counter => 'inc',
|
|
dec_counter => 'dec',
|
|
reset_counter => 'reset',
|
|
},
|
|
);
|
|
|
|
my $page = MyHomePage->new();
|
|
$page->inc_counter; # same as $page->counter( $page->counter + 1 );
|
|
$page->dec_counter; # same as $page->counter( $page->counter - 1 );
|
|
|
|
my $count_by_twos = 2;
|
|
$page->inc_counter($count_by_twos);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This trait provides native delegation methods for counters. A counter can be
|
|
any sort of number (integer or not). The delegation methods allow you to
|
|
increment, decrement, or reset the value.
|
|
|
|
=head1 DEFAULT TYPE
|
|
|
|
If you don't provide an C<isa> value for your attribute, it will default to
|
|
C<Num>.
|
|
|
|
=head1 PROVIDED METHODS
|
|
|
|
=over 4
|
|
|
|
=item * B<set($value)>
|
|
|
|
Sets the counter to the specified value and returns the new value.
|
|
|
|
This method requires a single argument.
|
|
|
|
=item * B<inc>
|
|
|
|
=item * B<inc($arg)>
|
|
|
|
Increases the attribute value by the amount of the argument, or by 1 if no
|
|
argument is given. This method returns the new value.
|
|
|
|
This method accepts a single argument.
|
|
|
|
=item * B<dec>
|
|
|
|
=item * B<dec($arg)>
|
|
|
|
Decreases the attribute value by the amount of the argument, or by 1 if no
|
|
argument is given. This method returns the new value.
|
|
|
|
This method accepts a single argument.
|
|
|
|
=item * B<reset>
|
|
|
|
Resets the value stored in this slot to its default value, and returns the new
|
|
value.
|
|
|
|
=back
|
|
|
|
=head1 BUGS
|
|
|
|
See L<Moose/BUGS> for details on reporting bugs.
|
|
|
|
=head1 AUTHORS
|
|
|
|
=over 4
|
|
|
|
=item *
|
|
|
|
Stevan Little <stevan@cpan.org>
|
|
|
|
=item *
|
|
|
|
Dave Rolsky <autarch@urth.org>
|
|
|
|
=item *
|
|
|
|
Jesse Luehrs <doy@cpan.org>
|
|
|
|
=item *
|
|
|
|
Shawn M Moore <sartak@cpan.org>
|
|
|
|
=item *
|
|
|
|
יובל קוג'מן (Yuval Kogman) <nothingmuch@woobling.org>
|
|
|
|
=item *
|
|
|
|
Karen Etheridge <ether@cpan.org>
|
|
|
|
=item *
|
|
|
|
Florian Ragwitz <rafl@debian.org>
|
|
|
|
=item *
|
|
|
|
Hans Dieter Pearcey <hdp@cpan.org>
|
|
|
|
=item *
|
|
|
|
Chris Prather <chris@prather.org>
|
|
|
|
=item *
|
|
|
|
Matt S Trout <mstrout@cpan.org>
|
|
|
|
=back
|
|
|
|
=head1 COPYRIGHT AND LICENSE
|
|
|
|
This software is copyright (c) 2006 by Infinity Interactive, Inc.
|
|
|
|
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
|