Ampache
[ class tree: Ampache ] [ index: Ampache ] [ all elements ]
Packages:
Ampache
Catalog
Horde_Browser
Search
Web
XMLRPC
XML_RPC


Files:
access.class.php
access.php
ajax.class.php
ajax.server.php
album.class.php
albums.php
AmazonSearchEngine.class.php
ampachemail.class.php
ampacherss.class.php
api.class.php
archive.lib.php
artist.class.php
artists.php
batch.lib.php
batch.php
browse.ajax.php
browse.class.php
browse.php
captcha.php
catalog.php
catalog_update.inc
class.nusoap_base.php
class.soapclient.php
class.soap_fault.php
class.soap_parser.php
class.soap_server.php
class.soap_transport_http.php
class.soap_val.php
class.wsdl.php
class.wsdlcache.php
class.xmlschema.php
config.class.php
core.class.php
database_object.abstract.php
dba.class.php
debug.lib.php
delete_disabled.inc
democratic.ajax.php
democratic.class.php
democratic.php
dump_album_art.inc
duplicates.php
error.class.php
export.php
fix_filenames.inc
flag.ajax.php
flag.class.php
flag.php
flag.php
general.lib.php
genre.class.php
genre.php
gettext.php
gettext.php
httpq.controller.php
httpqplayer.class.php
image.php
index.ajax.php
index.php
index.php
index.php
init.php
install.php
install.php
jamendoSearch.class.php
lastfm.class.php
Lastfm.plugin.php
localplay.abstract.php
localplay.ajax.php
localplay.class.php
localplay.php
log.lib.php
login.php
logout.php
mail.php
media.interface.php
migrate_config.inc
modules.php
mp3tunes.class.php
mpd.class.php
mpd.controller.php
nusoap.php
nusoapmime.php
playlist.ajax.php
playlist.class.php
playlist.php
plugin.class.php
preference.class.php
preferences.php
preferences.php
print_tags.inc
radio.class.php
radio.php
random.ajax.php
random.class.php
random.php
rating.class.php
rating.lib.php
register.php
registration.class.php
RioPlayer.plugin.php
rss.php
scrobbler.class.php
search.php
shout.php
shout.php
shoutbox.class.php
shoutcast.controller.php
Snoopy.class.php
song.ajax.php
song.class.php
song.php
sort_files.inc
stats.ajax.php
stats.class.php
stats.php
stream.ajax.php
stream.class.php
stream.lib.php
stream.php
system.php
tag.ajax.php
tag.class.php
test.php
themes.php
tmpplaylist.class.php
update.class.php
update.php
user.class.php
users.php
util.php
vainfo.class.php
validateEmail.php
validateEmailFormat.php
vauth.class.php
video.class.php
write_playlists.inc
write_tags.inc
xml.server.php
xmldata.class.php
xmlrpc.server.php
xmlrpcclient.class.php
xmlrpcserver.class.php
xspf_player.php

Interfaces:
media
Classes:
Access
Ajax
Album
AmazonSearch
AmpacheHttpq
AmpacheLastfm
AmpacheMail
AmpacheMpd
AmpacheRioPlayer
AmpacheRSS
AmpacheShoutCast
Api
archive
Artist
Browse
bzip_file
captcha
Config
Core
database_object
Dba
Democratic
easy_captcha
easy_captcha_dxy_spike
easy_captcha_dxy_wave
easy_captcha_fuzzy
easy_captcha_graphic
easy_captcha_graphic_image_disturbed
easy_captcha_graphic_image_waved
easy_captcha_persistent_grant
easy_captcha_spamfree_no_new_urls
easy_captcha_text_disable
easy_captcha_text_math_formula
easy_captcha_utility
Error
Flag
Genre
gzip_file
HttpQPlayer
jamendoSearch
LastFMSearch
Localplay
localplay_controller
mp3tunes
mpd
nusoapservermime
nusoap_base
nusoap_client
nusoap_client_mime
nusoap_fault
nusoap_parser
nusoap_server
nusoap_server_mime
nusoap_wsdlcache
nusoap_xmlschema
Playlist
Plugin
Preference
Radio
Random
Rating
Registration
scrobbler
shoutBox
Snoopy
soapclient
soapclientmime
soapval
soap_fault
soap_parser
soap_server
soap_transport_http
Song
Stats
Stream
Tag
tar_file
tmpPlaylist
Update
User
vainfo
vauth
Video
wsdl
wsdlcache
xmlData
xmlRpcClient
xmlRpcServer
XMLSchema
zip_file

