Go Back   vb.org Archive > vBulletin Article Depository > Read An Article > vBulletin 3 Articles
FAQ Community Calendar Today's Posts Search

Reply
 
Thread Tools
Add Multiple Options Per User (via Bitfields)
akanevsky
Join Date: Apr 2005
Posts: 3,972

 

Show Printable Version Email this Page Subscription
akanevsky akanevsky is offline 05-19-2006, 10:00 PM

Create Multiple Options Per User (via Bitfields)

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.
Help on writing hacks will NOT be provided, and any such posts will be ignored.

Whereever it says mybitoptionsfield, you'll need to replace that with the actual fieldname that you are going to use.
  • The following step is to create bitfield xml for vBulletin.
    Create a file named bitfield_myproductid.xml, where myproductid is the id of your product, with the following content, in ./includes/xml/:
    Note: In the <bitfield> tag, name="" must contain the desired title of the option. You are going to use that title to access the options later on. The title must contain ALPHANUMBERIC characters only, and it should not contain spaces. The digit in between the opening and closing <bitfield> tags is the bit value. Each consecutive bit value must be 2 x (Previous Value). Sample valid sequence: 1, 2, 4, 8, 16, 32.
    PHP Code:
    <?xml version="1.0" encoding="ISO-8859-1"?>

    <bitfields product="myproductid">
        <bitfielddefs>
            <group name="misc">
                <group name="mybitoptionsfield">
                    <bitfield name="option1">1</bitfield>
                    <bitfield name="option2">2</bitfield>
                </group>
            </group>
        </bitfielddefs>
    </bitfields>
  • The following step is to define installation process of the bitfield in your product.
    Create a new product and add the following codes as install and uninstall, respectively:

    PHP Code:
    $db->hide_errors();

    $db->query_write("ALTER TABLE `" TABLE_PREFIX "user` ADD `mybitoptionsfield` INT( 10 ) UNSIGNED NOT NULL DEFAULT '0' AFTER `options`");

    require_once(
    DIR '/includes/class_bitfield_builder.php'); 
    $myobj =& vB_Bitfield_Builder::init();
    $myobj->save($db);
    build_forum_permissions(); 

    $db->show_errors(); 
    PHP Code:
    $db->hide_errors();

    $db->query_write("ALTER TABLE `" TABLE_PREFIX "user` DROP `mybitoptionsfield`");

    require_once(
    DIR '/includes/class_bitfield_builder.php'); 
    $myobj =& vB_Bitfield_Builder::init();
    $myobj->save($db);
    build_forum_permissions(); 

    $db->show_errors(); 
  • The following step is to have the new options fetched together with userinfo.
    Create a plugin @ fetch_userinfo with the following code:

    PHP Code:
    if (isset($vbulletin->bf_misc['mybitoptionsfield']))
    {
        foreach (
    $vbulletin->bf_misc['mybitoptionsfield'] AS $optionname => $optionval)
        {
            
    $user["$optionname"] = ($user['mybitoptionsfield'] & $optionval 0);
        }

  • The following step is to add new options to UserCP Option Page on Template Level.
    In template modifyoptions, add the following code whereever you want the options to appear:

    HTML Code:
    <fieldset class="fieldset">
    	<legend><label for="cb_option1">OPTION1_HEADING1</label></legend>
    	<table cellpadding="0" cellspacing="$stylevar[formspacer]" border="0" width="100%">
    	<tr>
    		<td>
    			OPTION1_DESCRIPTION1
    		</td>
    	</tr>
    	<tr>
    		<td><label for="cb_option1"><input type="checkbox" name="mybitoptionsfield[option1]" value="1" id="cb_option1" $checked[option1] />OPTION1_HEADING1</label><input type="hidden" name="set_options[option1]" value="1" /></td>
    	</tr>
    	</table>
    </fieldset>
    
    <fieldset class="fieldset">
    	<legend><label for="cb_option2">OPTION2_HEADING2</label></legend>
    	<table cellpadding="0" cellspacing="$stylevar[formspacer]" border="0" width="100%">
    	<tr>
    		<td>
    			OPTION2_DESCRIPTION2
    		</td>
    	</tr>
    	<tr>
    		<td><label for="cb_option2"><input type="checkbox" name="mybitoptionsfield[option2]" value="1" id="cb_option2" $checked[option2] />OPTION2_HEADING2</label><input type="hidden" name="set_options[option2]" value="2" /></td>
    	</tr>
    	</table>
    </fieldset>
  • The following step is to add new options to UserCP Option Page on Code Level.
    Create a plugin @ profile_updateoptions with the following code:

    PHP Code:
    if (isset($vbulletin->bf_misc['mybitoptionsfield']))
    {
        
    $vbulletin->input->clean_gpc('p''mybitoptionsfield'TYPE_ARRAY_BOOL);

        foreach (
    $vbulletin->bf_misc['mybitoptionsfield'] AS $key => $val)
        {
            if (isset(
    $vbulletin->GPC['mybitoptionsfield']["$key"]) OR isset($vbulletin->GPC['set_options']["$key"]))
            {
                
    $userdata->set_bitfield('mybitoptionsfield'$key$vbulletin->GPC['mybitoptionsfield']["$key"]);
            }
        }

  • The following step is to add new options to AdminCP User Manager.
    Create a plugin @ useradmin_edit_column1 with the following code:

    PHP Code:
    if (isset($vbulletin->bf_misc['mybitoptionsfield']))
    {
        
    print_table_break(''$INNERTABLEWIDTH);

        
    $mybitoptionsfield convert_bits_to_array($user['mybitoptionsfield'], $vbulletin->bf_misc['mybitoptionsfield']);
        
    $user array_merge($user$mybitoptionsfield);

        
    print_table_header('MYHEADING');
        
    print_yes_no_row('MYOPTION1''mybitoptionsfield[option1]'$user['option1']);
        
    print_yes_no_row('MYOPTION2''mybitoptionsfield[option2]'$user['option2']);

  • The following step is to have the new options saved when the button is clicked.
    Create a plugin @ useradmin_update_save with the following code:

    PHP Code:
    if (isset($vbulletin->bf_misc['mybitoptionsfield']))
    {
        
    $vbulletin->input->clean_gpc('p''mybitoptionsfield'TYPE_ARRAY_BOOL);
        
        foreach (
    $vbulletin->GPC['mybitoptionsfield'] AS $key => $val)
        {
            if (isset(
    $vbulletin->GPC['mybitoptionsfield']["$key"]))
            {
                
    $userdata->set_bitfield('mybitoptionsfield'$key$val);
            }
        }

  • The following step is to have the new bitfield added to the vBulletin_User_Dm.
    Create a plugin @ userdata_start with the following code:

    PHP Code:
    if (isset($this->registry->bf_misc['mybitoptionsfield']))
    {
        
    $this->bitfields["mybitoptionsfield"] =& $this->registry->bf_misc['mybitoptionsfield'];


Once done, rebuild your btifields.
Now, you should be able to access the new options simply by using $userinfo['mybitoptiontitle'].

>> EOD
Reply With Quote
  #12  
Old 05-28-2006, 04:13 PM
akanevsky akanevsky is offline
 
Join Date: Apr 2005
Posts: 3,972
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

You could start by referring to the following thread:
https://vborg.vbsupport.ru/showthread.php?t=99570

Also, if you have specified questions, post them in "Modifications Questions" forum.
Reply With Quote
  #13  
Old 05-28-2006, 04:14 PM
rogersnm rogersnm is offline
 
Join Date: Apr 2006
Location: Cyberspace, UK
Posts: 729
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

already have. lol ....
Reply With Quote
  #14  
Old 02-26-2008, 11:07 AM
Cloud-Warrior's Avatar
Cloud-Warrior Cloud-Warrior is offline
 
Join Date: Feb 2002
Location: Galway, Ireland
Posts: 100
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

A great tutorial!

I had two issues, that others might also run into:

* you might have to execute the querys from step 2 manually (as i followed all the steps here to create the product, and didn't acually "install" it via the import product button)

* If you want to create a plugin that changes the template (instead of manually inserting the code into the template modifyoptionslike in step 4) you have to do some extra things - explained in this thread
Reply With Quote
  #15  
Old 01-26-2010, 03:06 PM
SorentoUltimate's Avatar
SorentoUltimate SorentoUltimate is offline
 
Join Date: Jul 2009
Location: Moschato, Athens, Greece
Posts: 338
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

Very Good Article
Reply With Quote
  #16  
Old 01-29-2010, 01:05 AM
Neo_obs Neo_obs is offline
 
Join Date: Mar 2006
Location: Disneyland, CA
Posts: 363
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

I have a side question, I know it says no help will be provided. But I want to have an option like "Enable Override" and then my options would override the usergroup options. For instance, if enable override is on and voting is off, the user can't vote whether they have usergroup permissions or not. If the voting is on then they can vote whether they have usergroup permissions or not. This way I can allow certain users to vote even if their usergroup doesn't allow it, or deny them access to vote even if their usergroup allows it.
Reply With Quote
  #17  
Old 02-04-2013, 09:29 PM
Broseph Broseph is offline
 
Join Date: Jan 2013
Posts: 6
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default

Fantastic article. Any chance of doing something similar with vb4.x? Has it even changed much?
Reply With Quote
Reply


Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump


All times are GMT. The time now is 07:52 AM.


Powered by vBulletin® Version 3.8.12 by vBS
Copyright ©2000 - 2024, vBulletin Solutions Inc.
X vBulletin 3.8.12 by vBS Debug Information
  • Page Generation 0.04269 seconds
  • Memory Usage 2,310KB
  • Queries Executed 23 (?)
More Information
Template Usage:
  • (1)SHOWTHREAD
  • (1)ad_footer_end
  • (1)ad_footer_start
  • (1)ad_header_end
  • (1)ad_header_logo
  • (1)ad_navbar_below
  • (1)ad_showthread_beforeqr
  • (1)bbcode_html
  • (8)bbcode_php
  • (1)footer
  • (1)forumjump
  • (1)forumrules
  • (1)gobutton
  • (1)header
  • (1)headinclude
  • (1)modsystem_article
  • (1)navbar
  • (4)navbar_link
  • (120)option
  • (1)pagenav
  • (1)pagenav_curpage
  • (1)pagenav_pagelink
  • (7)post_thanks_box
  • (2)post_thanks_box_bit
  • (7)post_thanks_button
  • (1)post_thanks_javascript
  • (1)post_thanks_navbar_search
  • (1)post_thanks_postbit
  • (7)post_thanks_postbit_info
  • (6)postbit
  • (7)postbit_onlinestatus
  • (7)postbit_wrapper
  • (1)spacer_close
  • (1)spacer_open
  • (1)tagbit_wrapper 

Phrase Groups Available:
  • global
  • inlinemod
  • postbit
  • posting
  • reputationlevel
  • showthread
Included Files:
  • ./showthread.php
  • ./global.php
  • ./includes/init.php
  • ./includes/class_core.php
  • ./includes/config.php
  • ./includes/functions.php
  • ./includes/class_hook.php
  • ./includes/modsystem_functions.php
  • ./includes/functions_bigthree.php
  • ./includes/class_postbit.php
  • ./includes/class_bbcode.php
  • ./includes/functions_reputation.php
  • ./includes/functions_post_thanks.php 

Hooks Called:
  • init_startup
  • init_startup_session_setup_start
  • init_startup_session_setup_complete
  • cache_permissions
  • fetch_postinfo_query
  • fetch_postinfo
  • fetch_threadinfo_query
  • fetch_threadinfo
  • fetch_foruminfo
  • style_fetch
  • cache_templates
  • global_start
  • parse_templates
  • global_setup_complete
  • showthread_start
  • showthread_getinfo
  • forumjump
  • showthread_post_start
  • showthread_query_postids
  • showthread_query
  • bbcode_fetch_tags
  • bbcode_create
  • showthread_postbit_create
  • postbit_factory
  • postbit_display_start
  • post_thanks_function_post_thanks_off_start
  • post_thanks_function_post_thanks_off_end
  • post_thanks_function_fetch_thanks_start
  • fetch_musername
  • post_thanks_function_fetch_thanks_end
  • post_thanks_function_thanked_already_start
  • post_thanks_function_thanked_already_end
  • post_thanks_function_fetch_thanks_bit_start
  • post_thanks_function_show_thanks_date_start
  • post_thanks_function_show_thanks_date_end
  • post_thanks_function_fetch_thanks_bit_end
  • post_thanks_function_fetch_post_thanks_template_start
  • post_thanks_function_fetch_post_thanks_template_end
  • postbit_imicons
  • bbcode_parse_start
  • bbcode_parse_complete_precache
  • bbcode_parse_complete
  • postbit_display_complete
  • post_thanks_function_can_thank_this_post_start
  • pagenav_page
  • pagenav_complete
  • tag_fetchbit_complete
  • forumrules
  • navbits
  • navbits_complete
  • showthread_complete