Moose::Meta::AtUseMrooCsoen:t:rMiebtuat:e:dAtPterrilbuDtoec:u:mNeanttiavtei::Trait::Array(3p)


NAME
       Moose::Meta::Attribute::Native::Trait::Array - Helper trait for
       ArrayRef attributes

SYNOPSIS
           package Stuff;
           use Moose;

           has 'options' => (
              traits     => ['Array'],
              is         => 'ro',
              isa        => 'ArrayRef[Str]',
              default    => sub { [] },
              handles    => {
                  all_options    => 'elements',
                  add_option     => 'push',
                  map_options    => 'map',
                  filter_options => 'grep',
                  find_option    => 'first',
                  get_option     => 'get',
                  join_options   => 'join',
                  count_options  => 'count',
                  has_options    => 'count',
                  has_no_options => 'is_empty',
                  sorted_options => 'sort',
              },
           );

           no Moose;
           1;

DESCRIPTION
       This module provides an Array attribute which provides a number of
       array operations.

PROVIDED METHODS
       These methods are implemented in
       Moose::Meta::Attribute::Native::MethodProvider::Array.

       count
           Returns the number of elements in the array.

              $stuff = Stuff->new;
              $stuff->options(["foo", "bar", "baz", "boo"]);

              my $count = $stuff->count_options;
              print "$count\n"; # prints 4

       is_empty
           Returns a boolean value that is true when the array has no
           elements.

              $stuff->has_no_options ? die "No options!\n" : print "Good boy.\n";




perl v5.12.2                2010-06-15                          1





Moose::Meta::AtUseMrooCsoen:t:rMiebtuat:e:dAtPterrilbuDtoec:u:mNeanttiavtei::Trait::Array(3p)


       elements
           Returns all of the elements of the array.

              my @option = $stuff->all_options;
              print "@options\n"; # prints "foo bar baz boo"

       get($index)
           Returns an element of the array by its index. You can also use
           negative index numbers, just as with Perl's core array handling.

              my $option = $stuff->get_option(1);
              print "$option\n"; # prints "bar"

       pop
       push($value1, $value2, value3 ...)
       shift
       unshift($value1, $value2, value3 ...)
       splice($offset, $length, @values)
           These methods are all equivalent to the Perl core functions of the
           same name.

       first( sub { ... } )
           This method returns the first item matching item in the array, just
           like List::Util's "first" function. The matching is done with a
           subroutine reference you pass to this method. The reference will be
           called against each element in the array until one matches or all
           elements have been checked.

              my $found = $stuff->find_option( sub { /^b/ } );
              print "$found\n"; # prints "bar"

       grep( sub { ... } )
           This method returns every element matching a given criteria, just
           like Perl's core "grep" function. This method requires a subroutine
           which implements the matching logic.

              my @found = $stuff->filter_options( sub { /^b/ } );
              print "@found\n"; # prints "bar baz boo"

       map( sub { ... } )
           This method transforms every element in the array and returns a new
           array, just like Perl's core "map" function. This method requires a
           subroutine which implements the transformation.

              my @mod_options = $stuff->map_options( sub { $_ . "-tag" } );
              print "@mod_options\n"; # prints "foo-tag bar-tag baz-tag boo-tag"

       reduce( sub { ... } )
           This method condenses an array into a single value, by passing a
           function the value so far and the next value in the array, just
           like List::Util's "reduce" function. The reducing is done with a
           subroutine reference you pass to this method.





perl v5.12.2                2010-06-15                          2





Moose::Meta::AtUseMrooCsoen:t:rMiebtuat:e:dAtPterrilbuDtoec:u:mNeanttiavtei::Trait::Array(3p)


              my $found = $stuff->reduce_options( sub { $_[0] . $_[1] } );
              print "$found\n"; # prints "foobarbazboo"

       sort( sub { ... } )
           Returns a the array in sorted order.

           You can provide an optional subroutine reference to sort with (as
           you can with Perl's core "sort" function). However, instead of
           using $a and $b, you will need to use $_[0] and $_[1] instead.

              # ascending ASCIIbetical
              my @sorted = $stuff->sort_options();

              # Descending alphabetical order
              my @sorted_options = $stuff->sort_options( sub { lc $_[1] cmp lc $_[0] } );
              print "@sorted_options\n"; # prints "foo boo baz bar"

       sort_in_place
           Sorts the array in place, modifying the value of the attribute.

           You can provide an optional subroutine reference to sort with (as
           you can with Perl's core "sort" function). However, instead of
           using $a and $b, you will need to use $_[0] and $_[1] instead.

       shuffle
           Returns the array, with indices in random order, like "shuffle"
           from List::Util.

       uniq
           Returns the array, with all duplicate elements removed, like "uniq"
           from List::MoreUtils.

       join($str)
           Joins every element of the array using the separator given as
           argument, just like Perl's core "join" function.

              my $joined = $stuff->join_options( ':' );
              print "$joined\n"; # prints "foo:bar:baz:boo"

       set($index, $value)
           Given an index and a value, sets the specified array element's
           value.

       delete($index)
           Removes the element at the given index from the array.

       insert($index, $value)
           Inserts a new element into the array at the given index.

       clear
           Empties the entire array, like "@array = ()".

       accessor
           This method provides a get/set accessor for the array, based on



perl v5.12.2                2010-06-15                          3





Moose::Meta::AtUseMrooCsoen:t:rMiebtuat:e:dAtPterrilbuDtoec:u:mNeanttiavtei::Trait::Array(3p)


           array indexes.  If passed one argument, it returns the value at the
           specified index.  If passed two arguments, it sets the value of the
           specified index.

       natatime($n, $code)
           This method returns an iterator which, on each call, returns $n
           more items from the array, in order, like "natatime" from
           List::MoreUtils. A coderef can optionally be provided; it will be
           called on each group of $n elements in the array.

METHODS
       meta
       method_provider
       has_method_provider

BUGS
       See "BUGS" in Moose for details on reporting bugs.

AUTHOR
       Stevan Little <stevanATiinteractive.com>

COPYRIGHT AND LICENSE
       Copyright 2007-2009 by Infinity Interactive, Inc.

       <http://www.iinteractive.com>;

       This library is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.





























perl v5.12.2                2010-06-15                          4