Class: Democratic

Source Location: /lib/class/democratic.class.php

Class Overview

tmpPlaylist
   |
   --Democratic

Democratic

Variables

Methods

Inherited Variables

Class: tmpPlaylist

tmpPlaylist::$id
tmpPlaylist::$items
tmpPlaylist::$object_type
tmpPlaylist::$session
tmpPlaylist::$type

Inherited Methods

Class: tmpPlaylist

tmpPlaylist::__construct()
Constructor
tmpPlaylist::add_object()
add_object
tmpPlaylist::clear()
clear
tmpPlaylist::count_items()
count_items
tmpPlaylist::create()
create
tmpPlaylist::delete()
delete
tmpPlaylist::delete_track()
delete_track
tmpPlaylist::get_from_session()
get_from_session
tmpPlaylist::get_from_userid()
get_from_userid
tmpPlaylist::get_items()
get_items
tmpPlaylist::get_next_object()
get_next_object
tmpPlaylist::get_vote()
get_vote
tmpPlaylist::prune_playlists()
prune_playlists
tmpPlaylist::prune_tracks()
prune_tracks
tmpPlaylist::update_playlist()
update_playlist
tmpPlaylist::vote_active()
vote_active

Class Details

[line 27]
Democratic

This class handles democratic play, which is a fancy name for voting based playback. This extends the tmpplaylist




[ Top ]

Class Variables

$base_playlist =

[line 34]



Tags:

access:  public

Type:   mixed
Overrides:   Array


[ Top ]

$cooldown =

[line 30]



Tags:

access:  public

Type:   mixed


[ Top ]

$level =

[line 31]



Tags:

access:  public

Type:   mixed


[ Top ]

$name =

[line 29]



Tags:

access:  public

Type:   mixed


[ Top ]

$primary =

[line 33]



Tags:

access:  public

Type:   mixed


[ Top ]

$tmp_playlist =

[line 37]



Tags:

access:  public

Type:   mixed


[ Top ]

$user =

[line 32]



Tags:

access:  public

Type:   mixed


[ Top ]


Class Methods

static method create [line 483]

static void create( $data)

create

This is the democratic play create function it inserts this into the democratic table




Tags:

access:  public


Overrides tmpPlaylist::create() (create)

Parameters:

   $data  

[ Top ]

static method delete [line 452]

static void delete( $democratic_id)

delete

This deletes a democratic playlist




Tags:

access:  public


Overrides tmpPlaylist::delete() (delete)

Parameters:

   $democratic_id  

[ Top ]

static method get_current_playlist [line 148]

static void get_current_playlist( )

get_current_playlist

This returns the curren users current playlist, or if specified this current playlist of the user




Tags:

access:  public


[ Top ]

static method get_playlists [line 125]

static void get_playlists( )

get_playlists This returns all of the current valid 'Democratic' Playlists that have been created.



Tags:

access:  public


[ Top ]

static method prune_tracks [line 511]

static void prune_tracks( )

prune_tracks

This replaces the normal prune tracks and correctly removes the votes as well




Tags:

access:  public


Overrides tmpPlaylist::prune_tracks() (prune_tracks)

[ Top ]

constructor __construct [line 43]

Democratic __construct( [ $id = ''])

