vBulletin API Basics: Variables, Functions, Objects
THIS SHOULD NOT BE REPRINTED WITHOUT MY EXPLICIT PERMISSION
This How-To should serve as a reference to coders, who have a basic knowledge of PHP and who want to make their own mods.
$vbulletin (Type: Object)
Contains vBulletin data that has been in separate variables in vB 3.0.x.
Below you can find a translation table of changed variables and functions.
This is an expanded version of the list that you can find in vBulletin's source code (functions_legacy.php).
vBulletin 3.0.3 locations are on the left hand side, and the corresponding vBulletin 3.5.0 locations are on the right hand side.
Legacy locations can be enabled by running legacy_enable(), although this is officially not recommended for long term compatibility.
كود:
* $vboptions['x'] --> $vbulletin->options['x']
* $iforumcache --> $vbulletin->iforumcache
* $forumcache --> $vbulletin->forumcache
* $usergroupcache --> $vbulletin->usergroupcache
* $datastore['wol_spiders'] --> $vbulletin->wol_spiders
* $smiliecache --> $vbulletin->smiliecache
* $stylechoosercache --> $vbulletin->stylecache
* $datastore['x'] --> $vbulletin->x
* $bbuserinfo['x'] --> $vbulletin->userinfo['x']
* $session['x'] --> $vbulletin->session->vars['x']
*
* $_BITFIELD['usergroup'] --> $vbulletin->bf_ugp
* $_BITFIELD['usergroup']['x'] --> $vbulletin->bf_ugp_x
* $_BITFIELD['usergroup']['x']['y'] --> $vbulletin->bf_ugp_x['y']
* $_BITFIELD['calmoderatorpermissions']['x'] --> $vbulletin->bf_misc_calmoderatorpermissions['x']
* $_BITFIELD['moderatorpermissions']['x'] --> $vbulletin->bf_misc_moderatorpermissions['x']
* $_BITFIELD['languageoptions']['x'] --> $vbulletin->bf_misc_languageoptions['x']
* $_USEROPTIONS['x'] --> $vbulletin->bf_misc_useroptions['x']
* $_FORUMOPTIONS['x'] --> $vbulletin->bf_misc_forumoptions['x']
* $_INTPERMS --> $vbulletin->bf_misc_intperms
* $_INTPERMS['x'] --> $vbulletin->bf_misc_intperms['x']
*
* ------------------------------------------------------------------------------
* Variables and Functions below are NOT affected/re-enabled by legacy_enable()
* ------------------------------------------------------------------------------
*
* $_GET/$_POST/$_REQUEST/$_COOKIE/$_FILES --> $vbulletin->GPC['x']
* $DB_Site->x() --> $vbulletin->db->x()
* $url --> $vbulletin->url
* $nozip --> $vbulletin->nozip
* $script --> $vbulletin->script
* $scriptpath --> $vbulletin->scriptpath
*
* HTML_SELECTED --> not defined anymore in vB 3.5
* HTML_CHECKED --> not defined anymore in vB 3.5
*
* bbcode_parse() --> $bbcode_parser->parse
* iif($condition, $r_true, $r_false) --> obsolete, use ($condition ? $r_true : $r_false) instead;
Please note the following:- $vbulletin
Inside of object classes, you should access $vbulletin->[...] as $this->registry->[...]. Therefore, use that structure when modifying code inside of any classes.
. - VARIABLES ENABLED FOR TEMPLATES
$vboptions['x'], $bbuserinfo['x'] and $session['x'] do work in the template system without running legacy_enable().
. - SUPERGLOBALS
$_GET/$_POST/$_REQUEST/$_COOKIE/$_FILES/$_SERVER/$_ENV are available anywhere, but generally you should avoid using them. Instead, "clean" those variables and place them into $vbulletin->GPC using $vbulletin->input->clean_gpc() and $vbulletin->input->clean_array_gpc() methods.
You can read more about these two "cleaning" methods here.
As a summary:- Use $vbulletin->input->clean_gpc() for a single variable, and $vbulletin->input->clean_array_gpc() for arrays.
- After variables are patched through, they can be accessed using $vbulltin->GPC (which is an array).
- Cleaning 'somevar' will not create variable $somevar.
- $vbulletin->input->clean_gpc() returns the clean value, therefore the following code will work out nicely:
كود:
$id = $vbulletin->input->clean_gpc('r', 'id', TYPE_UINT);
Once you get to know the syntax of those functions, you can use the following as a reference:
كود:
------------------------------------
SOURCES AND THEIR EQUIVALENTS
------------------------------------
'g' - $_GET
'p' - $_POST
'r' - $_REQUEST
'c' - $_COOKIE
's' - $_SERVER
'e' - $_ENV
'f' - $_FILES
------------------------------------
VALID DATA TYPES
------------------------------------
TYPE_BOOL - Boolean
TYPE_INT - Integer
TYPE_UINT - Unsigned Integer
TYPE_NUM - Floating Point Number
TYPE_UNUM - Unsigned Floating Point Number
TYPE_UNIXTIME - Unix Timestamp (Unsigned Integer)
TYPE_STR - Trimmed String (No leading or trailing whitespace)
TYPE_NOTRIM - String
TYPE_NOHTML - Trimmed String sent through htmlspecialchars_uni()
TYPE_ARRAY - Array
TYPE_FILE - File
TYPE_NOCLEAN - Unvalidated
GLOBALIZING VARIABLES IN FUNCTIONS
Since most of the variables can be found within the $vbulletin class, there is generally no need to globalize more than one variable (which is $vbulletin). An exception would be the $vbphrase array, which currently cannot be found within the $vbulletin class.
Taking the above account, the following code is not good:
كود:
function foo()
{
global $forumcache, $vbulletin, $vboptions;
$forumcache =& $vbulletin->forumcache;
$vboptions =& $vbulletin->options;
foreach ($forumcache AS $forumid => $forum)
{
if ($vboptions['something'])
{
// do stuff
}
}
}
Instead, you should use the following code (which is, obviously, shorter and easier to use):
كود:
function foo()
{
global $vbulletin;
foreach ($vbulletin->forumcache AS $forumid => $forum)
{
if ($vbulletin->options['something'])
{
// do something
}
}
}
DATASTORE ITEMS
In vBulletin 3.0.x you could commonly see the following code:
كود PHP:
if (isset($datastore_item))
Unfortunately, this does not work in vBulletin 3.5.0, since the datastore items are now contained within $vbulletin class.
You need to use the following code instead:
كود PHP:
if ($vbulletin->datastore_item !== null)
if ($vbulletin->datastore_item !== null)
- BITFIELDS
In case you have been wondering, "ugp" stands for "UserGroup Permissions".
To avoid the confusing "$object->array[key1][key2][key3][key4]...[key10]" stuff, there are references set up that allow you to talk to deep elements quickly. For example, $vbulletin->bf_ugp_adminpermissions is a reference to $vbulletin->bf_ugp['adminpermissions'].
. - BBCODE PARSE
BBCode Parser has changed slightly in vBulletin 3.5.
To familiarize yourself with the new syntax, check out KirbyDE's How-To.
. - MISCELLANEOUS
It is impossible to list here every aspect of vBulletin code, therefore you should familizarize yourself with the contents of init.php and class_core.php before beginning to hack into the system (and I know you are in a rush 
).
$db (Type: Object)
As you might have judged from the Table 1 in this tutorial, the database object in vB3.5 is $vbulletin->db.
However, $db is another way to access that object; it is the way that used everywhere unless you call it from within a function. In functions, use $vbulletin->db.
Obviously, the purpose of the database method is to perform various operations on the database. Most common methods are described below.
- $db->query();
Deprecated in favor of below methods (to save memory).
Returns: MySQL Resource
. - $db->query_read();
Performs SELECT and SHOW operations only.
These queries will execute on the slave server, if one is defined.
Returns: MySQL Resource
. - $db->query_write();
Performs INSERT, REPLACE, UPDATE, DROP, ALTER and other data-modifying queries.
These queries will execute on the master server.
Returns: MySQL Resource
. - $db->query_first();
Same as query_read(), but returns first result as an array.
Returns: array on success / boolean false on failure
. - $db->num_rows($mysql_resource_var);
Input: A MySQL resource variable (usually output of the first three methods).
Returns: int Amount of Resulting Rows
. - $db->fetch_array($mysql_resource_var);
Input: A MySQL resource variable (usually output of the first three methods).
Returns: array One row from the mysql results on success / boolean false on failure
To fetch each row consecutively, use the following code:
كود:
while ($var = $db->fetch_array($mysql_resource_var))
{
// your code ($var contains the array);
}
يتابع هذا الرد
ضوابط المشاركة
رد مع اقتباس
المشاركة الأصلية كتبت بواسطة ESRB 
