MooseX::AttributeHelpers::Trait::Bool - MooseX::AttributeHelpers::Trait::Bool documentation


MooseX-AttributeHelpers documentation  | view source Contained in the MooseX-AttributeHelpers distribution.

Index


NAME

Top

MooseX::AttributeHelpers::Bool

SYNOPSIS

Top

  package Room;
  use Moose;
  use MooseX::AttributeHelpers;

  has 'is_lit' => (
      metaclass => 'Bool',
      is        => 'rw',
      isa       => 'Bool',
      default   => sub { 0 },
      provides  => {
          set     => 'illuminate',
          unset   => 'darken',
          toggle  => 'flip_switch',
          not     => 'is_dark'
      }
  );

  my $room = Room->new();
  $room->illuminate;     # same as $room->is_lit(1);
  $room->darken;         # same as $room->is_lit(0);
  $room->flip_switch;    # same as $room->is_lit(not $room->is_lit);
  return $room->is_dark; # same as !$room->is_lit

DESCRIPTION

Top

This provides a simple boolean attribute, which supports most of the basic math operations.

METHODS

Top

meta
helper_type
method_constructors
has_method_provider
method_provider

PROVIDED METHODS

Top

It is important to note that all those methods do in place modification of the value stored in the attribute.

set

Sets the value to 1.

unset

Set the value to 0.

toggle

Toggle the value. If it's true, set to false, and vice versa.

not

Equivalent of 'not $value'.

BUGS

Top

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

Top

Jason May

COPYRIGHT AND LICENSE

Top


MooseX-AttributeHelpers documentation  | view source Contained in the MooseX-AttributeHelpers distribution.