Dave Rolsky > Moose > Moose::Meta::Attribute::Native::Trait::Counter

Download:
Moose-0.92.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  4
Open  11
View Bugs
Report a bug
Module Version: 0.92   Source   Latest Release: Moose-0.93

NAME ^

Moose::Meta::Attribute::Native::Trait::Counter - Helper trait for counters

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

DESCRIPTION ^

This module provides a simple counter attribute, which can be incremented and decremented.

If your attribute definition does not include any of is, isa, default or handles but does use the Counter trait, then this module applies defaults as in the "SYNOPSIS" above. This allows for a very basic counter definition:

  has 'foo' => (traits => ['Counter']);
  $obj->inc_foo;

PROVIDED METHODS ^

These methods are implemented in Moose::Meta::Attribute::Native::MethodProvider::Counter. It is important to note that all those methods do in place modification of the value stored in the attribute.

set($value)

Set the counter to the specified value.

inc

Increments the value stored in this slot by 1. Providing an argument will cause the counter to be increased by specified amount.

dec

Decrements the value stored in this slot by 1. Providing an argument will cause the counter to be increased by specified amount.

reset

Resets the value stored in this slot to it's default value.

METHODS ^

meta
method_provider
has_method_provider

BUGS ^

All complex software has bugs lurking in it, and this module is no exception. If you find a bug please either email me, or add the bug to cpan-RT.

AUTHOR ^

Stevan Little <stevan@iinteractive.com>

COPYRIGHT AND LICENSE ^

Copyright 2007-2009 by Infinity Interactive, Inc.

http://www.iinteractive.com

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.