lib/Audio/MPD/Item.pm

   1 #
   2 # This program is free software; you can redistribute it and/or modify
   3 # it under the terms of the GNU General Public License as published by
   4 # the Free Software Foundation; either version 2 of the License, or
   5 # (at your option) any later version.
   6 #
   7 # This program is distributed in the hope that it will be useful,
   8 # but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10 # GNU General Public License for more details.
  11 #
  12 # You should have received a copy of the GNU General Public License
  13 # along with this program; if not, write to the Free Software
  14 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  15 #
  16 #
  17
  18 package Audio::MPD::Item;
  19
  20 use strict;
  21 use warnings;
  22 use Carp;
  23 use Audio::MPD::Item::Directory;
  24 use Audio::MPD::Item::Song;
  25
  26
  27 #
  28 # constructor.
  29 #
  30 sub new {
  31     my ($pkg, %params) = @_;
  32     croak "new is a class method - can't call it on a ref\n" if ref $pkg;
  33
  34     # transform keys in lowercase.
  35     my %lowcase;
  36     @lowcase{ map { lc } keys %params } = values %params;
  37
  38     my $item = exists $params{file} ?
  39         Audio::MPD::Item::Song->new(\%lowcase) :
  40         Audio::MPD::Item::Directory->new(\%lowcase);
  41     return $item;
  42 }
  43
  44 1;
  45
  46 __END__
  47
  48
  49 =head1 NAME
  50
  51 Audio::MPD::Item - a generic collection item
  52
  53
  54 =head1 SYNOPSIS
  55
  56     my $item = Audio::MPD::Item->new( %params );
  57
  58
  59 =head1 DESCRIPTION
  60
  61 C<Audio::MPD::Item> is a virtual class representing a generic item of mpd's
  62 collection. It can be either a song or a directory. Depending on the params
  63 given to C<new>, it will create and return an C<Audio::MPD::Item::Song> or an
  64 C<Audio::MPD::Item::Directory> object. Currently, the discrimination is done
  65 on the existence of the C<file> key of C<%params>.
  66
  67
  68 =head1 PUBLIC METHODS
  69
  70 Note that the only sub worth it in this class is the constructor:
  71
  72 =over 4
  73
  74 =item new( key => val [, key => val [, ...] ] )
  75
  76 Create and return either an C<Audio::MPD::Item::Song> or an
  77 C<Audio::MPD::Item::Directory> object.
  78
  79 =back
  80
  81
  82 =head1 SEE ALSO
  83
  84 You can find more information on the mpd project on its homepage at
  85 L<http://www.musicpd.org>, or its wiki L<http://mpd.wikia.com>.
  86
  87 Regarding this Perl module, you can report bugs on CPAN via
  88 L<http://rt.cpan.org/Public/Bug/Report.html?Queue=Audio-MPD>.
  89
  90 Audio::MPD development takes place on <audio-mpd@googlegroups.com>: feel free
  91 to join us. (use L<http://groups.google.com/group/audio-mpd> to sign in). Our
  92 subversion repository is located at L<https://svn.musicpd.org>.
  93
  94
  95 =head1 AUTHORS
  96
  97 Jerome Quelin <jquelin@cpan.org>
  98
  99
 100 =head1 COPYRIGHT AND LICENSE
 101
 102 Copyright (c) 2007 Jerome Quelin <jquelin@cpan.org>
 103
 104
 105 This program is free software; you can redistribute it and/or modify
 106 it under the terms of the GNU General Public License as published by
 107 the Free Software Foundation; either version 2 of the License, or
 108 (at your option) any later version.
 109
 110 This program is distributed in the hope that it will be useful,
 111 but WITHOUT ANY WARRANTY; without even the implied warranty of
 112 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 113 GNU General Public License for more details.
 114
 115 =cut