147 lines
2.3 KiB
Perl
147 lines
2.3 KiB
Perl
package Moose::Meta::Attribute::Native::Trait::Bool;
|
|
our $VERSION = '2.2207';
|
|
|
|
use Moose::Role;
|
|
with 'Moose::Meta::Attribute::Native::Trait';
|
|
|
|
sub _helper_type { 'Bool' }
|
|
|
|
no Moose::Role;
|
|
|
|
1;
|
|
|
|
# ABSTRACT: Helper trait for Bool attributes
|
|
|
|
__END__
|
|
|
|
=pod
|
|
|
|
=encoding UTF-8
|
|
|
|
=head1 NAME
|
|
|
|
Moose::Meta::Attribute::Native::Trait::Bool - Helper trait for Bool attributes
|
|
|
|
=head1 VERSION
|
|
|
|
version 2.2207
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
package Room;
|
|
use Moose;
|
|
|
|
has 'is_lit' => (
|
|
traits => ['Bool'],
|
|
is => 'rw',
|
|
isa => 'Bool',
|
|
default => 0,
|
|
handles => {
|
|
illuminate => 'set',
|
|
darken => 'unset',
|
|
flip_switch => 'toggle',
|
|
is_dark => 'not',
|
|
},
|
|
);
|
|
|
|
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
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This trait provides native delegation methods for boolean values. A boolean is
|
|
a scalar which can be C<1>, C<0>, C<"">, or C<undef>.
|
|
|
|
=head1 DEFAULT TYPE
|
|
|
|
If you don't provide an C<isa> value for your attribute, it will default to
|
|
C<Bool>.
|
|
|
|
=head1 PROVIDED METHODS
|
|
|
|
None of these methods accept arguments.
|
|
|
|
=over 4
|
|
|
|
=item * B<set>
|
|
|
|
Sets the value to C<1> and returns C<1>.
|
|
|
|
=item * B<unset>
|
|
|
|
Set the value to C<0> and returns C<0>.
|
|
|
|
=item * B<toggle>
|
|
|
|
Toggles the value. If it's true, set to false, and vice versa.
|
|
|
|
Returns the new value.
|
|
|
|
=item * B<not>
|
|
|
|
Equivalent of 'not C<$value>'.
|
|
|
|
=back
|
|
|
|
=head1 BUGS
|
|
|
|
See L<Moose/BUGS> for details on reporting bugs.
|
|
|
|
=head1 AUTHORS
|
|
|
|
=over 4
|
|
|
|
=item *
|
|
|
|
Stevan Little <stevan@cpan.org>
|
|
|
|
=item *
|
|
|
|
Dave Rolsky <autarch@urth.org>
|
|
|
|
=item *
|
|
|
|
Jesse Luehrs <doy@cpan.org>
|
|
|
|
=item *
|
|
|
|
Shawn M Moore <sartak@cpan.org>
|
|
|
|
=item *
|
|
|
|
יובל קוג'מן (Yuval Kogman) <nothingmuch@woobling.org>
|
|
|
|
=item *
|
|
|
|
Karen Etheridge <ether@cpan.org>
|
|
|
|
=item *
|
|
|
|
Florian Ragwitz <rafl@debian.org>
|
|
|
|
=item *
|
|
|
|
Hans Dieter Pearcey <hdp@cpan.org>
|
|
|
|
=item *
|
|
|
|
Chris Prather <chris@prather.org>
|
|
|
|
=item *
|
|
|
|
Matt S Trout <mstrout@cpan.org>
|
|
|
|
=back
|
|
|
|
=head1 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.
|
|
|
|
=cut
|