Docs For Class vB

vB_Registry

Description

Class to store commonly-used variables

version: $Revision: 35065 $
date: $Date: 2010-01-21 14:01:23 -0600 (Thu, 21 Jan 2010) $

Located in /includes/class_core.php (line 2792)

Variable Summary

string $alt_ip

mixed $attachmentcache

mixed $avatarcache

mixed $banemail

string $basepath

mixed $bbcodecache

mixed $bbcode_style

array $bf_misc

array $bf_misc_calmoderatorpermissions

array $bf_misc_forumoptions

array $bf_misc_hvcheck

array $bf_misc_intperms

array $bf_misc_languageoptions

array $bf_misc_moderatorpermissions

array $bf_misc_useroptions

array $bf_ugp

array $bf_ugp_adminpermissions

array $bf_ugp_calendarpermissions

array $bf_ugp_forumpermissions

array $bf_ugp_genericoptions

array $bf_ugp_genericpermissions

array $bf_ugp_pmpermissions

array $bf_ugp_visitormessagepermissions

array $bf_ugp_wolpermissions

mixed $birthdaycache

array $config

mixed $cron

array $csrf_skip_list

vB_Datastore $datastore

vB_Database $db

mixed $debug

mixed $eventcache

mixed $forumcache

array $GPC

array $GPC_exists

mixed $iconcache

mixed $iforumcache

vB_Input_Cleaner $input

string $ipaddress

mixed $languagecache

mixed $loadcache

mixed $mailqueue

mixed $markupcache

mixed $maxloggedin

mixed $noheader

mixed $noticecache

mixed $nozip

mixed $options

mixed $pluginlist

mixed $prefixcache

mixed $products

mixed $ranks

string $script

string $scriptpath

vB_Session $session

mixed $shutdown

mixed $smiliecache

mixed $socialsitecache

mixed $statement

mixed $stylecache

mixed $stylevars

array $superglobal_size

mixed $templatecache

string $url

mixed $usergroupcache

array $userinfo

mixed $userstats

mixed $versionnumber

string $wolpath

mixed $wol_spiders

Method Summary

vB_Registry vB_Registry ()

void array_define ( $array)

bool check_user_permission (string $group, string $permission)

void fetch_config ()

Variables

string $alt_ip (line 2886)

Alternate IP for the browsing user. This attempts to use various HTTP headers to find the real IP of a user that may be behind a proxy.

mixed $attachmentcache = null (line 2968)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $avatarcache = null (line 2969)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $banemail = null (line 2983)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

string $basepath (line 2901)

The request basepath.

Use for <base>

mixed $bbcodecache = null (line 2979)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $bbcode_style = array('code' => -1, 'html' => -1, 'php' => -1, 'quote' => -1) (line 3001)

Miscellaneous variables

array $bf_misc (line 2951)

Bitfield arrays for miscellaneous permissions and options.

array $bf_misc_calmoderatorpermissions (line 2953)

Bitfield arrays for miscellaneous permissions and options.

array $bf_misc_forumoptions (line 2954)

Bitfield arrays for miscellaneous permissions and options.

array $bf_misc_hvcheck (line 2959)

Bitfield arrays for miscellaneous permissions and options.

array $bf_misc_intperms (line 2955)

Bitfield arrays for miscellaneous permissions and options.

array $bf_misc_languageoptions (line 2956)

Bitfield arrays for miscellaneous permissions and options.

array $bf_misc_moderatorpermissions (line 2957)

Bitfield arrays for miscellaneous permissions and options.

array $bf_misc_useroptions (line 2958)

Bitfield arrays for miscellaneous permissions and options.

array $bf_ugp (line 2933)

Bitfield arrays for usergroup permissions.

array $bf_ugp_adminpermissions (line 2935)

Bitfield arrays for usergroup permissions.

array $bf_ugp_calendarpermissions (line 2936)

Bitfield arrays for usergroup permissions.

array $bf_ugp_forumpermissions (line 2937)

Bitfield arrays for usergroup permissions.

array $bf_ugp_genericoptions (line 2938)

Bitfield arrays for usergroup permissions.

array $bf_ugp_genericpermissions (line 2939)

Bitfield arrays for usergroup permissions.

