Class vB_DataManager_Admin

Description

Class to do data save/delete operations for ADMINISTRATORS

The major purpose of this class is for managing admin permissions.

  • version: $Revision: 15640 $
  • date: $Date: 2006-09-05 09:08:06 -0500 (Tue, 05 Sep 2006) $

Located in /includes/class_dm_admin.php (line 27)

vB_DataManager
   |
   --vB_DataManager_Admin
Variable Summary
Method Summary
 vB_DataManager_Admin vB_DataManager_Admin (vB_Registry &$registry, [integer $errtype = ERRTYPE_STANDARD])
 void post_delete ([boolean $doquery = true])
 void post_save_each ([boolean $doquery = true])
 boolean pre_save ([boolean $doquery = true])
 boolean set_bitfield (string $fieldname, string $bitname, boolean $onoff)
 boolean verify_cssprefs (string &$cssprefs)
 boolean verify_navprefs (string &$navprefs)
Variables
array $administrator = array() (line 62)

Arrays to store stuff to save to admin-related tables

array $bitfields = array('adminpermissions' => 'bf_ugp_adminpermissions') (line 48)

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('userid = %1$d', 'userid') (line 69)

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.
string $table = 'administrator' (line 55)

The main table this class deals with


Redefinition of:
vB_DataManager::$table
Default table to be used in queries
array $validfields = array(
'userid' => array(TYPE_UINT, REQ_YES, VF_METHOD),'adminpermissions'=>array(TYPE_UINT,REQ_NO),'navprefs'=>array(TYPE_STR,REQ_NO,VF_METHOD),'cssprefs'=>array(TYPE_STR,REQ_NO,VF_METHOD),'notes'=>array(TYPE_NOHTML,REQ_NO),'dismissednews'=>array(TYPE_NOCLEAN,REQ_NO,VF_METHOD,'verify_commalist'),)
(line 34)

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_Admin (line 77)

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

vB_DataManager_Admin vB_DataManager_Admin (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 180)

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

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

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

In batch updates, is executed for each record updated.

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

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_bitfield (line 93)

Sets a bit in a bitfield

boolean set_bitfield (string $fieldname, string $bitname, boolean $onoff)
  • string $fieldname: Name of the database bitfield (options, permissions etc.)
  • string $bitname: Name of the bit within the bitfield (canview, canpost etc.)
  • boolean $onoff: Whether the bit should be set or not

Redefinition of:
vB_DataManager::set_bitfield()
Sets a bit in a bitfield
verify_cssprefs (line 130)

Sanitizes and verifies that the CP style directory specified is valid

boolean verify_cssprefs (string &$cssprefs)
  • string &$cssprefs: Name of the CP style directory; do not include any path info
verify_navprefs (line 114)

Verifies that the navigation preferences are valid

boolean verify_navprefs (string &$navprefs)
  • string &$navprefs: Navigation preferences string in (<product>_<id>(,?))* format

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