diff options
| author | momo-i <webmaster@momo-i.org> | 2011-02-02 16:48:45 +0900 |
|---|---|---|
| committer | momo-i <webmaster@momo-i.org> | 2011-02-02 16:48:45 +0900 |
| commit | add54bc23069222b5f02f60256f13e4791fb0b33 (patch) | |
| tree | d6a4dc282796f673f004942fb846d55cf421c0ce /lib/class | |
| parent | bc7344c9f5d6810b8330474a69687f1c3fae961e (diff) | |
| download | ampache-add54bc23069222b5f02f60256f13e4791fb0b33.tar.gz ampache-add54bc23069222b5f02f60256f13e4791fb0b33.tar.bz2 ampache-add54bc23069222b5f02f60256f13e4791fb0b33.zip | |
test header for phpdoc. now using only classes and libraries.
Diffstat (limited to 'lib/class')
42 files changed, 1058 insertions, 502 deletions
diff --git a/lib/class/access.class.php b/lib/class/access.class.php index 95fc589b..423c096c 100644 --- a/lib/class/access.class.php +++ b/lib/class/access.class.php @@ -44,7 +44,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Access { diff --git a/lib/class/ajax.class.php b/lib/class/ajax.class.php index e361548c..5601f0ea 100644 --- a/lib/class/ajax.class.php +++ b/lib/class/ajax.class.php @@ -44,7 +44,6 @@ * @copyright 2001 - 2011 Ampache.org * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Ajax { diff --git a/lib/class/album.class.php b/lib/class/album.class.php index 491c3aa0..461700da 100644 --- a/lib/class/album.class.php +++ b/lib/class/album.class.php @@ -45,7 +45,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Album extends database_object { diff --git a/lib/class/ampachemail.class.php b/lib/class/ampachemail.class.php index dcc4165d..e2d117d6 100644 --- a/lib/class/ampachemail.class.php +++ b/lib/class/ampachemail.class.php @@ -43,7 +43,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class AmpacheMail { diff --git a/lib/class/ampacherss.class.php b/lib/class/ampacherss.class.php index e2a7e52e..be2c3371 100644 --- a/lib/class/ampacherss.class.php +++ b/lib/class/ampacherss.class.php @@ -45,7 +45,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class AmpacheRSS { diff --git a/lib/class/api.class.php b/lib/class/api.class.php index 7c2b02cf..f6b70bc9 100644 --- a/lib/class/api.class.php +++ b/lib/class/api.class.php @@ -45,7 +45,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Api { diff --git a/lib/class/art.class.php b/lib/class/art.class.php index bf93e968..355e7858 100644 --- a/lib/class/art.class.php +++ b/lib/class/art.class.php @@ -45,7 +45,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Art extends database_object { diff --git a/lib/class/artist.class.php b/lib/class/artist.class.php index 9bf4c65d..fe6f57a1 100644 --- a/lib/class/artist.class.php +++ b/lib/class/artist.class.php @@ -43,7 +43,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Artist extends database_object { diff --git a/lib/class/browse.class.php b/lib/class/browse.class.php index fbc00b1a..055b2743 100644 --- a/lib/class/browse.class.php +++ b/lib/class/browse.class.php @@ -46,7 +46,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Browse extends Query { diff --git a/lib/class/catalog.class.php b/lib/class/catalog.class.php index 9de3561f..53348361 100644 --- a/lib/class/catalog.class.php +++ b/lib/class/catalog.class.php @@ -44,7 +44,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Catalog extends database_object { diff --git a/lib/class/config.class.php b/lib/class/config.class.php index 46576c5c..1789e024 100644 --- a/lib/class/config.class.php +++ b/lib/class/config.class.php @@ -50,7 +50,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Config { diff --git a/lib/class/core.class.php b/lib/class/core.class.php index e3d4ae4b..3d263f77 100644 --- a/lib/class/core.class.php +++ b/lib/class/core.class.php @@ -44,7 +44,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Core { diff --git a/lib/class/database_object.abstract.php b/lib/class/database_object.abstract.php index af06e0d8..34e9a374 100644 --- a/lib/class/database_object.abstract.php +++ b/lib/class/database_object.abstract.php @@ -45,7 +45,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ abstract class database_object { diff --git a/lib/class/dba.class.php b/lib/class/dba.class.php index 771e76e0..3bcc1e5c 100644 --- a/lib/class/dba.class.php +++ b/lib/class/dba.class.php @@ -51,7 +51,6 @@ if (!defined('INIT_LOADED') || INIT_LOADED != '1') { exit; } * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Dba { diff --git a/lib/class/democratic.class.php b/lib/class/democratic.class.php index 107210c2..4c443a6f 100644 --- a/lib/class/democratic.class.php +++ b/lib/class/democratic.class.php @@ -44,7 +44,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Democratic extends tmpPlaylist { diff --git a/lib/class/error.class.php b/lib/class/error.class.php index 0171245e..5ec51d24 100644 --- a/lib/class/error.class.php +++ b/lib/class/error.class.php @@ -19,8 +19,7 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, - * USA. + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * * @category Error * @package Ampache @@ -45,7 +44,6 @@ * @license http://opensource.org/licenses/gpl-2.0 GPLv2 * @version Release: * @link http://www.ampache.org/ - * @see xxx * @since Class available since Release 1.0 */ class Error { diff --git a/lib/class/flag.class.php b/lib/class/flag.class.php index 3394019d..0267b0e0 100644 --- a/lib/class/flag.class.php +++ b/lib/class/flag.class.php @@ -1,29 +1,50 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright Ampache.org - All Rights Reserved - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; version 2 - of the License. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Flag Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; version 2 + * of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Flag + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Flag Class + * * This handles flagging of songs, albums and artists + * + * @category Flag + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class Flag extends database_object { diff --git a/lib/class/localplay.abstract.php b/lib/class/localplay.abstract.php index c544c14c..d755045d 100644 --- a/lib/class/localplay.abstract.php +++ b/lib/class/localplay.abstract.php @@ -1,27 +1,49 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All Rights Reserved - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * localplay_controller Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category localplay_controller + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /* + * localplay_controller Class + * * This is the abstract class for any localplay controller + * + * @category localplay_controller + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ abstract class localplay_controller { diff --git a/lib/class/localplay.class.php b/lib/class/localplay.class.php index 26b39aba..b70d3412 100644 --- a/lib/class/localplay.class.php +++ b/lib/class/localplay.class.php @@ -1,25 +1,50 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ - + * Localplay Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Localplay + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ + +/** + * Localplay Class + * + * Description here... + * + * @category Localplay + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 + */ class Localplay { /* Base Variables */ diff --git a/lib/class/media.interface.php b/lib/class/media.interface.php index 60d01967..0c755a7f 100644 --- a/lib/class/media.interface.php +++ b/lib/class/media.interface.php @@ -1,29 +1,55 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -*/ + * media Interface + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category media + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** - * media interface + * media Interface + * * This defines how the media file classes should * work, this lists all required functions and the expected * input + * + * @category media + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @see Video + * @see Radio + * @see Random + * @see Song + * @since Class available since Release 1.0 */ interface media { diff --git a/lib/class/playlist.class.php b/lib/class/playlist.class.php index 928ff949..e1aa603b 100644 --- a/lib/class/playlist.class.php +++ b/lib/class/playlist.class.php @@ -1,28 +1,50 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* + * Playlist Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; version 2 + * of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Playlist + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; version 2 - of the License. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ /** * Playlist Class + * * This class handles playlists in ampache. it references the playlist* tables + * + * @category Playlist + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class Playlist extends database_object { diff --git a/lib/class/plugin.class.php b/lib/class/plugin.class.php index 57157723..cb74a6ec 100644 --- a/lib/class/plugin.class.php +++ b/lib/class/plugin.class.php @@ -1,25 +1,50 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ - + * Plugin Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Plugin + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ + +/** + * Plugin Class + * + * Description here... + * + * @category Access + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 + */ class Plugin { /* Base Variables */ diff --git a/lib/class/preference.class.php b/lib/class/preference.class.php index 7eb78f65..ec226bf5 100644 --- a/lib/class/preference.class.php +++ b/lib/class/preference.class.php @@ -1,30 +1,52 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All Rights Reserved - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; version 2 - of the License. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Preference Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; version 2 + * of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Preference + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** - * preference Class + * Preference Class + * * This handles all of the preference stuff for ampache it replaces * /lib/preference.lib.php + * + * @category Preference + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @see /lib/preference.lib.php + * @since Class available since Release 1.0 */ class Preference { diff --git a/lib/class/query.class.php b/lib/class/query.class.php index 3a9476f9..2a3d43a3 100644 --- a/lib/class/query.class.php +++ b/lib/class/query.class.php @@ -1,31 +1,51 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Query Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Query + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Query Class + * * This handles all of the sql/filtering for the ampache database * this was seperated out from browse to accomodate Dynamic Playlists + * + * @category Query + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ - class Query { public $id; diff --git a/lib/class/radio.class.php b/lib/class/radio.class.php index 7112ea5c..71719080 100644 --- a/lib/class/radio.class.php +++ b/lib/class/radio.class.php @@ -1,30 +1,51 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright Ampache.org - All Rights Reserved - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; version 2 - of the License. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Radio Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; version 2 + * of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Radio + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Radio Class + * * This handles the internet radio stuff, that is inserted into live_stream * this can include podcasts or what-have-you + * + * @category Radio + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class Radio extends database_object implements media { diff --git a/lib/class/random.class.php b/lib/class/random.class.php index 582d00ac..36177bc7 100644 --- a/lib/class/random.class.php +++ b/lib/class/random.class.php @@ -1,38 +1,58 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright Ampache.org - All Rights Reserved - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; version 2 - of the License. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Random Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; version 2 + * of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Random + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Random Class + * * All of the 'random' type events, elements, voodoo done by ampache is done * by this class, there isn't a table for this class so most of it's functions * are static + * + * @category Random + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class Random implements media { public $type; public $id; - /** * Constructor * nothing to see here, move along diff --git a/lib/class/rating.class.php b/lib/class/rating.class.php index e3a4c5e9..7d220772 100644 --- a/lib/class/rating.class.php +++ b/lib/class/rating.class.php @@ -1,28 +1,49 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Rating Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Rating + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Rating class + * * This tracks ratings for songs, albums and artists. + * + * @category Rating + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class Rating extends database_object { diff --git a/lib/class/recommendation.class.php b/lib/class/recommendation.class.php index 0852780d..0659fd93 100644 --- a/lib/class/recommendation.class.php +++ b/lib/class/recommendation.class.php @@ -1,27 +1,49 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Recommendation Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Recommendation + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Recommendation Class + * + * Description here... + * + * @category Recommendation + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class Recommendation { diff --git a/lib/class/registration.class.php b/lib/class/registration.class.php index 832718a9..f43d966c 100644 --- a/lib/class/registration.class.php +++ b/lib/class/registration.class.php @@ -1,28 +1,50 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) 2001 - 2007 Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -*/ + * Registration Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Registration + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** - * Registration + * Registration Class + * * This class handles all the doodlys for the registration * stuff in ampache + * + * @category Registration + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class Registration { diff --git a/lib/class/scrobbler.class.php b/lib/class/scrobbler.class.php index 537b1490..506391c9 100644 --- a/lib/class/scrobbler.class.php +++ b/lib/class/scrobbler.class.php @@ -1,25 +1,50 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ - + * scrobbler Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category scrobbler + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ + +/** + * scrobbler Class + * + * Description here... + * + * @category scrobbler + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 + */ class scrobbler { public $error_msg; diff --git a/lib/class/shoutbox.class.php b/lib/class/shoutbox.class.php index 685d7d7b..7f36956d 100644 --- a/lib/class/shoutbox.class.php +++ b/lib/class/shoutbox.class.php @@ -1,25 +1,50 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ - + * shoutBox Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category shoutBox + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ + +/** + * shoutBox Class + * + * Description here... + * + * @category shoutBox + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 + */ class shoutBox { public $id; diff --git a/lib/class/song.class.php b/lib/class/song.class.php index b9f257a7..1a0a5958 100644 --- a/lib/class/song.class.php +++ b/lib/class/song.class.php @@ -1,25 +1,50 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ - + * Song Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Song + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ + +/** + * Song Class + * + * Description here... + * + * @category Song + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 + */ class Song extends database_object implements media { /* Variables from DB */ diff --git a/lib/class/stats.class.php b/lib/class/stats.class.php index 821d2320..10d14bd2 100644 --- a/lib/class/stats.class.php +++ b/lib/class/stats.class.php @@ -1,30 +1,51 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Stats Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Stats + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** - * Stats + * Stats Class + * * this class handles the object_count * Stuff, before this was done in the user class * but that's not good, all done through here. + * + * @category Stats + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class Stats { diff --git a/lib/class/stream.class.php b/lib/class/stream.class.php index a36e547e..4901d46e 100644 --- a/lib/class/stream.class.php +++ b/lib/class/stream.class.php @@ -1,24 +1,35 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Stream Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Stream + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Stream diff --git a/lib/class/tag.class.php b/lib/class/tag.class.php index 52c6f539..0bf2cda3 100644 --- a/lib/class/tag.class.php +++ b/lib/class/tag.class.php @@ -1,28 +1,49 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Tag Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Tag + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Tag Class + * * This class hnadles all of the tag relation operations + * + * @category Tag + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class Tag extends database_object { diff --git a/lib/class/tmpplaylist.class.php b/lib/class/tmpplaylist.class.php index 27e621c9..253788b2 100644 --- a/lib/class/tmpplaylist.class.php +++ b/lib/class/tmpplaylist.class.php @@ -1,30 +1,51 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * TmpPlaylist Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category TmpPlaylist + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * TempPlaylist Class + * * This class handles the temporary playlists in ampache, it handles the * tmp_playlist and tmp_playlist_data tables, and sneaks out at night to * visit user_vote from time to time + * + * @category TempPlaylist + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class tmpPlaylist extends database_object { diff --git a/lib/class/update.class.php b/lib/class/update.class.php index b7b5a5ec..faf236f3 100644 --- a/lib/class/update.class.php +++ b/lib/class/update.class.php @@ -1,28 +1,42 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -*/ + * Update Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Update + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * Update Class + * * this class handles updating from one version of * ampache to the next. Versions are a 6 digit number + * <pre> * 220000 * ^ * Major Revision @@ -30,9 +44,19 @@ * 220000 * ^ * Minor Revision + * </pre> * * The last 4 digits are a build number... * If Minor can't go over 9 Major can go as high as we want + * + * @category Update + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class Update { diff --git a/lib/class/user.class.php b/lib/class/user.class.php index 3432fc9a..fbf50ee0 100644 --- a/lib/class/user.class.php +++ b/lib/class/user.class.php @@ -1,29 +1,51 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -*/ + * User Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category User + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** * User Class + * * This class handles all of the user related functions includingn the creationg * and deletion of the user objects from the database by defualt you constrcut it * with a user_id from user.id + * + * @category User + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class User extends database_object { diff --git a/lib/class/vainfo.class.php b/lib/class/vainfo.class.php index 8bf717a5..0c6b0698 100644 --- a/lib/class/vainfo.class.php +++ b/lib/class/vainfo.class.php @@ -1,29 +1,50 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * vainfo Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category vainfo + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** - * vainfo + * vainfo Class + * * This class takes the information pulled from getID3 and returns it in a * Ampache friendly way. + * + * @category vainfo + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class vainfo { diff --git a/lib/class/vauth.class.php b/lib/class/vauth.class.php index 39a8a294..b7b8acb5 100644 --- a/lib/class/vauth.class.php +++ b/lib/class/vauth.class.php @@ -1,30 +1,52 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* + * vauth Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category vauth + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ - Copyright (c) Ampache.org - All Rights Reserved - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ /** - * Vauth + * vauth Class + * * This class handles all of the session related stuff in Ampache * it takes over for the vauth libs, and takes some stuff out of other * classes where it didn't belong -*/ + * + * @category vauth + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 + */ class vauth { /** diff --git a/lib/class/video.class.php b/lib/class/video.class.php index 1640c6b8..4ed6f3f0 100644 --- a/lib/class/video.class.php +++ b/lib/class/video.class.php @@ -1,25 +1,50 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright (c) Ampache.org - All rights reserved. - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License v2 - as published by the Free Software Foundation. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ - + * Video Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License v2 + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category Video + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ + +/** + * Video Class + * + * Description here... + * + * @category Video + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 + */ class Video extends database_object implements media { public $id; diff --git a/lib/class/xmldata.class.php b/lib/class/xmldata.class.php index 2ce5a8eb..b5d1475f 100644 --- a/lib/class/xmldata.class.php +++ b/lib/class/xmldata.class.php @@ -1,30 +1,51 @@ <?php /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* - - Copyright Ampache.org - All Rights Reserved - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; version 2 - of the License. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -*/ + * Access Class + * + * PHP version 5 + * + * LICENSE: GNU General Public License, version 2 (GPLv2) + * Copyright (c) 2001 - 2011 Ampache.org All Rights Reserved + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; version 2 + * of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * @category xmlData + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version PHP 5.2 + * @link http://www.ampache.org/ + * @since File available since Release 1.0 + */ /** - * xmlData + * xmlData Class + * * This class takes care of all of the xml document stuff in Ampache these * are all static calls + * + * @category xmlData + * @package Ampache + * @author Karl Vollmer <vollmer@ampache.org> + * @copyright 2001 - 2011 Ampache.org + * @license http://opensource.org/licenses/gpl-2.0 GPLv2 + * @version Release: + * @link http://www.ampache.org/ + * @since Class available since Release 1.0 */ class xmlData { |