array $bf_ugp_pmpermissions (line 2940)

Bitfield arrays for usergroup permissions.

array $bf_ugp_visitormessagepermissions (line 2942)

Bitfield arrays for usergroup permissions.

array $bf_ugp_wolpermissions (line 2941)

Bitfield arrays for usergroup permissions.

mixed $birthdaycache = null (line 2970)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

array $config (line 2846)

Array of data from config.php.

mixed $cron = null (line 2981)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

array $csrf_skip_list = array() (line 2838)

Array of do actions that are exempt from checks

vB_Datastore $datastore (line 2800)

Datastore object.

vB_Database $db (line 2814)

Database object.

mixed $debug (line 3006)

Miscellaneous variables

mixed $eventcache = null (line 2971)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $forumcache = null (line 2972)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

array $GPC = array() (line 2854)

Array of data that has been cleaned by the input cleaner.

array $GPC_exists = array() (line 2863)

Array of booleans. When cleaning a variable, you often lose the ability to determine if it was specified in the user's input. Entries in this array are true if the variable existed before cleaning.

mixed $iconcache = null (line 2973)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $iforumcache = array() (line 3003)

Miscellaneous variables

vB_Input_Cleaner $input (line 2807)

Input cleaner object.

string $ipaddress (line 2878)

IP Address of the current browsing user.

mixed $languagecache = null (line 2976)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $loadcache = null (line 2991)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $mailqueue = null (line 2982)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $markupcache = null (line 2974)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $maxloggedin = null (line 2984)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $noheader (line 3007)

Miscellaneous variables

mixed $noticecache = null (line 2992)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $nozip (line 3005)

Miscellaneous variables

mixed $options = null (line 2967)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $pluginlist = null (line 2985)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $prefixcache = null (line 2993)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $products = null (line 2986)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $ranks = null (line 2987)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

string $script (line 2916)

The URL of the current page, without anything after the '?'.

string $scriptpath (line 2893)

The URL of the currently browsed page.

vB_Session $session (line 2831)

Session object.

mixed $shutdown (line 3015)

Shutdown handler

Miscellaneous variables

mixed $smiliecache = null (line 2977)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $socialsitecache = null (line 2980)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $statement = null (line 2988)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $stylecache = null (line 2975)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $stylevars (line 3008)

Miscellaneous variables

access: public

array $superglobal_size = array() (line 2870)

The size of the super global arrays.

mixed $templatecache = array() (line 3002)

Miscellaneous variables

string $url (line 2925)

Generally the URL of the referring page if there is one, though it is often set in various places of the code. Used to determine the page to redirect to, if necessary.

mixed $usergroupcache = null (line 2978)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

array $userinfo (line 2824)

Array of info about the current browsing user. In the case of a registered user, this will be results of fetch_userinfo(). A guest will have slightly different entries.

mixed $userstats = null (line 2989)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

mixed $versionnumber (line 3004)

Miscellaneous variables

string $wolpath (line 2909)

Similar to the URL of the current page, but expands some items and includes data submitted via POST. Used for Who's Online purposes.

mixed $wol_spiders = null (line 2990)

Results for specific entries in the datastore.

var: Mixed, though mostly arrays.

Methods

Constructor vB_Registry (line 3022)

Constructor - initializes the nozip system,

and calls and instance of the vB_Input_Cleaner class

vB_Registry vB_Registry ()

array_define (line 3082)

Takes the contents of an array and recursively uses each title/data pair to create a new defined constant.

void array_define ( $array)

$array

check_user_permission (line 3113)

Check if a user has a specific permission

This is intended to replace direct acces to the userinfo['permissions'] array.

For example: $vbulletin->check_user_permission('genericpermissions', 'cancreatetag')

which replaces ($vbulletin->userinfo['permissions']['genericpermissions'] & $vbulletin->bf_ugp_genericpermissions['cancreatetag'])

return: If the user has the requested permission
access: public

bool check_user_permission (string $group, string $permission)

string $group: the permission group to check
string $permission: the permission to check within the group

fetch_config (line 3043)

Fetches database/system configuration

void fetch_config ()

Documentation generated on Tue, 26 Jan 2010 15:15:05 -0600 by phpDocumentor 1.4.3