phpman > perldoc > Moose::Meta::Attribute::Native::Trait::Counter

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

VERSION
    version 2.2200

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

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.

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

PROVIDED METHODS
    *   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
    See "BUGS" in Moose for details on reporting bugs.

AUTHORS
    *   Stevan Little <stevan AT cpan.org>

    *   Dave Rolsky <autarch AT urth.org>

    *   Jesse Luehrs <doy AT cpan.org>

    *   Shawn M Moore <sartak AT cpan.org>

    *   יובל קוג'מן (Yuval Kogman) <nothingmuch AT woobling.org>

    *   Karen Etheridge <ether AT cpan.org>

    *   Florian Ragwitz <rafl AT debian.org>

    *   Hans Dieter Pearcey <hdp AT cpan.org>

    *   Chris Prather <chris AT prather.org>

    *   Matt S Trout <mstrout AT cpan.org>

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.