Login   Register  
PHP Classes
elePHPant
Icontem

File: README

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of MARY Matthieu  >  Audio_Playlist  >  README  >  Download  
File: README
Role: Documentation
Content type: text/plain
Description: README file
Class: Audio_Playlist
Create play list files in multiple formats
Author: By
Last change:
Date: 11 years ago
Size: 7,143 bytes
 

Contents

Class file image Download
This software allow to create easily playlist of audiofiles
this software is under licence of GPL licence
please see the copy of this licence in attachement of this package




    ########
    Summary
    ########


1. Description --------------------------------------- l. 36
2. Files --------------------------------------------- l. 46
3. Warning ------------------------------------------- l. 78
4. Required configuration ---------------------------- l. 91
    4.1. for call from an executable script ---------- l. 97
    4.2. for call from an php script in http server -- l. 106
    4.3. note about max_execution_time settings ------ l. 114
    4.4. note about file permissions folders --------- l. 121
5. Installation -------------------------------------- l. 124
6. Usage
    6.1. in php script file -------------------------- l. 152
    6.2. from executable script file ----------------- l. 162
7. Annexes
    7.1. Changelog ----------------------------------- l. 172
    7.2. Known bugs ---------------------------------- l. 178
    7.3. Future changes ------------------------------ l. 185
    7.4. Credits ------------------------------------- l. 191





        ###########
    1.  Description
        ###########


These package allow you to create playlist in m3u, b4s or pls format after reading path
on your system
you can found latest version of this package at the following url http://www.phpclasses.org/browse.html/package/1228.html
for bugs, please contact me at marym@ifrance-no_spam.com

        #####
    2.  Files
        #####


The software is initially distributed as a ZIP or TAR/GZ archive.
This archive contains at least following files:

+- class_playlist.php          ( main script )
+- class_arrays.php            ( another librairy script required )
+- class_specif.php            ( another librairy script required )
+- class_dir.php               ( another librairy script required )
+- class_Audiofile.php	       ( another librairy script required )
+- class_audiofile_data.php    ( another librairy script required )
+- class_xmlparser.php         ( another librairy script required )
+- template.inc                ( template motor, based on PHPlib )
+- README                      ( this file )
+- LICENCE                     ( a copy of the GNU GPL licence )
+- CHANGELOG                   ( update list )
+- playlistb4s.tpl	       ( template file for building b4s playlist )
+- playlistm3u.tpl	       ( template file for building m3u playlist )
+- playlistpls.tpl	       ( template file for building pls playlist )
+- class_playlist_examples.php (a script to test a playlist building )
+- playlist.php                (a script to test browsing and building playlist )



Last version of class playlist package can be downloaded at
http://www.phpclasses.org/browse.html/package/1228.htm



        #######
    3.  Warning
        #######


This software is still unstable.
This means that it's not certified with no bug, and that it may still have
some problems undiscovered.

You then use AutoPhpDoc at your own risks, and it's advised to save you files
before applying AutoPhpDoc on it, to avoid any irreversible troubles...


        ######################
    4.  Required configuration
        ######################


- PHP (version 4.3.0 or above recommended).

         1. for call from an executable script (.bat or others)
         ------------------------------------------------------
         
You must have a version of PHP, usable in command line if you wants to execute this script
from a executable file
If PHP is installed on your system, you may have this version in directory "cli" of
the installation directory of PHP, or as an executable name "php-cli" in the installation
directory of PHP.

         2. for call from an php script in http server
         ---------------------------------------------
         
if you wants to call playlist builder from php script file in http server, you need only php
to be install on your system, but not required the command line option.
BEWARE: it's important to know that the informations you can give from path folders in errors
        or in log file can be security holes in http server production

         3. note about max_execution_time settings
         -----------------------------------------
- note about script duration: browsing an amount of 300 folders and building
 the playlist for theses folders take an amount of 20s.
 make sure that your max_execution_time settings in your php.ini allow you browse a large amount
 of folders if you wants that ;)

         4. note about file permissions folders
         --------------------------------------

        ############
    5.  Installation
        ############

Installation is equal in Windows or Linux OS
no test have been done on Mac, but it's probably same thing

to install copy 
	- class_playlist.php
	- class_dir.php
	- class_specif.php
	- class_audiofile.php
	- class_audiofile_data.php
	- class_arrays.php
	- class_xmlparser.php
	- template.inc
 into the include path of your server; if you don't know where is your include path,
 see the include path section in file php.ini or see the phpinfo of your server
copy the template files 
	- playlistm3u.tpl	     
	- playlistb4s.tpl
	- playlistpls.tpl
in the same directory of the test script you wants to test


        #####
    6.  Usage
        #####

	1. in php script file
	---------------------
* you only to call a require_once "class_playlist.php" to include playlist librairies into you script
* for building your playlist, just call the builder with your parameters
	$your_object = new playlist(yours parameters);
* if some errors occurs in the building playlist script, you can call the DATA_errors function of the
 playlist object to get the errors happened
* a log array contains each event of the script file


	2. from executable script file
	------------------------------
* you can wants call a .bat or an executable script for example to build automatically playlist
* just build a php script file which receive the data to build the playlist


        #######
    7.  Annexes
        #######


        7.1. Changelog
        --------------

Changelog contains update of the class.

        7.2. Knwon bugs
        ---------------

There is no known bugs in current version.
WARNING! this program is still in development and it there can be some unseen bugs.
if you think that you have found a bug, please contact me at <marym@ifrance.com>

        7.3. Future changes
        -------------------

Allowing during browsing file to update the ID3Tags with data parameters pass in arguments
increase perf of the building playlist script

        7.4. Credits
        ------------

Author: "Matthieu MARY" <marym@ifrance-no_spam.com>
Thanks to Michael Kamleitner allowing me to extends his work in the class audiofile
you can see his package at http://www.phpclasses.org/browse.html/package/482.html