1
0
Fork 0
mirror of https://github.com/Yetangitu/ampache synced 2025-10-06 03:49:56 +02:00

little testing for phpdoc

This commit is contained in:
momo-i 2011-02-02 07:20:27 +09:00
parent 245400143d
commit 75d3532b15

View file

@ -1,33 +1,69 @@
<?php <?php
/* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */ /* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */
/* /*
*
*
*
* Access Class
*
* PHP version 5
*
* LICENSE:
* 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.
*
* @category access
* @package Access
* @author Karl Vollmer <>
* @copyright 2011 Ampache.org
* @license http://opensource.org/licenses/gpl-2.0 GPLv2
* @version
* @link
* @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.
*/
/** /**
* Access Class * Access Class
*
* This class handles the access list mojo for Ampache, it is ment to restrict * 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 * access based on IP and maybe something else in the future
*/ *
* @category
* @package
* @author
* @copyright 2011 Ampache.org
* @license http://opensource.org/licenses/gpl-2.0 GPLv2
* @version Release:
* @link
* @see
* @since Class available since Release 1.0
*/
class Access { class Access {
/* Variables from DB */ // Variables from DB
/**
* User ID
*
* @var integer
*/
public $id; public $id;
/**
*
*/
public $name; public $name;
public $start; public $start;
public $end; public $end;
@ -39,6 +75,9 @@ class Access {
/** /**
* constructor * constructor
* Takes an ID of the access_id dealie :) * Takes an ID of the access_id dealie :)
*
* @param integer $access_id ID of the access_id
* @return boolean
*/ */
public function __construct($access_id='') { public function __construct($access_id='') {
@ -60,6 +99,8 @@ class Access {
* _get_info * _get_info
* get's the vars for $this out of the database * get's the vars for $this out of the database
* Taken from the object * Taken from the object
*
* @return resource
*/ */
private function _get_info() { private function _get_info() {
@ -76,6 +117,8 @@ class Access {
/** /**
* format * format
* This makes the Access object a nice fuzzy human readable object, spiffy ain't it. * This makes the Access object a nice fuzzy human readable object, spiffy ain't it.
*
* @return void
*/ */
public function format() { public function format() {
@ -91,6 +134,9 @@ class Access {
/** /**
* update * update
* This function takes a named array as a datasource and updates the current access list entry * This function takes a named array as a datasource and updates the current access list entry
*
* @param array $data xxx
* @return boolean
*/ */
public function update($data) { public function update($data) {