Class vB_DataManager_Moderator

Description

Class to do data save/delete operations for MODERATORS

Example usage (inserts a new moderator):

$f = new vB_DataManager_Moderator(); $f->set_info('moderatorid', 12); $f->save();

  • version: $Revision: 25896 $
  • date: $Date: 2008-02-28 05:46:19 -0600 (Thu, 28 Feb 2008) $

Located in /includes/class_dm_moderator.php (line 31)

vB_DataManager
   |
   --vB_DataManager_Moderator
Variable Summary
Method Summary
 vB_DataManager_Moderator vB_DataManager_Moderator (vB_Registry &$registry, [integer $errtype = ERRTYPE_STANDARD])
 mixed delete ([ $doquery = true])
 void post_save_each ([boolean $doquery = true])
 boolean pre_save ([boolean $doquery = true])
 boolean set (string $fieldname, mixed $value)
 void update_user_failed_insert ( &$user)
 boolean verify_forumid (integer &$forumid)
 boolean verify_permissions (array &$permissions)
 boolean verify_permissions2 (array &$permissions)
 boolean verify_userid (integer &$userid)
Variables
array $bitfields = array(
'permissions' => 'bf_misc_moderatorpermissions',
'permissions2' => 'bf_misc_moderatorpermissions2',
)
(line 51)

Array of field names that are bitfields, together with the name of the variable in the registry with the definitions.


Redefinition of:
vB_DataManager::$bitfields
Array of field names that are bitfields, together with the name of the variable in the registry with the definitions.
array $condition_construct = array('moderatorid = %1$d', 'moderatorid') (line 69)

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.


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.
array $moderator = array() (line 76)

Array to store stuff to save to moderator table

string $table = 'moderator' (line 61)

The main table this class deals with


Redefinition of:
vB_DataManager::$table
Default table to be used in queries
array $validfields = array(
'moderatorid' => array(TYPE_UINT, REQ_INCR, VF_METHOD, 'verify_nonzero'),'userid'=>array(TYPE_UINT,REQ_YES,VF_METHOD),'forumid'=>array(TYPE_INT,REQ_YES,VF_METHOD),'permissions'=>array(TYPE_ARRAY_BOOL,REQ_YES,VF_METHOD),'permissions2'=>array(TYPE_ARRAY_BOOL,REQ_YES,VF_METHOD),)
(line 38)

Array of recognised and required fields for moderators, 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::$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_Moderator (line 84)

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

vB_DataManager_Moderator vB_DataManager_Moderator (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
delete (line 319)

Deletes a moderator

  • return: The number of affected rows
mixed delete ([ $doquery = true])
  • $doquery

Redefinition of:
vB_DataManager::delete()
Deletes the specified data item from the database
post_save_each (line 235)

Additional data to update after a save call (such as denormalized values in other tables).

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 206)

Any checks to run immediately before saving. If returning false, the save will not take place.

  • return: True on success; false if an error occurred
boolean pre_save ([boolean $doquery = true])
  • boolean $doquery: Do the query?

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

Overriding version of the set() function to deal with the selecting userid from username

  • return: Returns true on success
boolean set (string $fieldname, mixed $value)
  • string $fieldname: Name of the field
  • mixed $value: Value of the field

Redefinition of:
vB_DataManager::set()
Sets the supplied data to be part of the data to be saved. Use setr() if a reference to $value is to be passed
update_user_failed_insert (line 365)

Callback function that is hit when inserting a new moderator, and his/her usergroup or member groups fail to be changed.

void update_user_failed_insert ( &$user)
  • &$user
verify_forumid (line 119)

Verifies that the specified forum exists

  • return: Returns true if forum exists
boolean verify_forumid (integer &$forumid)
  • integer &$forumid: ID of the forum
verify_permissions (line 144)

Converts an array of 1/0 options into the permissions bitfield

  • return: Returns true on success
boolean verify_permissions (array &$permissions)
  • array &$permissions: Array of 1/0 values keyed with the bitfield names for the moderator permissions bitfield
verify_permissions2 (line 157)

Converts an array of 1/0 options into the permissions bitfield

  • return: Returns true on success
boolean verify_permissions2 (array &$permissions)
  • array &$permissions: Array of 1/0 values keyed with the bitfield names for the moderator permissions bitfield
verify_userid (line 98)

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

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:02 -0500 by phpDocumentor 1.4.1