Docs For Class Playlist

Class Playlist

Description

The Playlist object represents a playlist.

Playlists are identified usign a key, which is a normalized version of the playlist name. For example, the key for Purchased Music is purchased_music.

Located in /playlist.php (line 17)

Variable Summary

string $key

string $name

string $type

Method Summary

Playlist Playlist (the $key)

Song get_song (integer $track_id)

string name ()

array tracks ()

array track_ids ()

string type ()

Variables

string $key (line 22)

The primary key for the playlist.

string $name (line 29)

The name of the playlist. Use name() to make sure that the playlist has been initialized.

see: Playlist::name()

string $type (line 36)

The type of the playlist, e.g. 'shuffle', 'smart', 'playlist'.

see: Playlist::type()

Methods

Constructor Playlist (line 66)

Creates a playlist object.

return: the playlist

Playlist Playlist (the $key)

the $key: playlist key

get_song (line 175)

Returns a Song object for a song in the playlist.

see: Artist::get_song()
see: Song::get_song()

Song get_song (integer $track_id)

integer $track_id: the track id

name (line 102)

The name of the playlist.

return: the name

string name ()

tracks (line 146)

Returns an array of songs for the playlist.

Sends add_time_and_size() to each of the songs.

return: an array of Songs, indexed by track id

array tracks ()

track_ids (line 163)

Returns an array of track ids for the playlist.

return: an array of integers

array track_ids ()

type (line 112)

The type of the playlist, e.g. 'shuffle', 'smart', 'playlist'.

return: the type

string type ()

Documentation generated on Sun, 12 Feb 2006 19:27:55 +0100 by phpDocumentor 1.2.3