2 package Moose::Meta::Attribute::Native::Trait::Hash;
6 $VERSION = eval $VERSION;
7 our $AUTHORITY = 'cpan:STEVAN';
9 use Moose::Meta::Method::Accessor::Native::Hash::accessor;
10 use Moose::Meta::Method::Accessor::Native::Hash::clear;
11 use Moose::Meta::Method::Accessor::Native::Hash::count;
12 use Moose::Meta::Method::Accessor::Native::Hash::defined;
13 use Moose::Meta::Method::Accessor::Native::Hash::delete;
14 use Moose::Meta::Method::Accessor::Native::Hash::elements;
15 use Moose::Meta::Method::Accessor::Native::Hash::exists;
16 use Moose::Meta::Method::Accessor::Native::Hash::get;
17 use Moose::Meta::Method::Accessor::Native::Hash::is_empty;
18 use Moose::Meta::Method::Accessor::Native::Hash::keys;
19 use Moose::Meta::Method::Accessor::Native::Hash::kv;
20 use Moose::Meta::Method::Accessor::Native::Hash::set;
21 use Moose::Meta::Method::Accessor::Native::Hash::values;
23 with 'Moose::Meta::Attribute::Native::Trait';
25 sub _helper_type { 'HashRef' }
37 Moose::Meta::Attribute::Native::Trait::Hash - Helper trait for HashRef attributes
47 isa => 'HashRef[Str]',
48 default => sub { {} },
52 has_no_options => 'is_empty',
53 num_options => 'count',
54 delete_option => 'delete',
61 This trait provides native delegation methods for array references.
63 =head1 PROVIDED METHODS
67 =item B<get($key, $key2, $key3...)>
69 Returns values from the hash.
71 In list context it returns a list of values in the hash for the given keys. In
72 scalar context it returns the value for the last key specified.
74 This method requires at least one argument.
76 =item B<set($key =E<gt> $value, $key2 =E<gt> $value2...)>
78 Sets the elements in the hash to the given values. It returns the new values
79 set for each key, in the same order as the keys passed to the method.
81 This method requires at least two arguments, and expects an even number of
84 =item B<delete($key, $key2, $key3...)>
86 Removes the elements with the given keys.
88 In list context it returns a list of values in the hash for the deleted
89 keys. In scalar context it returns the value for the last key specified.
93 Returns the list of keys in the hash.
95 This method does not accept any arguments.
99 Returns true if the given key is present in the hash.
101 This method requires a single argument.
103 =item B<defined($key)>
105 Returns true if the value of a given key is defined.
107 This method requires a single argument.
111 Returns the list of values in the hash.
113 This method does not accept any arguments.
117 Returns the key/value pairs in the hash as an array of array references.
119 for my $pair ( $object->options->pairs ) {
120 print "$pair->[0] = $pair->[1]\n";
123 This method does not accept any arguments.
127 Returns the key/value pairs in the hash as a flattened list..
129 This method does not accept any arguments.
133 Resets the hash to an empty value, like C<%hash = ()>.
135 This method does not accept any arguments.
139 Returns the number of elements in the hash. Also useful for not empty:
140 C<< has_options => 'count' >>.
142 This method does not accept any arguments.
146 If the hash is populated, returns false. Otherwise, returns true.
148 This method does not accept any arguments.
150 =item B<accessor($key)>
152 =item B<accessor($key, $value)>
154 If passed one argument, returns the value of the specified key. If passed two
155 arguments, sets the value of the specified key.
157 When called as a setter, this method returns the value that was set.
171 See L<Moose/BUGS> for details on reporting bugs.
175 Stevan Little E<lt>stevan@iinteractive.comE<gt>
177 =head1 COPYRIGHT AND LICENSE
179 Copyright 2007-2009 by Infinity Interactive, Inc.
181 L<http://www.iinteractive.com>
183 This library is free software; you can redistribute it and/or modify
184 it under the same terms as Perl itself.