constructor

We need a constructor for this class. It does it's own thing now




Tags:

access:  public


Overrides tmpPlaylist::__construct() (Constructor)

Parameters:

   $id  

[ Top ]

method add_vote [line 380]

void add_vote( $object_id, [ $object_type = ''])

add_vote

This takes a object id and user and actually inserts the row




Tags:

access:  public


Parameters:

   $object_id  
   $object_type  

[ Top ]

method clear [line 529]

void clear( )

clear This is really just a wrapper function, it clears the entire playlist including all votes etc.



Tags:

access:  public


Overrides tmpPlaylist::clear() (clear)

[ Top ]

method delete_votes [line 434]

void delete_votes( $row_id)

delete_votes

This removes the votes for the specified object on the current playlist




Tags:

access:  public


Parameters:

   $row_id  

[ Top ]

method format [line 95]

void format( )

format

This makes the objects variables all purrty so that they can be displayed




Tags:

access:  public


[ Top ]

method get_cool_songs [line 317]

void get_cool_songs( )

get_cool_songs This returns all of the song_ids for songs that have happened within the last 'cooldown' for this user.



Tags:

access:  public


[ Top ]

method get_items [line 183]

void get_items( )

get_items

This returns an array of all object_ids currently in this tmpPlaylist. This has gotten a little more complicated because of type, the values are an array

  1. being ID 1 being TYPE
FIXME: This is too complex, it makes my brain hurt [VOTE COUNT] [DATE OF NEWEST VOTE] [ROW ID] [OBJECT_ID] [OBJECT_TYPE]

Sorting does the following sort largest VOTE COUNT to top sort smallest DATE OF NEWEST VOTE]




Tags:

access:  public


Overrides tmpPlaylist::get_items() (get_items)

[ Top ]

method get_next_object [line 258]

void get_next_object( [ $offset = ''])

get_next_object

This returns the next object in the tmp_playlist most of the time this will just be the top entry, but if there is a base_playlist and no items in the playlist then it returns a random entry from the base_playlist




Tags:

access:  public


Overrides tmpPlaylist::get_next_object() (get_next_object)

Parameters:

   $offset  

[ Top ]

method get_uid_from_object_id [line 296]

void get_uid_from_object_id( $object_id, [ $object_type = ''])

get_uid_from_object_id

This takes an object_id and an object type and returns the ID for the row




Tags:

access:  public


Parameters:

   $object_id  
   $object_type  

[ Top ]

method get_url [line 237]

void get_url( )

get_url

This returns the special play URL for democratic play, only open to ADMINs




Tags:

access:  public


[ Top ]

method has_vote [line 352]

void has_vote( $object_id, [ $type = ''])

has_vote

This checks to see if the current user has already voted on this object




Tags:

access:  public


Parameters:

   $object_id  
   $type  

[ Top ]

method remove_vote [line 415]

void remove_vote( $row_id)

remove_vote

This is called to remove a vote by a user for an object, it uses the object_id As that's what we'll have most the time, no need to check if they've got an existing vote for this, just remove anything that is there




Tags:

access:  public


Parameters:

   $row_id  

[ Top ]

method set_parent [line 77]

void set_parent( )

set_parent

This returns the tmpPlaylist for this democratic play instance




Tags:

access:  public


[ Top ]

method update [line 472]

void update( $data)

update

This updates an existing democratic playlist item. It takes a key'd array just like the create




Tags:

access:  public


Parameters:

   $data  

[ Top ]

method vote [line 335]

void vote( $items)

vote

This function is called by users to vote on a system wide playlist This adds the specified objects to the tmp_playlist and adds a 'vote' by this user, naturally it checks to make sure that the user hasn't already voted on any of these objects




Tags:

access:  public


Parameters:

   $items  

[ Top ]

Documentation generated on Thu, 12 Feb 2009 07:59:57 +0900 by phpDocumentor 1.4.2