Changeset 2811

Show
Ignore:
Timestamp:
07/18/08 05:46:57 (3 months ago)
Author:
fumiakiy
Message:

POD update.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • branches/release-41/lib/MT/Scorable.pm

    r1174 r2811  
    317317=head1 METHODS 
    318318 
    319 =head2 get_score($plugin_key, $user) 
     319=head2 get_score($namespace, $user) 
    320320 
    321321Return the score of the object, scored by the user specified. 
     
    323323specified by a user to an object. 
    324324 
    325 =head2 set_score($plugin_key, $user, $score, $overwrite) 
     325=head2 set_score($namespace, $user, $score, $overwrite) 
    326326 
    327327Set specified score to the object by the user.  If $overwrite argument 
    328328is false and the user has already scored the object before, error results. 
    329329 
    330 =head2 score_for($plugin_key
     330=head2 score_for($namespace
    331331 
    332332Return the total score of the object. 
    333333 
    334 =head2 vote_for($plugin_key
     334=head2 vote_for($namespace
    335335 
    336336Return how many users scored to the object. 
    337337 
    338 =head2 score_high($plugin_key
     338=head2 score_high($namespace
    339339 
    340340Return the highest score to the object. 
    341341 
    342 =head2 score_low($plugin_key
     342=head2 score_low($namespace
    343343 
    344344Return the lowest score to the object. 
    345345 
    346 =head2 score_avg($plugin_key
     346=head2 score_avg($namespace
    347347 
    348348Return the average score of the object. 
    349349 
    350 =head2 rank_for($plugin_key, $max
     350=head2 rank_for($namespace, $max, $dbd_args
    351351 
    352352Return the rank of the object based on its score among other objects 
    353353of the same type.  The smaller the number is, the higher the object's rank is. 
    354354 
     355$max is the maximum number of rank. 
     356 
     357You can pass "join" argument to $dbd_args parameter to narrow 
     358the data loaded from the database that is loaded from the database. 
     359 
    355360=head1 AUTHOR & COPYRIGHT 
    356361