lib/POE/Component/Client/MPD/Item/Song.pm

   1 #
   2 # This file is part of POE::Component::Client::MPD.
   3 # Copyright (c) 2007 Jerome Quelin, all rights reserved.
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the same terms as Perl itself.
   7 #
   8 #
   9
  10 package POE::Component::Client::MPD::Item::Song;
  11
  12 use strict;
  13 use warnings;
  14
  15 use overload '""' => \&as_string;
  16 use Readonly;
  17
  18 use base qw[ Class::Accessor::Fast POE::Component::Client::MPD::Item ];
  19 __PACKAGE__->mk_accessors( qw[ album artist file id pos title track time ] );
  20
  21 #our ($VERSION) = '$Rev: 5645 $' =~ /(\d+)/;
  22
  23 Readonly my $SEP => ' = ';
  24
  25
  26 #
  27 # my $str = $song->as_string;
  28 #
  29 # Return a string representing $song. This string will be;
  30 #  - either "album = track = artist = title"
  31 #  - or     "artist = title"
  32 #  - or     "title"
  33 #  - or     "file"
  34 # (in this order), depending on the existing tags of the song. The last
  35 # possibility always exist of course, since it's a path.
  36 #
  37 sub as_string {
  38     my ($self) = @_;
  39
  40     return $self->file unless defined $self->title;
  41     my $str = $self->title;
  42     return $str unless defined $self->artist;
  43     $str = $self->artist . $SEP . $str;
  44     return $str unless defined $self->album && defined $self->track;
  45     return join $SEP,
  46         $self->album,
  47         $self->track,
  48         $str;
  49 }
  50
  51 1;
  52
  53 __END__
  54
  55 =head1 NAME
  56
  57 POE::Component::Client::MPD::Item::Song - a song object with some audio tags
  58
  59
  60 =head1 DESCRIPTION
  61
  62 C<POE::Component::Client::MPD::Item::Song> is more a placeholder for a
  63 hash ref with some pre-defined keys, namely some audio tags.
  64
  65
  66 =head1 PUBLIC METHODS
  67
  68 =head2 Accessors
  69
  70 The following methods are the accessors to their respective named fields:
  71 C<album()>, C<artist()>, C<file()>, C<id>, C<pos>, C<title()>, C<track()>,
  72 C<time()>. You can call them either with no arg to get the value, or with
  73 an arg to replace the current value.
  74
  75
  76 =head2 Methods
  77
  78
  79 =over 4
  80
  81 =item $song->as_string()
  82
  83 Return a string representing $song. This string will be:
  84
  85 =over 4
  86
  87 =item either "album = track = artist = title"
  88
  89 =item or "artist = title"
  90
  91 =item or "title"
  92
  93 =item or "file"
  94
  95 =back
  96
  97 (in this order), depending on the existing tags of the song. The last
  98 possibility always exist of course, since it's a path.
  99
 100 =back
 101
 102
 103 =head1 SEE ALSO
 104
 105 For all related information (bug reporting, mailing-list, pointers to
 106 MPD and POE, etc.), refer to C<POE::Component::Client::MPD>'s pod,
 107 section C<SEE ALSO>
 108
 109
 110 =head1 AUTHOR
 111
 112 Jerome Quelin, C<< <jquelin at cpan.org> >>
 113
 114
 115 =head1 COPYRIGHT & LICENSE
 116
 117 Copyright (c) 2007 Jerome Quelin, all rights reserved.
 118
 119 This program is free software; you can redistribute it and/or modify
 120 it under the same terms as Perl itself.
 121
 122 =cut