view release on metacpan or  search on metacpan

lib/Acme/MomoiroClover.pm  view on Meta::CPAN

sub _die {
    my ($self, $message) = @_;
    Carp::croak($message);
}

1;

__END__

=head1 NAME

Acme::MomoiroClover - All about Japanese lock star "Momoiro Clover"

=head1 SYNOPSIS

  use Acme::MomoiroClover;

  my $momoclo_chan = Acme::Momoiro::Z->new;

  # retrieve the members on their activities
  my @members              = $momoclo_chan->members;             # retrieve all
  my @active_members       = $momoclo_chan->members('active');
  my @graduate_members     = $momoclo_chan->members('graduate');
  my @at_some_time_members = $momoclo_chan->members(Date::Simple->new('2001-01-01'));

  # retrieve the members under some conditions
  my @sorted_by_age        = $momoclo_chan->sort('age', 1);
  my @sorted_by_class      = $momoclo_chan->sort('class', 1);
  my @selected_by_age      = $momoclo_chan->select('age', 17, '>=');
  my @selected_by_class    = $momoclo_chan->select('class', 5, '==');

=head1 DESCRIPTION

"Morning Clover" is one of highly famous Japanese lock stars.

This module, Acme::MomoiroClover, provides an easy method to catch up
with Momoiro Clover.

=head1 METHODS

=head2 new

=over 4

  my $momoclo_chan = Acme::MomoiroClover->new; // now obsolete
  $momoclo_chan = Acme::MomoiroClover::Z->new;

Creates and returns a new Acme::MomoiroClover::Z object.

=back

=head2 members ( $type )

=over 4

  # $type can be one of the values below:
  #  + active              : active members
  #  + graduate            : graduate members
  #  + Date::Simple object : members at the time passed in
  #  + undef               : all members

  my @members = $momoclo_chan->members('active');

Returns the members as a list of the L<Acme::MomoiroClover::Base>
based object represents each member. See also the documentation of
L<Acme::MomoiroClover::Base> for more details.

=back

=head2 sort ( $type, $order [ , @members ] )

=over 4

  # $type can be one of the values below:
  #  + age       :  sort by age
  #  + join_date :  sort by join_date
  #
  # $order can be a one of the values below:
  #  + something true value  :  sort in descending order
  #  + something false value :  sort in ascending order

  my @sorted_members = $momoclo_chan->sort('age', 1); # sort by age in descending order

Returns the members sorted by the I<$type> field.

=back

=head2 select ( $type, $number, $operator [, @members] )

=over 4

  # $type can be one of the same values above:
  my @selected_members = $momoclo_chan->select('age', 17, '>=');

Returns the members satisfy the given I<$type> condition. I<$operator>
must be a one of '==', '>=', '<=', '>', and '<'. This method compares
the given I<$type> to the member's one in the order below:

  $number $operator $member_value

=back

=head1 SEE ALSO

=over 4

=item * Momoiro Clover - Official WebPage

L<http://www.momoclo.net/>

=item * Momoiro Clover Z - Wikipedia

L<http://ja.wikipedia.org/wiki/%E3%82%82%E3%82%82%E3%81%84%E3%82%8D%E3%82%AF%E3%83%AD%E3%83%BC%E3%83%90%E3%83%BCZ>

=item * L<Acme::MomoiroClover::Members::Base>

=back

=head1 AUTHOR