package Moose::Meta::Attribute::Native::Trait::Counter;
BEGIN {
$Moose::Meta::Attribute::Native::Trait::Counter::AUTHORITY = 'cpan:STEVAN';
}
{
$Moose::Meta::Attribute::Native::Trait::Counter::VERSION = '2.0603';
}
use Moose::Role;
with 'Moose::Meta::Attribute::Native::Trait' =>
{ -excludes => ['_root_types'] };
sub _default_default { 0 }
sub _default_is { 'ro' }
sub _helper_type { 'Num' }
sub _root_types { 'Num', 'Int' }
no Moose::Role;
1;
# ABSTRACT: Helper trait for Int attributes which represent counters
=pod
=head1 NAME
Moose::Meta::Attribute::Native::Trait::Counter - Helper trait for Int attributes which represent counters
=head1 VERSION
version 2.0603
=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 AUTHOR
Moose is maintained by the Moose Cabal, along with the help of many contributors. See L<Moose/CABAL> and L<Moose/CONTRIBUTORS> for details.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2012 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
__END__