Moose::Meta::Attribute::Native::Trait::Counter - Helper trait for Int attributes which represent counters


Moose documentation  | view source Contained in the Moose distribution.

Index


NAME

Top

Moose::Meta::Attribute::Native::Trait::Counter - Helper trait for Int attributes which represent counters

VERSION

Top

version 2.0010

SYNOPSIS

Top

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

DESCRIPTION

Top

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.

DEFAULT TYPE

Top

If you don't provide an isa value for your attribute, it will default to Num.

PROVIDED METHODS

Top

* set($value)

Sets the counter to the specified value and returns the new value.

This method requires a single argument.

* inc
* 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.

* dec
* 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.

* reset

Resets the value stored in this slot to its default value, and returns the new value.

BUGS

Top

See BUGS in Moose for details on reporting bugs.

AUTHOR

Top

Stevan Little <stevan@iinteractive.com>

COPYRIGHT AND LICENSE

Top


Moose documentation  | view source Contained in the Moose distribution.