Class: MP3_Playlist_Common

Source Location: /MP3_Playlist-0.5.2/MP3/Playlist/Common.php

Class Overview

Abstract class of MP3_Playlist drivers class.

Author(s):

Firman Wandayandi <firman at php.net>
David Costa <gurugeek at php.net>
Ashley Hewson <morbidness at gmail.com>

Version:

Release: 0.5.2

Copyright:

2004-2005 David Costa

Variables

Methods

Child classes:

MP3_Playlist_XML: Class MP3_Playlist_XML, generate the XML document for playlist.

MP3_Playlist_SQLite: Class MP3_Playlist_SMILL for generate and stores an sqlite based playlist.

MP3_Playlist_M3U: Class MP3_Playlist_M3U, generates the M3U playlist format.

MP3_Playlist_SMIL: Class MP3_Playlist_SMILL, generates the SMIL (SMIL Multimedia Persentation) playlist.

MP3_Playlist_XHTML: Class MP3_Playlist_XHTML, generates the XHTML page for playlist.

MP3_Playlist_RSS: Class MP3_Playlist_RSS, generates the playlist RSS feed.

Inherited Variables

Inherited Methods

Class Details

[line 48]
Abstract class of MP3_Playlist drivers class.

Author: Firman Wandayandi <firman@php.net>
Author: David Costa <gurugeek@php.net>
Author: Ashley Hewson <morbidness@gmail.com>
Version: Release: 0.5.2
Copyright: 2004-2005 David Costa
Link: http://pear.php.net/package/MP3_Playlist
Abstract:
License: The PHP License, version 3.0

[ Top ]

Class Variables

$debug = false

[line 56]

Debug flag.

Access: protected

Type:

bool

[ Top ]

$fileExtension = ''

[line 74]

File extension (without dot).

Access: protected

Type:

string

[ Top ]

$isRequiredMerged = false

[line 111]

Whether is required to merge list or not to generate the playlist.

Access: protected

Type:

bool

[ Top ]

$isSaveable = true

[line 86]

Whether the result is saveable or not.

Access: protected

Type:

bool

[ Top ]

$isSendable = true

[line 92]

Whether the result is sendable or not.

Access: protected

Type:

bool

[ Top ]

$isShuffle = false

[line 98]

Whether to create shuffle list or not.

Access: protected

Type:

bool

[ Top ]

$isViewable = true

[line 80]

Whether the result is viewable by browser or not.

Access: protected

Type:

bool

[ Top ]

$list = array()

[line 104]

List of song files.

Access: protected

Type:

mixed

[ Top ]

$merged = array()

[line 118]

List of files including append directory, location and ID3 tags for XML

and other manipulation

Access: protected

Type:

array

[ Top ]

$mimeType = ''

[line 68]

Mime type of output.

Access: protected

Type:

string

[ Top ]

$result = ''

[line 62]

The playlist result just made.

Access: protected

Type:

string

[ Top ]

Method Detail

__construct (Constructor) [line 133]

MP3_Playlist_Common __construct(
MP3_Playlist
$playlist, [bool
$shuffle = false], [bool
$debug = false])

Constructor

See: MP3_Playlist::getList()
See: MP3_Playlist::getMerged()
Access: public

Parameters:

object	`$playlist`	—	An instance of MP3_Playlist object.
bool	`$shuffle`	—	Whether to shuffle the playlist or not.
bool	`$debug`	—	Whether to show debug message or not.

[ Top ]

make [line 173]

void make(
[array
$params = array()])

Generates the playlist.

Access: public

Overridden in child classes as:

MP3_Playlist_XML::make(): Generates a valid XML with the playlist values.

MP3_Playlist_SQLite::make(): Generate and stores an sqlite based playlist

MP3_Playlist_M3U::make(): Generates the M3U playlist format.

MP3_Playlist_SMIL::make(): Generates the SMIL (SMIL Multimedia Persentation) playlist.

MP3_Playlist_XHTML::make(): Generate a valid XHTML playlist with link to the given URL defined on parsing

MP3_Playlist_RSS::make(): Generate a valid RSS feed from a playlist

Parameters:

array $params — Make parameters.

[ Top ]

save [line 190]

bool save(
string
$dir, string
$filename)

Save the generates playlist into file.

Return: TRUE
Throws: PEAR_Exception
Access: public

Parameters:

string	`$dir`	—	Directory
string	`$filename`	—	Filename

[ Top ]

send [line 228]

bool send(
string
$filename)

Send the generated playlist to browser direclty.

Return: TRUE
Throws: PEAR_Exception
Access: public

Parameters:

string $filename — Filename, if the format not viewable by browser send method will be switch into download mode.

[ Top ]

show [line 257]

string show(
)

Show the generated playlist result.

Access: public

[ Top ]