Class vB_DataManager_ThreadRate

Description

Class to do data save/delete operations for THREAD RATINGS

Example usage (inserts a new thread rating):

$t =& datamanager_init('ThreadRate', $vbulletin, ERRTYPE_STANDARD); $t->set_info('threadid', 12); $t->set_info('userid', 4); $t->set_info('vote', 3); $t->save();

  • version: $Revision: 25833 $
  • date: $Date: 2008-02-22 08:10:39 -0600 (Fri, 22 Feb 2008) $

Located in /includes/class_dm_threadrate.php (line 33)

vB_DataManager
   |
   --vB_DataManager_ThreadRate
Variable Summary
Method Summary
 vB_DataManager_ThreadRate vB_DataManager_ThreadRate (vB_Registry &$registry, [integer $errtype = ERRTYPE_STANDARD])
 void post_delete ([boolean $doquery = true])
 void post_save_each ([boolean $doquery = true])
 void pre_save ([ $doquery = true])
 boolean verify_userid (integer &$userid)
 boolean verify_vote (integer &$vote)
Variables
array $condition_construct = array('threadrateid = %1$s', 'threadrateid') (line 53)

Condition for update query


Redefinition of:
vB_DataManager::$condition_construct
Condition template for update query This is for use with sprintf(). First key is the where clause, further keys are the field names of the data to be used.
int $max_vote = 5 (line 67)

The maximum vote

string $table = 'threadrate' (line 60)

The main table this class deals with


Redefinition of:
vB_DataManager::$table
Default table to be used in queries
array $threadrate = array() (line 74)

Array to store stuff to save to threadrate table

array $validfields = array(
'threadrateid' => array(TYPE_UINT, REQ_INCR, VF_METHOD, 'verify_nonzero'),'threadid'=>array(TYPE_UINT,REQ_YES),'userid'=>array(TYPE_UINT,REQ_YES,VF_METHOD,'verify_userid'),'vote'=>array(TYPE_INT,REQ_YES,VF_METHOD,'verify_vote'),# TYPE_INT to allow negative rating
'ipaddress'=>array(TYPE_STR,REQ_AUTO,VF_METHOD,'verify_ipaddress'))
(line 40)

Array of recognised and required fields for threadrate, and their types


Redefinition of:
vB_DataManager::$validfields
Array of field names that are valid for this data object

Inherited Variables

Inherited from vB_DataManager

vB_DataManager::$bitfields
vB_DataManager::$condition
vB_DataManager::$dbobject
vB_DataManager::$errors
vB_DataManager::$error_handler
vB_DataManager::$existing
vB_DataManager::$failure_callback
vB_DataManager::$info
vB_DataManager::$lamda
vB_DataManager::$presave_called
vB_DataManager::$rawfields
vB_DataManager::$registry
vB_DataManager::$setfields
Methods
Constructor vB_DataManager_ThreadRate (line 82)

Constructor - checks that the registry object has been passed correctly.

vB_DataManager_ThreadRate vB_DataManager_ThreadRate (vB_Registry &$registry, [integer $errtype = ERRTYPE_STANDARD])
  • vB_Registry &$registry: Instance of the vBulletin data registry object - expected to have the database object as one of its $this->db member.
  • integer $errtype: One of the ERRTYPE_x constants
post_delete (line 142)

Removing 1 from the vote count for that thread

void post_delete ([boolean $doquery = true])
  • boolean $doquery: Do the query?

Redefinition of:
vB_DataManager::post_delete()
Additional data to update after a delete call (such as denormalized values in other tables).
post_save_each (line 170)

Updating the votecount for that thread

void post_save_each ([boolean $doquery = true])
  • boolean $doquery: Do the query?

Redefinition of:
vB_DataManager::post_save_each()
Additional data to update after a save call (such as denormalized values in other tables).
pre_save (line 89)
void pre_save ([ $doquery = true])
  • $doquery

Redefinition of:
vB_DataManager::pre_save()
Any checks to run immediately before saving. If returning false, the save will not take place.
verify_userid (line 221)

Verifies that the specified user exists

  • return: Returns true if user exists
boolean verify_userid (integer &$userid)
  • integer &$userid: User ID

Redefinition of:
vB_DataManager::verify_userid()
Verifies that the specified user exists
verify_vote (line 243)

Checks that the vote is between 0 and 5

  • return: Returns true on success
boolean verify_vote (integer &$vote)
  • integer &$vote: The vote

Inherited Methods

Inherited From vB_DataManager

 vB_DataManager::vB_DataManager()
 vB_DataManager::check_required()
 vB_DataManager::db_delete()
 vB_DataManager::db_insert()
 vB_DataManager::db_insert_ignore()
 vB_DataManager::db_update()
 vB_DataManager::delete()
 vB_DataManager::do_set()
 vB_DataManager::do_unset()
 vB_DataManager::error()
 vB_DataManager::fetch_field()
 vB_DataManager::fetch_insert_sql()
 vB_DataManager::fetch_update_sql()
 vB_DataManager::has_errors()
 vB_DataManager::post_delete()
 vB_DataManager::post_save_each()
 vB_DataManager::post_save_once()
 vB_DataManager::pre_delete()
 vB_DataManager::pre_save()
 vB_DataManager::save()
 vB_DataManager::set()
 vB_DataManager::setr()
 vB_DataManager::setr_info()
 vB_DataManager::set_bitfield()
 vB_DataManager::set_condition()
 vB_DataManager::set_error_handler()
 vB_DataManager::set_existing()
 vB_DataManager::set_failure_callback()
 vB_DataManager::set_info()
 vB_DataManager::strip_empty_bbcode()
 vB_DataManager::strip_empty_bbcode_callback()
 vB_DataManager::verify()
 vB_DataManager::verify_commalist()
 vB_DataManager::verify_date_array()
 vB_DataManager::verify_email()
 vB_DataManager::verify_image_count()
 vB_DataManager::verify_ipaddress()
 vB_DataManager::verify_link()
 vB_DataManager::verify_list()
 vB_DataManager::verify_md5()
 vB_DataManager::verify_nonempty()
 vB_DataManager::verify_nonzero()
 vB_DataManager::verify_pagetext()
 vB_DataManager::verify_serialized()
 vB_DataManager::verify_spacelist()
 vB_DataManager::verify_userid()
 vB_DataManager::verify_username()

Documentation generated on Fri, 09 May 2008 09:01:06 -0500 by phpDocumentor 1.4.1