1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
|
package Moose::Meta::Attribute::Native::Trait::Hash;
use Moose::Role;
our $VERSION = '1.09';
$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';
use Moose::Meta::Attribute::Native::MethodProvider::Hash;
with 'Moose::Meta::Attribute::Native::Trait';
has 'method_provider' => (
is => 'ro',
isa => 'ClassName',
predicate => 'has_method_provider',
default => 'Moose::Meta::Attribute::Native::MethodProvider::Hash'
);
sub _helper_type { 'HashRef' }
no Moose::Role;
1;
__END__
=pod
=head1 NAME
Moose::Meta::Attribute::Native::Trait::Hash - Helper trait for HashRef attributes
=head1 SYNOPSIS
package Stuff;
use Moose;
has 'options' => (
traits => ['Hash'],
is => 'ro',
isa => 'HashRef[Str]',
default => sub { {} },
handles => {
set_option => 'set',
get_option => 'get',
has_no_options => 'is_empty',
num_options => 'count',
delete_option => 'delete',
pairs => 'kv',
},
);
=head1 DESCRIPTION
This module provides a Hash attribute which provides a number of
hash-like operations.
=head1 PROVIDED METHODS
These methods are implemented in
L<Moose::Meta::Attribute::Native::MethodProvider::Hash>.
=over 4
=item B<get($key, $key2, $key3...)>
Returns values from the hash.
In list context return a list of values in the hash for the given keys.
In scalar context returns the value for the last key specified.
=item B<set($key =E<gt> $value, $key2 =E<gt> $value2...)>
Sets the elements in the hash to the given values.
=item B<delete($key, $key2, $key3...)>
Removes the elements with the given keys.
=item B<keys>
Returns the list of keys in the hash.
=item B<exists($key)>
Returns true if the given key is present in the hash.
=item B<defined($key)>
Returns true if the value of a given key is defined.
=item B<values>
Returns the list of values in the hash.
=item B<kv>
Returns the key/value pairs in the hash as an array of array references.
for my $pair ( $object->options->pairs ) {
print "$pair->[0] = $pair->[1]\n";
}
=item B<elements>
Returns the key/value pairs in the hash as a flattened list..
=item B<clear>
Resets the hash to an empty value, like C<%hash = ()>.
=item B<count>
Returns the number of elements in the hash. Also useful for not empty:
C<< has_options => 'count' >>.
=item B<is_empty>
If the hash is populated, returns false. Otherwise, returns true.
=item B<accessor>
If passed one argument, returns the value of the specified key. If passed two
arguments, sets the value of the specified key.
=back
=head1 METHODS
=over 4
=item B<meta>
=item B<method_provider>
=item B<has_method_provider>
=back
=head1 BUGS
See L<Moose/BUGS> for details on reporting bugs.
=head1 AUTHOR
Stevan Little E<lt>stevan@iinteractive.comE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright 2007-2009 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|