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: Rating

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

Class Overview

database_object
   |
   --Rating

Rating class This is an amalgamation(sp?) of code from SoundOfEmotion to track ratings for songs, albums and artists.

Variables

Methods

Inherited Variables

Class: database_object

database_object::$cache_hit

Inherited Methods

Class: database_object

database_object::add_to_cache()
add_to_cache
database_object::get_from_cache()
get_from_cache
database_object::get_info()
get_info
database_object::is_cached()
is_cached

Class Details

[line 27]
Rating class This is an amalgamation(sp?) of code from SoundOfEmotion to track ratings for songs, albums and artists.



[ Top ]

Class Variables

$id =

[line 30]


Type:   mixed


[ Top ]

$preciserating =

[line 35]


Type:   mixed


[ Top ]

$rating =

[line 34]


Type:   mixed


[ Top ]

$type =

[line 31]


Type:   mixed


[ Top ]


Class Methods

static method build_cache [line 66]

static void build_cache( $type, $ids)

build_cache

This attempts to get everything we'll need for this page load in a single query, saving the connection overhead //FIXME: Improve logic so that misses get cached as average




Tags:

access:  public


Parameters:

   $type  
   $ids  

[ Top ]

static method show [line 220]

static void show( $object_id, $type)

show This takes an id and a type and displays the rating if ratings are enabled.



Tags:

access:  public


Parameters:

   $object_id  
   $type  

[ Top ]

static method show_static [line 235]

static void show_static( $object_id, $type)

show_static

This is a static version of the ratings created by Andy90




Tags:

access:  public


Parameters:

   $object_id  
   $type  

[ Top ]

constructor __construct [line 42]

Rating __construct( $id, $type)

Constructor

This is run every time a new object is created, it requires the id and type of object that we need to pull the raiting for




Tags:

access:  public


Parameters:

   $id  
   $type  

[ Top ]

method get_average [line 141]

void get_average( )

get_average

Get the users average rating this is based off the floor'd average of what everyone has rated this album as. This is shown if there is no personal rating, and used for random play mojo. It sets $this->average_rating and returns the value




Tags:

access:  public


[ Top ]

method get_user [line 113]

void get_user( $user_id)

get_user

Get the user's rating this is based off the currently logged in user. It returns the value




Tags:

access:  public


Parameters:

   $user_id  

[ Top ]

method set_rating [line 185]

void set_rating( $score)

set_rating This function sets a rating for the current $this object.

This uses the currently logged in user for the 'user' who is rating the object. Returns true on success, false on failure




Tags:

access:  public


Parameters:

   $score  

[ Top ]

Documentation generated on Thu, 12 Feb 2009 08:00:06 +0900 by phpDocumentor 1.4.2