summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormomo-i <webmaster@momo-i.org>2011-02-02 13:35:26 +0900
committermomo-i <webmaster@momo-i.org>2011-02-02 13:35:26 +0900
commitbc7344c9f5d6810b8330474a69687f1c3fae961e (patch)
tree9b01425356fd4bf04d613cc1925fa69275b564e9
parent4bd8bd822bc6cc1c13066709cd5c25a4e2fa8968 (diff)
downloadampache-bc7344c9f5d6810b8330474a69687f1c3fae961e.tar.gz
ampache-bc7344c9f5d6810b8330474a69687f1c3fae961e.tar.bz2
ampache-bc7344c9f5d6810b8330474a69687f1c3fae961e.zip
test for phpdoc
-rw-r--r--lib/class/access.class.php82
-rw-r--r--lib/class/ajax.class.php57
-rw-r--r--lib/class/album.class.php59
-rw-r--r--lib/class/ampachemail.class.php66
-rw-r--r--lib/class/ampacherss.class.php60
-rw-r--r--lib/class/api.class.php56
-rw-r--r--lib/class/art.class.php60
-rw-r--r--lib/class/artist.class.php59
-rw-r--r--lib/class/browse.class.php58
-rw-r--r--lib/class/catalog.class.php62
-rw-r--r--lib/class/config.class.php60
-rw-r--r--lib/class/core.class.php60
-rw-r--r--lib/class/database_object.abstract.php57
-rw-r--r--lib/class/dba.class.php61
-rw-r--r--lib/class/democratic.class.php60
-rw-r--r--lib/class/error.class.php60
16 files changed, 683 insertions, 294 deletions
diff --git a/lib/class/access.class.php b/lib/class/access.class.php
index 692db882..95fc589b 100644
--- a/lib/class/access.class.php
+++ b/lib/class/access.class.php
@@ -1,15 +1,12 @@
<?php
/* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */
/*
- *
- *
- *
* Access Class
*
* PHP version 5
*
- * LICENSE:
- * Copyright (c) Ampache.org All Rights Reserved
+ * 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
@@ -24,13 +21,13 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
- * @category access
- * @package Access
- * @author Karl Vollmer <>
- * @copyright 2011 Ampache.org
+ * @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
- * @link
+ * @version PHP 5.2
+ * @link http://www.ampache.org/
* @since File available since Release 1.0
*/
@@ -40,14 +37,14 @@
* This class handles the access list mojo for Ampache, it is ment to restrict
* access based on IP and maybe something else in the future
*
- * @category
- * @package
- * @author
- * @copyright 2011 Ampache.org
+ * @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
- * @see
+ * @link http://www.ampache.org/
+ * @see xxx
* @since Class available since Release 1.0
*/
class Access {
@@ -65,15 +62,40 @@ class Access {
*
*/
public $name;
+
+ /**
+ *
+ */
public $start;
+
+ /**
+ *
+ */
public $end;
+
+ /**
+ *
+ */
public $level;
+
+ /**
+ *
+ */
public $user;
+
+ /**
+ *
+ */
public $type;
+
+ /**
+ *
+ */
public $enabled;
/**
* constructor
+ *
* Takes an ID of the access_id dealie :)
*
* @param integer $access_id ID of the access_id
@@ -97,6 +119,7 @@ class Access {
/**
* _get_info
+ *
* get's the vars for $this out of the database
* Taken from the object
*
@@ -116,6 +139,7 @@ class Access {
/**
* format
+ *
* This makes the Access object a nice fuzzy human readable object, spiffy ain't it.
*
* @return void
@@ -133,6 +157,7 @@ class Access {
/**
* update
+ *
* This function takes a named array as a datasource and updates the current access list entry
*
* @param array $data xxx
@@ -178,8 +203,12 @@ class Access {
/**
* create
+ *
* This takes a key'd array of data and trys to insert it as a
* new ACL entry
+ *
+ * @param array $data xxx
+ * @return boolean
*/
public static function create($data) {
@@ -227,7 +256,11 @@ class Access {
/**
* exists
+ *
* this sees if the ACL that we've specified already exists, prevent duplicates. This ignores the name
+ *
+ * @param array $data xxx
+ * @return boolean
*/
public static function exists($data) {
@@ -250,7 +283,11 @@ class Access {
/**
* delete
+ *
* deletes the specified access_list entry
+ *
+ * @param integer $access_id xxx
+ * @return void
*/
public static function delete($access_id) {
@@ -261,8 +298,12 @@ class Access {
/**
* check_function
+ *
* This checks if a specific functionality is enabled
* it takes a type only
+ *
+ * @param string $type check type xxx
+ * @return mixed boolean or config
*/
public static function check_function($type) {
@@ -288,9 +329,16 @@ class Access {
/**
* check_network
+ *
* This takes a type, ip, user, level and key
* and then returns true or false if they have access to this
* the IP is passed as a dotted quad
+ *
+ * @param string $type Check type.
+ * @param string $user User name.
+ * @param integer $level Access level.
+ * @param string $ip IP Address.
+ * @return boolean
*/
public static function check_network($type,$user,$level,$ip='') {
diff --git a/lib/class/ajax.class.php b/lib/class/ajax.class.php
index a1059e2e..e361548c 100644
--- a/lib/class/ajax.class.php
+++ b/lib/class/ajax.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.
-
-*/
+ * Ajax 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 Ajax
+ * @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
+ */
/**
* Ajax class
+ *
* This class is specifically for setting up/printing out ajax related
* elements onto a page. It takes care of the observing and all that
* raz-a-ma-taz.
+ *
+ * @category Ajax
+ * @package Ampache
+ * @author Karl Vollmer <vollmer@ampache.org>
+ * @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 19774096..491c3aa0 100644
--- a/lib/class/album.class.php
+++ b/lib/class/album.class.php
@@ -1,29 +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 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.
-
-*/
+ * 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 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 Album
+ * @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
+ */
/**
* Album Class
+ *
* This is the class responsible for handling the Album object
* it is related to the album table in the database.
+ *
+ * @category Album
+ * @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 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 f5a1455a..dcc4165d 100644
--- a/lib/class/ampachemail.class.php
+++ b/lib/class/ampachemail.class.php
@@ -1,25 +1,51 @@
<?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.
-
-*/
-
+ * AmpacheMail 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 AmpacheMail
+ * @package Ampache
+ * @authro 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
+ */
+
+/**
+ * AmpacheMail Class
+ *
+ * This class handles the Mail
+ *
+ * @category AmpacheMail
+ * @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 xxx
+ * @since Class available since Release 1.0
+ */
class AmpacheMail {
// The message, recipient and from
@@ -32,6 +58,7 @@ class AmpacheMail {
/**
* Constructor
+ *
* This does nothing. Much like goggles.
*/
public function __construct() {
@@ -42,6 +69,7 @@ class AmpacheMail {
/**
* set_default_sender
+ *
* Does the config magic to figure out the "system" email sender and
* sets it as the sender.
*/
diff --git a/lib/class/ampacherss.class.php b/lib/class/ampacherss.class.php
index 897601bc..e2a7e52e 100644
--- a/lib/class/ampacherss.class.php
+++ b/lib/class/ampacherss.class.php
@@ -1,30 +1,52 @@
<?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.
-
-*/
+ * AmpacheRSS 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 AmpacheRSS
+ * @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
+ */
/**
* AmpacheRSS Class
+ *
* This is not currently used by the stable version of ampache, really here for future use and
* due to the fact it was back-ported from /trunk
+ *
+ * @category AmpacheRSS
+ * @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 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 821ad6f6..7c2b02cf 100644
--- a/lib/class/api.class.php
+++ b/lib/class/api.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 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.
-
+ * Api 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 Api
+ * @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
*/
/**
* API Class
+ *
* This handles functions relating to the API written for ampache, initially
* this is very focused on providing functionality for Amarok so it can
* integrate with Ampache.
+ *
+ * @category Api
+ * @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 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 d7066a11..bf93e968 100644
--- a/lib/class/art.class.php
+++ b/lib/class/art.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 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.
-
-*/
+ * Art 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 Art
+ * @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
+ */
/**
- * Art
+ * Art Class
+ *
* This class handles the images / artwork in ampache
* This was initially in the album class, but was pulled out
* to be more general, and apply to albums, artists, movies etc
+ *
+ * @category Art
+ * @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 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 02a7c7b7..9bf4c65d 100644
--- a/lib/class/artist.class.php
+++ b/lib/class/artist.class.php
@@ -1,27 +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.
-
-*/
+ * Artist 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 Artist
+ * @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
+ */
/**
* Artist Class
+ *
+ * Description here...
+ *
+ * @category Artist
+ * @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 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 8e6eba11..fbc00b1a 100644
--- a/lib/class/browse.class.php
+++ b/lib/class/browse.class.php
@@ -1,31 +1,53 @@
<?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.
-
-*/
+ * Browse 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 Browse
+ * @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
+ */
/**
* Browse Class
+ *
* This handles all of the sql/filtering
* on the data before it's thrown out to the templates
* it also handles pulling back the object_ids and then
* calling the correct template for the object we are displaying
+ *
+ * @category Browse
+ * @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 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 4c4e0768..9de3561f 100644
--- a/lib/class/catalog.class.php
+++ b/lib/class/catalog.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.
-*/
+ * Catalog 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 Catalog
+ * @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
+ */
/**
* Catalog Class
- * This class handles all actual work in regards to the catalog, it contains functions for creating/listing/updated the catalogs.
- * @package Catalog
- * @catagory Class
+ *
+ * This class handles all actual work in regards to the catalog,
+ * it contains functions for creating/listing/updated the catalogs.
+ *
+ * @catagory Catalog
+ * @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 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 d7be63c6..46576c5c 100644
--- a/lib/class/config.class.php
+++ b/lib/class/config.class.php
@@ -1,26 +1,40 @@
<?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.
-*/
+ * Config 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 Config
+ * @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
+ */
-/* config class
+/**
+ * Config Class
+ *
* used to store static arrays of
* config values, can read from ini files
*
@@ -28,6 +42,16 @@
* creating a 'Config' object will allow for local
* config overides and/or local configs (for like dba)
* The class should be a static var in the other classes
+ *
+ * @category Config
+ * @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 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 683107d3..e3d4ae4b 100644
--- a/lib/class/core.class.php
+++ b/lib/class/core.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.
-
-*/
+ * Core 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 Core
+ * @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
+ */
/**
- * Core
+ * Core Class
+ *
* This is really just a namespace class, it's full of static functions
* would be replaced by a namespace library once that exists in php
+ *
+ * @category Core
+ * @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 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 1bb368d6..af06e0d8 100644
--- a/lib/class/database_object.abstract.php
+++ b/lib/class/database_object.abstract.php
@@ -1,29 +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 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.
-*/
+ * database_object 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 database_object
+ * @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
+ */
/**
* database_object
+ *
* This is a general object that is extended by all of the basic
* database based objects in ampache. It attempts to do some standard
* caching for all of the objects to cut down on the database calls
+ *
+ * @category database_object
+ * @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 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 4072f4b8..771e76e0 100644
--- a/lib/class/dba.class.php
+++ b/lib/class/dba.class.php
@@ -1,35 +1,58 @@
<?php
/* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */
/*
+ * Dba 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 Dba
+ * @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.
-
-*/
/* Make sure they aren't directly accessing it */
-if (INIT_LOADED != '1') { exit; }
+if (!defined('INIT_LOADED') || INIT_LOADED != '1') { exit; }
/**
- * Dba
+ * Dba Class
+ *
* This is the database abstraction class
* It duplicates the functionality of mysql_???
* with a few exceptions, the row and assoc will always
* return an array, simplifying checking on the far end
* it will also auto-connect as needed, and has a default
* database simplifying queries in most cases.
+ *
+ * @category Dba
+ * @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 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 62218bd2..107210c2 100644
--- a/lib/class/democratic.class.php
+++ b/lib/class/democratic.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.
-
-*/
+ * Democratic 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 Democratic
+ * @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
+ */
/**
- * Democratic
+ * Democratic Class
+ *
* This class handles democratic play, which is a fancy
* name for voting based playback. This extends the tmpplaylist
+ *
+ * @category Democratic
+ * @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 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 31a0eb10..0171245e 100644
--- a/lib/class/error.class.php
+++ b/lib/class/error.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 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
- MERCHANT ABILITY 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.
-
-*/
+ * Error 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
+ * MERCHANT ABILITY 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 Error
+ * @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
+ */
/**
* Error class
+ *
* This is the baic error class, its better now that we can use php5
* hello static functions and variables
+ *
+ * @category Error
+ * @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 xxx
+ * @since Class available since Release 1.0
*/
class Error {